2. mybatis分页插件使用

1.概述

      在做系统的过程中，分页查询是我们经常遇到的一个场景，我们可以借助mybatis分页插件方便的实现分页功能，本文分享怎样使用mybatis分页插件。

2.mybatis分页插件使用

      mybatis分页插件使用包括两个步骤

1. 引入mysql依赖和分页插件依赖。
2. 使用分页插件编写代码。
   下面分别详细说一下

2.1 引入mysql依赖和分页插件依赖

      pom依赖代码如下所示:

<!--Mysql Start-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.2</version>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.49</version>
</dependency>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.6</version>
</dependency>
<!--Mysql End-->

<!--mybatis分页插件  START-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.1</version>
</dependency>
<!--mybatis分页插件  END-->

2.2 使用分页插件编写代码

      分页插件的使用有好几种方式，这里我分享比较简单直观的一种，使用PageHelper的方式，代码如下所示：

public PageInfo<App> appPageInfo(int pageNum, int pageSize) {
    try {
        if(pageNum < 0) {
            pageNum = 1;
        }
        if(pageSize < 0) {
            pageSize = 10;
        }
        //取第pageNum页的pageSize条内容，默认查询总数count
        PageHelper.startPage(pageNum, pageSize);
        //紧跟着PageHelper的第一个select方法会被分页
        List<App> apiList =  appMapper.selectAllApp();
        //用PageInfo对结果进行包装
        PageInfo<App> info = new PageInfo(apiList);
        return info;
    } catch (Exception e) {
        return null;
    }
}

      PageInfo对查询结果进行了封装，PageInfo里有很多有用的信息，例如：

info.getPageNum();
info.getPageSize();
info.getStartRow();
info.getEndRow();
info.getTotal();
info.getPages();
info.getNavigateFirstPage();
info.getNavigateLastPage();
info.isIsFirstPage();
info.isIsLastPage();
info.isHasNextPage();
info.isHasPreviousPage();
info.getList();

2.2.1 PageHelper分页注意事项

      PageHelper虽然简单直观，但是它可能导致不安全的分页，主要原因是PageHelper 方法使用了静态的 ThreadLocal 参数，分页参数和线程是绑定的。需要保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法，只要可以保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为 PageHelper 在 finally 代码段中自动清除了 ThreadLocal 存储的对象。
      这样的代码就是不安全的用法。

PageHelper.startPage(1, 10);
List<User> list;
if(param1 != null){
    list = userMapper.selectIf(param1);
} else {
    list = new ArrayList<User>();
}

      需要修改成这样

List<User> list;
if(param1 != null){
    PageHelper.startPage(1, 10);
    list = userMapper.selectIf(param1);
} else {
    list = new ArrayList<User>();
}

      也可以采用手动清除的方式，虽然很不好看

List<User> list;
if(param1 != null){
    PageHelper.startPage(1, 10);
    try{
        list = userMapper.selectAll();
    } finally {
        PageHelper.clearPage();
    }
} else {
    list = new ArrayList<User>();
}

      更详细的使用方式请参考官方文档：Mybatis Pagehelper
      也可以参考 Java8函数式编程介绍及分页查询实战 文章的方式，写出更优雅的分页代码。

总结

      本文分享了mybatis分页插件的使用方式及注意事项。