Mybatis分页插件——PageHelper

最新推荐文章于 2024-08-28 10:22:32 发布

777_yL

最新推荐文章于 2024-08-28 10:22:32 发布

阅读量309

点赞数

分类专栏： DataBase 文章标签： mybatis java mysql

本文链接：https://blog.csdn.net/weixin_41931278/article/details/107377234

版权

DataBase 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

PageHelper

1.PageHelper介绍
2.PageHelper使用
4.PageHelper的使用
- 4.1 RowBounds方式的调用
- 4.2 PageHelper.startPage 静态方法调用（常用）
4.实例（分页查询订单详情）

1.PageHelper介绍

PageHelper是国内非常优秀的一款开源的mybatis分页插件，它支持基本主流与常用的数据库，例如mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。
本项目在 github 的项目地址：https://github.com/pagehelper/Mybatis-PageHelper

2.PageHelper使用

2.1集成

引入分页插件有两种方式。

2.1.1 引入jar包

To use PageHelper you just need to include the pagehelper-x.y.z.jarand jsqlparser-x.y.z.jar file in the classpath.

你可以从下面的地址中下载最新版本的 jar 包
- https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/
  http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/
由于使用了sql 解析工具，你还需要下载 jsqlparser.jar：
- http://repo1.maven.org/maven2/com/github/jsqlparser/jsqlparser/0.9.5/

2.1.2 使用Maven

在 pom.xml 中添加如下依赖：

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

2.2 配置pagehelper（Config PageHelper）

2.2.1 配置在mybatis配置文件中

特别注意，新版拦截器是 com.github.pagehelper.PageInterceptor com.github.pagehelper.PageHelper 现在是一个特殊的 dialect 实现类，是分页插件的默认实现类，提供了和以前相同的用法。

<!--
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.2.2 在Spring配置文件中配置拦截器插件

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <!-- 注意其他配置-->
  <property name="plugins">
    <array>
      <bean class="com.github.pagehelper.PageInterceptor">
        <property name="properties">
          <!-- 使用下面的配置，一行配置一个 -->
          <value>
            param1=value1
          </value>
        </property>
      </bean>
    </array>
  </property>
</bean>

3. 参数介绍

helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。 你可以配置 helperDialect属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值： oracle , mysql , mariadb , sqlite ,hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver201 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的使用

PageHelper的基本使用有6种，最常用的有两种。

4.1 RowBounds方式的调用

List<User> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));

使用这种调用方式时，你可以使用RowBounds参数进行分页，这种方式侵入性最小，我们可以看到，通过RowBounds方式调用只是使用了这个参数，并没有增加其他任何内容。

分页插件检测到使用了RowBounds参数时，就会对该查询进行物理分页。
关于这种方式的调用，有两个特殊的参数是针对 RowBounds 的，你可以参看上面的分页插件参数
注：不只有命名空间方式可以用RowBounds，使用接口的时候也可以增加RowBounds参数，例如：

List<User> selectAll(RowBounds rowBounds);

注意：由于默认情况下的 RowBounds 无法获取查询总数，分页插件提供了一个继承自 RowBounds 的 PageRowBounds，这个对象中增加了 total 属性，执行分页查询后，可以从该属性得到查询总数。

4.2 PageHelper.startPage 静态方法调用（常用）

除了 PageHelper.startPage 方法外，还提供了类似用法的 PageHelper.offsetPage 方法。

在你需要进行分页的 MyBatis 查询方法前调用 PageHelper.startPage 静态方法即可，紧跟在这个方法后的第一个MyBatis 查询方法会被进行分页。

//获取第1页，10条内容，默认查询总数count
PageHelper.startPage(1, 10);
//紧跟着的第一个select方法会被分页
List<User> list = userMapper.selectIf(1);
assertEquals(2, list.get(0).getId());
assertEquals(10, list.size());
//分页时，实际返回的结果list类型是Page<E>，如果想取出分页信息，需要强制转换为Page<E>
assertEquals(182, ((Page) list).getTotal());

使用PageInfo

//获取第1页，10条内容，默认查询总数count
PageHelper.startPage(1, 10);
List<User> list = userMapper.selectAll();
//用PageInfo对结果进行包装
PageInfo page = new PageInfo(list);
//测试PageInfo全部属性
//PageInfo包含了非常全面的分页属性
assertEquals(1, page.getPageNum());
assertEquals(10, page.getPageSize());
assertEquals(1, page.getStartRow());
assertEquals(10, page.getEndRow());
assertEquals(183, page.getTotal());
assertEquals(19, page.getPages());
assertEquals(1, page.getFirstPage());
assertEquals(8, page.getLastPage());
assertEquals(true, page.isFirstPage());
assertEquals(false, page.isLastPage());
assertEquals(false, page.isHasPreviousPage());
assertEquals(true, page.isHasNextPage());

4.实例（分页查询订单详情）

4.1 持久层

  /**
     * 查询所有订单
     * @return
     */
    @Select("select * from orders")
    @Results({
            @Result(id=true,property = "id",column = "id"),
            @Result(property = "orderNum",column = "orderNum"),
            @Result(property = "orderTime",column = "orderTime"),
            @Result(property = "orderStatus",column = "orderStatus"),
            @Result(property = " peopleCount",column = " peopleCount"),
            @Result(property = "payType",column = "payType"),
            @Result(property = "payType",column = "payType"),
            @Result(property = "orderDesc",column = "orderDesc"),
            @Result(property = "product",column = "productId" ,javaType = Product.class,
                    one=@One(select = "com.zua.dao.ProductDao.findById", fetchType= FetchType.LAZY))
    })
    public List<Order> findAll();

4.2 业务层

/**
     * 分页查询
     * @param page //页码数
     * @param size //每页的条数
     * @return
     */
    public List<Order> findAll(int page, int size) {
         PageHelper.startPage(page, size);
         return dao.findAll();
    }

4.3 控制层

  @RequestMapping("/findAllByPages")
    public ModelAndView findAllByPages(@RequestParam(name="page",required = true,defaultValue = "1") int page,@RequestParam(name = "size",required = true,defaultValue =
    "2") int size){
        ModelAndView mv = new ModelAndView();
        System.out.println(page+" "+size);
        List<Order> orders = service.findAll(page, size);
        for (Order order : orders) {
            System.out.println(order);
        }
        //PageInfo是一个分页bean，整合了分页的详细信息。
        PageInfo pageInfo = new PageInfo(orders);
        mv.addObject("pageInfo",pageInfo);
        mv.setViewName("orders-page-list");
        return mv;
    }

4.4 前台页面

<div class="box-tools pull-right">
  <ul class="pagination">
       <li><a href="${pageContext.request.contextPath}/orders/findAllByPages?page=1&size=${pageInfo.pageSize}" aria-label="Previous">首页</a></li>
       <li><a href="${pageContext.request.contextPath}/orders/findAllByPages?page=${pageInfo.pageNum-1}&size=${pageInfo.pageSize}">上一页</a></li>
       <c:forEach begin="1" end="${pageInfo.pages}" var="pageNum">
	   <li><a href="${pageContext.request.contextPath}/orders/findAllByPages?page=${pageNum}&size=${pageInfo.pageSize}">${pageNum}</a></li></c:forEach>
       <li><a href="${pageContext.request.contextPath}/orders/findAllByPages?page=${pageInfo.pageNum+1}&size=${pageInfo.pageSize}">下一页</a></li>
       <li><a href="${pageContext.request.contextPath}/orders/findAllByPages?page=${pageInfo.pages}&size=${pageInfo.pageSize}" aria-label="Next">尾页</a> </li>
   </ul>
</div>