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>();
}
這麼寫很很差看，並且沒有必要。