PageHelper 方法使用了静态的 ThreadLocal 导致分页不安全问题

同事抛出一个生产PageHelper 分页错误

这个由于对PageHelper 分页静态的 ThreadLocal使用误区导致

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());

	例二：
	//request: url?pageNum=1&pageSize=10
	//支持 ServletRequest,Map,POJO 对象，需要配合 params 参数
	PageHelper.startPage(request);
	//紧跟着的第一个select方法会被分页
	List<User> list = userMapper.selectIf(1);
	
	//后面的不会被分页，除非再次调用PageHelper.startPage
	List<User> list2 = userMapper.selectIf(null);
	//list1
	assertEquals(2, list.get(0).getId());
	assertEquals(10, list.size());
	//分页时，实际返回的结果list类型是Page<E>，如果想取出分页信息，需要强制转换为Page<E>，
	//或者使用PageInfo类（下面的例子有介绍）
	assertEquals(182, ((Page) list).getTotal());
	//list2
	assertEquals(1, list2.get(0).getId());
	assertEquals(182, list2.size());

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

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>();
	}

这种写法就能保证安全。

如果你对此不放心，你可以手动清理 ThreadLocal 存储的分页参数，可以像下面这样使用：

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

这么写很不好看，而且没有必要。