Mybatis分頁外掛Mybatis-PageHelper
一、引入jar包
在 pom.xml 中新增如下依賴：
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.6</version>
</dependency>
二、與spring 整合
在 Spring 配置檔案中配置攔截器外掛
環境：專案使用Spring4.1.2.RELEASE + SpringMVC4.1.2.RELEASE + Mybatis3.3.0
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="mapperLocations"> <array> <!-- mapper的xml檔案地址 --> <value>classpath:mapper/*.xml</value> </array> </property> <!-- model 所的包 --> <property name="typeAliasesPackage" value="com.isea533.mybatis.model"/> <!-- 開始整合分頁外掛 --> <property name="plugins"> <array> <bean class="com.github.pagehelper.PageInterceptor"> <!-- 這裡的幾個配置引數主要演示如何使用，如果不理解，一定要去掉下面的配置 ，詳細配置，詳見下面詳解--> <property name="properties"> <value> helperDialect=mysql supportMethodsArguments=true </value> </property> </bean> </array> </property> </bean>
三、頁外掛引數介紹
分頁外掛提供了多個可選引數，這些引數使用時，按照上面兩種配置方式中的示例配置即可。
分頁外掛可選引數如下：
dialect：預設情況下會使用 PageHelper 方式進行分頁，如果想要實現自己的分頁邏輯，可以實現 Dialect(com.github.pagehelper.Dialect) 介面，然後配置該屬性為實現類的全限定名稱。
下面幾個引數都是針對預設 dialect 情況下的引數。使用自定義 dialect 實現時，下面的引數沒有任何作用。
helperDialect：分頁外掛會自動檢測當前的資料庫連結，自動選擇合適的分頁方式。 你可以配置helperDialect屬性來指定分頁外掛使用哪種方言。配置時，可以使用下面的縮寫值：
oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
特別注意：使用 SqlServer2012 資料庫時，需要手動指定為 sqlserver2012，否則會使用 SqlServer2005 的方式進行分頁。
你也可以實現 AbstractHelperDialect，然後配置該屬性為實現類的全限定名稱即可使用自定義的實現方法。
offsetAsPageNum：預設值為 false，該引數對使用 RowBounds 作為分頁引數時有效。 當該引數設定為 true 時，會將 RowBounds 中的 offset 引數當成 pageNum 使用，可以用頁碼和頁面大小兩個引數進行分頁。
rowBoundsWithCount：預設值為false，該引數對使用 RowBounds 作為分頁引數時有效。 當該引數設定為true時，使用 RowBounds 分頁會進行 count 查詢。
pageSizeZero：預設值為 false，當該引數設定為 true 時，如果 pageSize=0 或者 RowBounds.limit = 0 就會查詢出全部的結果（相當於沒有執行分頁查詢，但是返回結果仍然是 Page 型別）。
reasonable：分頁合理化引數，預設值為false。當該引數設定為 true 時，pageNum<=0 時會查詢第一頁， pageNum>pages（超過總數時），會查詢最後一頁。預設false 時，直接根據引數進行查詢。
params：為了支援startPage(Object params)方法，增加了該引數來配置引數對映，用於從物件中根據屬性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置對映的用預設值， 預設值為pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
supportMethodsArguments：支援通過 Mapper 介面引數來傳遞分頁引數，預設值false，分頁外掛會從查詢方法的引數值中，自動根據上面 params 配置的欄位中取值，查詢到合適的值時就會自動分頁。 使用方法可以參考測試程式碼中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest。
autoRuntimeDialect：預設值為 false。設定為 true 時，允許在執行時根據多資料來源自動識別對應方言的分頁 （不支援自動選擇sqlserver2012，只能使用sqlserver），用法和注意事項參考下面的場景五。
closeConn：預設值為 true。當使用執行時動態資料來源或沒有設定 helperDialect 屬性自動獲取資料庫型別時，會自動獲取一個數據庫連線， 通過該屬性來設定是否關閉獲取的這個連線，預設true關閉，設定為 false 後，不會關閉獲取的連線，這個引數的設定要根據自己選擇的資料來源來決定。
aggregateFunctions(5.1.5+)：預設為所有常見資料庫的聚合函式，允許手動新增聚合函式（影響行數），所有以聚合函式開頭的函式，在進行 count 轉換時，會套一層。其他函式和列會被替換為 count(0)，其中count列可以自己配置。
重要提示：
當 offsetAsPageNum=false 的時候，由於 PageNum 問題，RowBounds查詢的時候 reasonable 會強制為 false。使用 PageHelper.startPage 方法不受影響。
四、使用場景
場景一
如果你仍然在用類似ibatis式的名稱空間呼叫方式，你也許會用到rowBoundsWithCount， 分頁外掛對RowBounds支援和 MyBatis 預設的方式是一致，預設情況下不會進行 count 查詢，如果你想在分頁查詢時進行 count 查詢， 以及使用更強大的 PageInfo 類，你需要設定該引數為 true。
注： PageRowBounds 想要查詢總數也需要配置該屬性為 true。
場景二
如果你仍然在用類似ibatis式的名稱空間呼叫方式，你覺得 RowBounds 中的兩個引數 offset,limit 不如 pageNum,pageSize 容易理解， 你可以使用 offsetAsPageNum 引數，將該引數設定為 true 後，offset會當成 pageNum 使用，limit 和 pageSize 含義相同。
場景三
如果覺得某個地方使用分頁後，你仍然想通過控制引數查詢全部的結果，你可以配置 pageSizeZero 為 true， 配置後，當 pageSize=0 或者 RowBounds.limit = 0 就會查詢出全部的結果。
場景四
如果你分頁外掛使用於類似分頁檢視列表式的資料，如新聞列表，軟體列表， 你希望使用者輸入的頁數不在合法範圍（第一頁到最後一頁之外）時能夠正確的響應到正確的結果頁面， 那麼你可以配置 reasonable 為 true，這時如果 pageNum<=0 會查詢第一頁，如果 pageNum>總頁數 會查詢最後一頁。
場景五
如果你在 Spring 中配置了動態資料來源，並且連線不同型別的資料庫，這時你可以配置 autoRuntimeDialect 為 true，這樣在使用不同資料來源時，會使用匹配的分頁進行查詢。 這種情況下，你還需要特別注意 closeConn 引數，由於獲取資料來源型別會獲取一個數據庫連線，所以需要通過這個引數來控制獲取連線後，是否關閉該連線。 預設為 true，有些資料庫連線關閉後就沒法進行後續的資料庫操作。而有些資料庫連線不關閉就會很快由於連線數用完而導致資料庫無響應。所以在使用該功能時，特別需要注意你使用的資料來源是否需要關閉資料庫連線。
當不使用動態資料來源而只是自動獲取 helperDialect 時，資料庫連線只會獲取一次，所以不需要擔心佔用的這一個連線是否會導致資料庫出錯，但是最好也根據資料來源的特性選擇是否關閉連線。
五、程式碼使用demo
分頁外掛支援以下幾種呼叫方式：
**//第一種，RowBounds方式的呼叫**
List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(0, 10));
**//第二種，Mapper介面方式的呼叫，推薦這種使用方式。**
PageHelper.startPage(1, 10);
List<Country> list = countryMapper.selectIf(1);
**//第三種，Mapper介面方式的呼叫，推薦這種使用方式。**
PageHelper.offsetPage(1, 10);
List<Country> list = countryMapper.selectIf(1);
**//第四種，引數方法呼叫**
//存在以下 Mapper 介面方法，你不需要在 xml 處理後兩個引數
//配置檔案中需要增加配置引數
public interface CountryMapper {
List<Country> selectByPageNumSize(
@Param("user") User user,
@Param("pageNum") int pageNum,
@Param("pageSize") int pageSize);
}
//配置supportMethodsArguments=true
//在程式碼中直接呼叫：
List<Country> list = countryMapper.selectByPageNumSize(user, 1, 10);
**//第五種，引數物件**
//如果 pageNum 和 pageSize 存在於 User 物件中，只要引數有值，也會被分頁
//有如下 User 物件
public class User {
//其他fields
//下面兩個引數名和 params 配置的名字一致
private Integer pageNum;
private Integer pageSize;
}
//存在以下 Mapper 介面方法，你不需要在 xml 處理後兩個引數
public interface CountryMapper {
List<Country> selectByPageNumSize(User user);
}
//當 user 中的 pageNum!= null && pageSize!= null 時，會自動分頁
List<Country> list = countryMapper.selectByPageNumSize(user);
**//第六種，ISelect 介面方式**
//jdk6,7用法，建立介面
Page<Country> page = PageHelper.startPage(1, 10).doSelectPage(new ISelect() {
@Override
public void doSelect() {
countryMapper.selectGroupBy();
}
});
//jdk8 lambda用法
//通過當前執行緒儲存分頁資料實現
Page<Country> page = PageHelper.startPage(1, 10).doSelectPage(()-> countryMapper.selectGroupBy());
//也可以直接返回PageInfo，注意doSelectPageInfo方法和doSelectPage
pageInfo = PageHelper.startPage(1, 10).doSelectPageInfo(new ISelect() {
@Override
public void doSelect() {
countryMapper.selectGroupBy();
}
});
//對應的lambda用法
//通過當前執行緒儲存分頁資料實現
pageInfo = PageHelper.startPage(1, 10).doSelectPageInfo(() -> countryMapper.selectGroupBy());
//count查詢，返回一個查詢語句的count數
//通過當前執行緒儲存分頁資料實現
long total = PageHelper.count(new ISelect() {
@Override
public void doSelect() {
countryMapper.selectLike(country);
}
});
//lambda
total = PageHelper.count(()->countryMapper.selectLike(country));
七、整合中遇到的問題
問題：按照官方文件對接做了相應的配置和引入了相應的jar ，但是無法實現分頁，debug也無法進入PageInterceptor攔截器中的相應轉換sql的方法
問題分析：
A、最初懷疑是配置問題，核對了配置和官方配置無差異
B、還以是外掛與spring版本不相容，換了外掛的版本依然無法分頁
C、debug PageInterceptor攔截器，無法進入相應的sql轉換方法
解決方案：通過公司高手debug 相應的 SqlSessionFactory 類，才發現，我配置了多個 SqlSessionFactory ，並且我sql的mapper方法，沒有走到，配置PageInterceptor攔截器的SqlSessionFactory，導致無法分頁。 最終將專案中的多個SqlSessionFactory 合併為一個帶有 PageInterceptor攔截器的 SqlSessionFactory問題得以解決。
版權宣告：部分內容引用原外掛開發作者，github地址：https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md