文章目录
- PageHelper介绍
- PageHelper使用
- 1.集成
- 1. 引入 Jar 包
- 2.使用 Maven
- 2.配置
- 1.在 MyBatis中使用 配置 xml 中配置拦截器插件
- 2.在 Spring中使用 配置文件中配置拦截器插件
- 3.分页插件参数介绍
- 4.基本使用
- 1. RowBounds方式的调用(了解)
- 2. PageHelper.startPage 静态方法调用(重点)
- pagehelper实际开发中使用
- 1.pagehelper使用图解
- 2.实际开发中使用
- 1.导入pagehelper坐标
- 2.在SqlSessionFactoryBean中配置pagehelper插件
- 3.service层代码
- 4.web层代码
- 5.页面展示数据代码
- 6.页面页码代码
PageHelper介绍
PageHelper是国内非常优秀的一款开源的mybatis分页插件,它支持基本主流与常用的数据库,例如mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。
PageHelper使用
1.集成
引入分页插件有下面2种方式,推荐使用 Maven 方式。
1. 引入 Jar 包
2.使用 Maven
在 pom.xml 中添加如下依赖:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>最新版本</version>
</dependency>
2.配置
特别注意,新版拦截器是 com.github.pagehelper.PageInterceptor 。 com.github.pagehelper.PageHelper 现在是一个特殊的 dialect 实现类,是分页插件的默认实现类,提供了和以前相同的用法。
1.在 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.在 Spring中使用 配置文件中配置拦截器插件
使用 spring 的属性配置方式,可以使用 plugins 属性像下面这样配置:
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注意其他配置 -->
<property name="plugins">
<array>
<bean class="com.github.pagehelper.PageInterceptor">
<property name="properties">
<!--使用下面的方式配置参数,一行配置一个 -->
<value>
params=value1
</value>
</property>
</bean>
</array>
</property>
</bean>
3.分页插件参数介绍
- helperDialect :分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。 你可以配置 helperDialect 属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver201 2 , derby。
特别注意:使用 SqlServer2012 数据库时,需要手动指定为 sqlserver2012 ,否则会使用 SqlServer2005 的方式进行分页。
你也可以实现 AbstractHelperDialect ,然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。 - offsetAsPageNum :默认值为 false ,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为true 时,会将 RowBounds 中的 offset 参数当成 pageNum 使用,可以用页码和页面大小两个参数进行分页。
- rowBoundsWithCount :默认值为 false ,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true 时,使用 RowBounds 分页会进行 count 查询。
- pageSizeZero :默认值为 false ,当该参数设置为 true 时,如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是 Page 类型)。
- reasonable :分页合理化参数,默认值为 false 。当该参数设置为 true 时, pageNum<=0 时会查询第一页, pageNum>pages (超过总数时),会查询最后一页。默认 false 时,直接根据参数进行查询。
- params :为了支持 startPage(Object params) 方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ,不配置映射的用默认值, 默认值为
pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。 - supportMethodsArguments :支持通过 Mapper 接口参数来传递分页参数,默认值 false ,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页。 使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest 。
- autoRuntimeDialect :默认值为 false 。设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页 (不支持自动选择 sqlserver2012 ,只能使用 sqlserver ),用法和注意事项参考下面的场景五。
- closeConn :默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认 true 关闭,设置为false 后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定。
4.基本使用
PageHelper的基本使用有6种,可以查看文档,最常用的有两种。
1. RowBounds方式的调用(了解)
List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));
使用这种调用方式时,你可以使用RowBounds参数进行分页,这种方式侵入性最小,我们可以看到,通过RowBounds方式调用只是使用了这个参数,并没有增加其他任何内容。
分页插件检测到使用了RowBounds参数时,就会对该查询进行物理分页。
关于这种方式的调用,有两个特殊的参数是针对 RowBounds 的,你可以参看上面的分页插件参数介绍。
注:不只有命名空间方式可以用RowBounds,使用接口的时候也可以增加RowBounds参数,例如:
//这种情况下也会进行物理分页查询
List<Country> selectAll(RowBounds rowBounds);
注意: 由于默认情况下的 RowBounds 无法获取查询总数,分页插件提供了一个继承自 RowBounds 的 PageRowBounds ,这个对象中增加了 total 属性,执行分页查询后,可以从该属性得到查询总数。
2. PageHelper.startPage 静态方法调用(重点)
这种方式是要掌握的 在你需要进行分页的 MyBatis 查询方法前调用PageHelper.startPage 静态方法即可,紧跟在这个方法后的第一MyBatis 查询方法会被进行分页。
//获取第1页,10条内容,默认查询总数count
PageHelper.startPage(1, 10);
//紧跟着的第一个select方法会被分页
List<Country> list = countryMapper.selectIf(1);
pagehelper实际开发中使用
1.pagehelper使用图解
2.实际开发中使用
1.导入pagehelper坐标
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.2</version>
</dependency>
2.在SqlSessionFactoryBean中配置pagehelper插件
<!--把 SqlSessionFactory 交给 spring 管理-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!--配置数据源-->
<property name="dataSource" ref="dataSource"></property>
<!-- 配置pagehelper插件-->
<property name="plugins">
<array>
<bean class="com.github.pagehelper.PageInterceptor">
<property name="properties">
<props>
<!--配置对哪种数据库进行分页-->
<prop key="helperDialect">oracle</prop>
<!--分页合理化参数,默认值为 false 。当该参数设置为 true 时, pageNum<=0 时会查询第一页,
pageNum>pages (超过总数时),会查询最后一页。默认 false 时,直接根据参数进行查询。-->
<prop key="reasonable">true</prop>
</props>
</property>
</bean>
</array>
</property>
</bean>
3.service层代码
/**
* 查询所有订单
* @param page 当前页
* @param size 当前页显示的条数
* @return
*/
public List<Orders> findAll(int page,int size) {
/**
* 注意:PageHelper.startPage(page, size)这段代码一定要写在去dao查询数据的前一行,
* 中间不能有任何代码,不然会有问题。
*/
PageHelper.startPage(page, size);
return ordersDao.findAll();
}
4.web层代码
页面分页请求:${pageContext.request.contextPath}/orders/findAll.do?page=1&size=5
/**
* 分页查询所有订单
* @param page 当前页
* @param size 当前页显示的条数
* @return
*/
@RequestMapping("/findAll.do")
public ModelAndView findAll(@RequestParam(name = "page", required = true, defaultValue = "1") int page,
@RequestParam(name = "size", required = true, defaultValue = "5") int size) {
ModelAndView mav = new ModelAndView();
List<Orders> ordersList = ordersService.findAll(page,size);
/**
* 创建PageInfo对象,并将查询到的数据ordersList作为构造参数传递到PageInfo对象中,
* 其实PageInfo对象,就是以前的PageBean对象,里面封装着页面所需要的信息,可以查看源码。
*/
PageInfo pageInfo = new PageInfo(ordersList);
mav.addObject("pageInfo",pageInfo);
mav.setViewName("orders-list");
return mav;
}
5.页面展示数据代码
<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>
6.页面页码代码
这里有一个问题,是在第一页,再点击上一页不会出现第0页吗?尾页也同理。
这个问题其实不用担心pagehelper插件帮忙解决了这个问题,就是在配置插件的时候。
<ul class="pagination">
<%--首页--%>
<li>
<a href="${pageContext.request.contextPath }/orders/findAll.do?page=1&size=5" aria-label="Previous">首页</a>
</li>
<%--上一页--%>
<li><a href="${pageContext.request.contextPath }/orders/findAll.do?page=${pageInfo.pageNum-1 }&size=5">上一页</a></li>
<%--页码--%>
<c:forEach begin="1" end="${pageInfo.pages}" var="pageNum">
<li><a href="${pageContext.request.contextPath }/orders/findAll.do?page=${pageNum }&size=5"> ${pageNum } </a></li>
</c:forEach>
<%--下一页--%>
<li><a href="${pageContext.request.contextPath }/orders/findAll.do?page=${pageInfo.pageNum+1 }&size=5">下一页</a></li>
<%--尾页--%>
<li>
<a href="${pageContext.request.contextPath }/orders/findAll.do?page=${pageInfo.pages }&size=5" aria-label="Next">尾页</a>
</li>
</ul>