PageHelper的使用

Posted 2020-12-18 xiaoaiying

PageHelper是mybatis的一个分页插件

使用步骤

1.导入jar包（依赖）

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.1.2</version>
</dependency>

2.配置拦截器

2-1(mybatis单独使用)mybatis配置xml中配置拦截器插件

<!-- plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下:
    properties?, settings?,
    typeAliases?, typeHandlers?,
    objectFactory?,objectWrapperFactory?,
    plugins?,
    environments?, databaseIdProvider?, mappers?
-->
<plugins>    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageInterceptor"><!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->
        <property name="param1" value="value1"/>
    </plugin>
</plugins>

2-1(ssm即mybatis交spring管理)spring配置xml中配置

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  <!-- 注意其他配置 -->
   <property name="plugins">
      <array>
          <bean class="com.github.pagehelper.PageInterceptor">
              <property name="properties"> <!--使用下面的方式配置参数，一行配置一个 -->
                  <props>
   			<prop key="helperDialect">oracle</prop> <!--使用什么数据库需要对应配置 -->
   			<prop key="reasonable">true</prop>
   		  </props>
              </property>
          </bean>
      </array>
  </property>
</bean>

2-3参数说明

1. helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。 你可以配置 helperDialect 属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值： oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby 特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012 ，否则会使用 SqlServer2005 的 方式进行分页。 你也可以实现 AbstractHelperDialect ，然后配置该属性为实现类的全限定名称即可使用自定义的实现方 法。
2. offsetAsPageNum ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分 页。
3. rowBoundsWithCount ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置 为 true 时，使用 RowBounds 分页会进行 count 查询。
4. pageSizeZero ：默认值为 false ，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。
5. reasonable ：分页合理化参数，默认值为 false 。当该参数设置为 true 时， pageNum<=0 时会查询第一 页， pageNum>pages （超过总数时），会查询最后一页。默认 false 时，直接根据参数进行查询。
6. params ：为了支持 startPage(Object params) 方法，增加了该参数来配置参数映射，用于从对象中根据属 性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默认值， 默认 值为 pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero 。
7. supportMethodsArguments ：支持通过 Mapper 接口参数来传递分页参数，默认值 false ，分页插件会从查 询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。 使用方法 可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest 。
8. autoRuntimeDialect ：默认值为 false 。设置为 true 时，允许在运行时根据多数据源自动识别对应方言 的分页 （不支持自动选择 sqlserver2012 ，只能使用 sqlserver ），用法和注意事项参考下面的场景五。
9. closeConn ：默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类 型时，会自动获取一个数据库连接， 通过该属性来设置是否关闭获取的这个连接，默认 true 关闭，设置为 false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。

3.基本使用

真正使用时先通过PageHelper.startPage(page,size);//参数1==页码值，参数2:==每页显示条数设置 例如：

//查询所有订单
@Override
public List<Orders> findAll() throws Exception {
    PageHelper.startPage(1,5);//参数1==页码值，参数2:==每页显示条数 必须紧跟调用分页的代码之前
    return ordersDao.findAll();
}

然后获取pageInfo对象存request域中，在页面获取并使用该对象。

---

以下为一个完整例子：

1. maven项目pom.xml配置文件引入依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.1.2</version>
</dependency>

2. spring的xml配置中配置PageHelper插件

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource" />
    <!-- 传入PageHelper的插件 -->
    <property name="plugins">
        <array>
            <!-- 传入插件的对象 -->
            <bean class="com.github.pagehelper.PageInterceptor">
                <property name="properties">
                    <props>
                        <prop key="helperDialect">oracle</prop>
                        <prop key="reasonable">true</prop>
                    </props>
                </property>
            </bean>
        </array>
    </property>
</bean>

3. service实现类

//查询所有订单
@Override
public List<Orders> findAll(int page, int size) throws Exception {
    PageHelper.startPage(page,size);//参数1==页码值，参数2:==每页显示条数
    return ordersDao.findAll();
}

