mybatis的兩種分頁方式:RowBounds和PageHelper

1.

原理：攔截器。

使用方法：

RowBounds:在mapper.java中的方法中傳入RowBounds對象

//接口方法
public List<Honor> getHonorList(HashMap<String, Object> maps，RowBounds rowBounds);

//調用方法
RowBounds rowBounds = new RowBounds(offset, page.getPageSize()); // offset起始行 // limit是當前頁顯示多少條數據

RowBounds  rowBounds = new RowBounds(2, 2);
    List<Honor> honors = studentMapper.getHonorList(maps，rowBounds);

Mybatis使用RowBounds對象進行分頁，它是針對ResultSet結果集執行的內存分頁，而非物理分頁，可以在sql內直接書寫帶有物理分頁的參數來完成物理分頁功能，也可以使用分頁插件來完成物理分頁。

分頁插件的基本原理是使用Mybatis提供的插件接口，實現自定義插件，在插件的攔截方法內攔截待執行的sql，然后重寫sql，根據dialect方言，添加對應的物理分頁語句和物理分頁參數。

舉例：select * from student，攔截sql后重寫為：select t.* from （select * from student）t limit 0，10

2.Mybatis的插件 PageHelper 分頁查詢使用方法

https://blog.csdn.net/maoyuanming0806/article/details/77720754

Mybatis的一個插件，PageHelper，非常方便mybatis分頁查詢。國內牛人的一個開源項目，有興趣的可以去看源碼，都有中文注釋（ps：某些源碼一大堆英文，痛哭流涕！）

在github上倉庫地址為：Mybatis-PageHelper

它支持基本主流與常用的數據庫，這可以在它的文檔上看到。這里記錄一下使用的基本方法

 

0.查看文檔與使用准備
開發文檔有中文文檔也有英文文檔

 

PageHelper官方文檔

官方地址

https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

Maven依賴

 

<!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper -->
        <!--mybatis pagehelper 分頁  -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.8</version>
        </dependency>

配置攔截器插件

這個是配置在mybatis-config.xml文件中

    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!-- config params as the following -->
            <!--<!–分頁參數合理化  –>-->
            <property name="reasonable" value="true"/>
        </plugin>
    </plugins>

參數配置

分頁插件參數介紹

分頁插件提供了多個可選參數，這些參數使用時，按照上面兩種配置方式中的示例配置即可。

分頁插件可選參數如下：

• dialect：默認情況下會使用 PageHelper 方式進行分頁，如果想要實現自己的分頁邏輯，可以實現 Dialect(com.github.pagehelper.Dialect) 接口，然后配置該屬性為實現類的全限定名稱。

下面幾個參數都是針對默認 dialect 情況下的參數。使用自定義 dialect 實現時，下面的參數沒有任何作用。

1. helperDialect：分頁插件會自動檢測當前的數據庫鏈接，自動選擇合適的分頁方式。 你可以配置helperDialect屬性來指定分頁插件使用哪種方言。配置時，可以使用下面的縮寫值：
   oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
   特別注意：使用 SqlServer2012 數據庫時，需要手動指定為 sqlserver2012，否則會使用 SqlServer2005 的方式進行分頁。
   你也可以實現 AbstractHelperDialect，然后配置該屬性為實現類的全限定名稱即可使用自定義的實現方法。

2. offsetAsPageNum：默認值為 false，該參數對使用 RowBounds 作為分頁參數時有效。 當該參數設置為 true 時，會將 RowBounds 中的 offset 參數當成 pageNum 使用，可以用頁碼和頁面大小兩個參數進行分頁。

3. rowBoundsWithCount：默認值為false，該參數對使用 RowBounds 作為分頁參數時有效。 當該參數設置為true時，使用 RowBounds 分頁會進行 count 查詢。

4. pageSizeZero：默認值為 false，當該參數設置為 true 時，如果 pageSize=0 或者 RowBounds.limit = 0 就會查詢出全部的結果（相當於沒有執行分頁查詢，但是返回結果仍然是 Page 類型）。

5. reasonable：分頁合理化參數，默認值為false。當該參數設置為 true 時，pageNum<=0 時會查詢第一頁，pageNum>pages（超過總數時），會查詢最后一頁。默認false 時，直接根據參數進行查詢。

6. params：為了支持startPage(Object params)方法，增加了該參數來配置參數映射，用於從對象中根據屬性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默認值， 默認值為pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。

7. supportMethodsArguments：支持通過 Mapper 接口參數來傳遞分頁參數，默認值false，分頁插件會從查詢方法的參數值中，自動根據上面 params 配置的字段中取值，查找到合適的值時就會自動分頁。 使用方法可以參考測試代碼中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest。

8. autoRuntimeDialect：默認值為 false。設置為 true 時，允許在運行時根據多數據源自動識別對應方言的分頁 （不支持自動選擇sqlserver2012，只能使用sqlserver），用法和注意事項參考下面的場景五。

9. closeConn：默認值為 true。當使用運行時動態數據源或沒有設置 helperDialect 屬性自動獲取數據庫類型時，會自動獲取一個數據庫連接， 通過該屬性來設置是否關閉獲取的這個連接，默認true關閉，設置為 false 后，不會關閉獲取的連接，這個參數的設置要根據自己選擇的數據源來決定。

10. aggregateFunctions(5.1.5+)：默認為所有常見數據庫的聚合函數，允許手動添加聚合函數（影響行數），所有以聚合函數開頭的函數，在進行 count 轉換時，會套一層。其他函數和列會被替換為 count(0)，其中count列可以自己配置。

重要提示：

當 offsetAsPageNum=false 的時候，由於 PageNum 問題，RowBounds查詢的時候 reasonable 會強制為 false。使用 PageHelper.startPage 方法不受影響。

使用代碼

 //引入分頁查詢，使用PageHelper分頁功能
    //在查詢之前傳入當前頁，然后多少記錄
    PageHelper.offsetPage(2, 2);
 //startPage后緊跟的這個查詢就是分頁查詢    

    List<Honor> honors = studentMapper.getHonorList();

分頁插件支持以下幾種調用方式：

//第一種，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));