Spring Boot 2.x（十三）：你不知道的PageHelper

PageHelper

说起PageHelper，使用过Mybatis的朋友可能不是很陌生，作为一款国人开发的分页插件，它基本上满足了我们的日常需求。但是，我想去官方文档看看这个东西配合Spring Boot进行使用的时候，发现了这个：

所以花了一个晚上的时间，研究了一下合理的怎么玩这个。

快速入门

如果你想在一个Spring Boot项目中快速进行一次分页操作，只需要两步即可：

导入Maven

这里我导入的是官方最新的：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.5</version>
</dependency>
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.2.10</version>
</dependency>

使用

 // 只有紧跟在PageHelper.startPage方法后的第一个Mybatis的查询（Select）方法会被分页!!!!
 PageHelper.startPage(1, 10);
 return PageInfo.of(userService.findAll());

没错，只需要两句代码即可达到我们想要的分页效果

进阶玩法

如果，你仅仅是想简单的使用分页功能，那么这篇文章到这里对你而言来说就已经结束了，但是作为一个程序员，你会仅仅满足于初级的玩儿法吗？不！你不会！所以，接着往下看~

从文档中，我们可以看出，作者给我们提供了很多的参数供我们配置：

helperDialect，offsetAsPageNum，rowBoundsWithCount，pageSizeZero，reasonable，params，supportMethodsArguments，autoRuntimeDialect，closeConn等等，我们可以通过配置这些属性来获得更为强大的效果~

这里需要说明一点，网上的教程大部分是让我们在xml或者代码中配置，其实如果你使用的是springboot，干嘛要舍近求远呢，我们可以直接在Spring boot 的配置文件application.yml中进行配置：

pagehelper:
  # dialect: ①
  # 分页插件会自动检测当前的数据库链接，自动选择合适的分页方式（可以不设置）
  helper-dialect: mysql
  # 上面数据库设置后，下面的设置为true不会改变上面的结果（默认为true）
  auto-dialect: true
  page-size-zero: false # ②
  reasonable: true # ③
  # 默认值为 false，该参数对使用 RowBounds 作为分页参数时有效。（一般用不着）
  offset-as-page-num: false
  # 默认值为 false，RowBounds是否进行count查询（一般用不着）
  row-bounds-with-count: false
  #params: ④
  #support-methods-arguments: 和params配合使用，具体可以看下面的讲解
  # 默认值为 false。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页
  auto-runtime-dialect: false # ⑤
  # 与auto-runtime-dialect配合使用
  close-conn: true
  # 用于控制默认不带 count 查询的方法中，是否执行 count 查询，这里设置为true后，total会为-1
  default-count: false
  #dialect-alias: ⑥

①：默认情况下会使用 PageHelper 方式进行分页，如果想要实现自己的分页逻辑，可以实现 Dialect(com.github.pagehelper.Dialect) 接口，然后配置该属性为实现类的全限定名称。(这里不推荐这样玩，毕竟你用了别人的插件，干嘛还要多此一举呢？)

②：默认值为 false，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。

这里需要说一点，虽然返回了全部的结果，但是还是执行了count的动作，开发者曾在issue中表示后面的版本会修复这个问题



经我的测试，目前是还没有解决的