4. controller控制器方法

//查询所以订单--分页
@RequestMapping("/findAll.do")
public ModelAndView findAll(
        @RequestParam(name = "page",required = true,defaultValue = "1")int page,
        @RequestParam(name = "pageSize",required = true,defaultValue = "4")int size) throws Exception {
    ModelAndView mv = new ModelAndView();
    List<Orders> ordersList = ordersService.findAll(page,size);
    //pageinfo就是 一个分页bean
    PageInfo pageInfo = new PageInfo(ordersList);
    mv.addObject("pageInfo",pageInfo);
    mv.setViewName("orders-page-list");
    return mv;
}

5. jsp数据展示页面对于pageInfo对象的使用

----遍历数据
<!--数据列表-->
<table id="dataList" class="table table-bordered table-striped table-hover dataTable">
	<thead>
		<tr>
			<th class="" style="padding-right: 0px;"><input
				id="selall" type="checkbox" class="icheckbox_square-blue">
			</th>
			<th class="sorting_asc">ID</th>
			<th class="sorting_desc">订单编号</th>
			<th class="sorting_asc sorting_asc_disabled">产品名称</th>
			<th class="sorting_desc sorting_desc_disabled">金额</th>
			<th class="sorting">下单时间</th>
			<th class="text-center sorting">订单状态</th>
			<th class="text-center">操作</th>
		</tr>
	</thead>
	<tbody>
		<c:forEach items="${pageInfo.list}" var="orders">
			<tr>
				<td><input name="ids" type="checkbox"></td>
				<td>${orders.id }</td>
				<td>${orders.orderNum }</td>
				<td>${orders.product.productName }</td>
				<td>${orders.product.productPrice }</td>
				<td>${orders.orderTimeStr }</td>
				<td class="text-center">${orders.orderStatusStr }</td>
				<td class="text-center">
					<button type="button" class="btn bg-olive btn-xs">订单</button>
					<button type="button" class="btn bg-olive btn-xs" onclick="location.href=‘${pageContext.request.contextPath}/orders/findById.do?id=${orders.id}‘">详情</button>
					<button type="button" class="btn bg-olive btn-xs">编辑</button>
				</td>
			</tr>
		</c:forEach>
	</tbody>
</table>
<!--数据列表/-->

----分页操作
<div class="box-footer">
    <div class="pull-left">
        <div class="form-group form-inline">
            总共${pageInfo.pages}页，共${pageInfo.total} 条数据。 每页
            <select id="changePageSize" class="form-control" onchange="changePageSize()">
                <option>1</option>
                <option>2</option>
                <option>3</option>
                <option>4</option>
                <option>5</option>
            </select> 条
        </div>
    </div>
    <div class="box-tools pull-right">
        <ul class="pagination">
            <li>
                <a href="${pageContext.request.contextPath}/orders/findAll.do?page=1&pageSize=${pageInfo.pageSize}" aria-label="Previous">首页</a>
            </li>
            <li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum-1}&pageSize=${pageInfo.pageSize}">上一页</a></li>
            <%--遍历每一页--%>
            <c:forEach begin="1" end="${pageInfo.pages}" var="pageNum">
                <li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageNum}&pageSize=${pageInfo.pageSize}">${pageNum}</a></li>
            </c:forEach>
            <li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum+1}&pageSize=${pageInfo.pageSize}">下一页</a></li>
            <li>
                <a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pages}&pageSize=${pageInfo.pageSize}" aria-label="Next">尾页</a>
            </li>
        </ul>
    </div>
<div>

----每页显示几条数据的js方法
function changePageSize() {
      //获取下拉框的值
      var pageSize = $("#changePageSize").val();
      //向服务器发送请求，改变没页显示条数
      location.href = "${pageContext.request.contextPath}/orders/findAll.do?page=1&pageSize="+ pageSize;
}