Mybatis PageHelper 使用的注意事项

何时会致使不安全的分页？

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

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

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

可是若是你写出下面这样的代码，就是不安全的用法：

PageHelper.startPage(1, 10);
List<Country> list;
if(param1 != null){
    list = countryMapper.selectIf(param1);
} else {
    list = new ArrayList<Country>();
}
这种状况下因为 param1 存在 null 的状况，就会致使 PageHelper 生产了一个分页参数，可是没有被消费，这个参数就会一直保留在这个线程上。当这个线程再次被使用时，就可能致使不应分页的方法去消费这个分页参数，这就产生了莫名其妙的分页。

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

List<Country> list;
if(param1 != null){
    PageHelper.startPage(1, 10);
    list = countryMapper.selectIf(param1);
} else {
    list = new ArrayList<Country>();
}
这种写法就能保证安全。

若是你对此不放心，你能够手动清理 ThreadLocal 存储的分页参数，能够像下面这样使用：

List<Country> list;
if(param1 != null){
    PageHelper.startPage(1, 10);
    try{
        list = countryMapper.selectAll();
    } finally {
        PageHelper.clearPage();
    }
} else {
    list = new ArrayList<Country>();
}
这么写很很差看，并且没有必要。