mybatis pagehelper使用

配置

maven配置

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

mybatis-config.xml配置

	<plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor"/>
    </plugins>

使用

代码使用方法

		PageHelper.startPage(page.getPageNumber(), page.getPageSize());
        List<Client> list = clientService.list();
        PageInfo<Client> pageInfo = new PageInfo<>(list);

在查询前调用PageHelper.startPage方法，查询后的结果其实已经封装好分页的信息，通过new PageInfo获得分页参数，这时候，这个list实际上是一个com.github.pagehelper.Page对象，已经包含了分页信息，也可以强转成Page

注意事项

什么时候会导致不安全的分页

PageHelper方法使用了静态的 ThreadLocal 参数，分页参数和线程是绑定的。

只要你可以保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为 PageHelper 在 finally 代码段中自动清除了 ThreadLocal 存储的对象。

如果代码在进入 Executor 前发生异常，就会导致线程不可用，这属于人为的 Bug（例如接口方法和 XML 中的不匹配，导致找不到 MappedStatement 时）， 这种情况由于线程不可用，也不会导致 ThreadLocal 参数被错误的使用。

但是如果你写出下面这样的代码，就是不安全的用法：

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

这种情况下由于 param1 存在 null 的情况，就会导致 PageHelper 生产了一个分页参数，但是没有被消费，这个参数就会一直保留在这个线程上。当这个线程再次被使用时，就可能导致不该分页的方法去消费这个分页参数，这就产生了莫名其妙的分页。

上面这个代码，应该写成下面这个样子：

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

这种写法就能保证安全。

参考：

• 官方说明