天天看點

Mybatis基于MySql分頁插件PageHelper的使用

一、 Mybatis 架構的分頁插件 PageHelper 是目前我用過的最簡單的分頁插件了,該插件 目前支援 Oracle , Mysql , MariaDB , SQLite , Hsqldb , PostgreSQL 六種資料庫分頁。 他的使用非常簡單, 簡要步驟如下:

第一步:添加jar包到工程中

<dependency>
 <groupId>com.github.pagehelper</groupId>
 <artifactId>pagehelper</artifactId>
 <version>4.0.0</version>
</dependency>
           

第二步:在 SqlMapConfig.xml ,配置一個 plugin , 如下

<plugins>
    <!-- com.github.pagehelper為PageHelper類所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageHelper">
        <property name="dialect" value="mysql"/>
        <!-- 該參數預設為false -->
        <!-- 設定為true時,會将RowBounds第一個參數offset當成pageNum頁碼使用 -->
        <!-- 和startPage中的pageNum效果一樣-->
        <property name="offsetAsPageNum" value="true"/>
        <!-- 該參數預設為false -->
        <!-- 設定為true時,使用RowBounds分頁會進行count查詢 -->
        <property name="rowBoundsWithCount" value="true"/>
        <!-- 設定為true時,如果pageSize=0或者RowBounds.limit = 0就會查詢出全部的結果 -->
        <!-- (相當于沒有執行分頁查詢,但是傳回結果仍然是Page類型)-->
        <property name="pageSizeZero" value="true"/>
        <!-- 3.3.0版本可用 - 分頁參數合理化,預設false禁用 -->
        <!-- 啟用合理化時,如果pageNum<1會查詢第一頁,如果pageNum>pages會查詢最後一頁 -->
        <!-- 禁用合理化時,如果pageNum<1或pageNum>pages會傳回空資料 -->
        <property name="reasonable" value="false"/>
        <!-- 3.5.0版本可用 - 為了支援startPage(Object params)方法 -->
        <!-- 增加了一個`params`參數來配置參數映射,用于從Map或ServletRequest中取值 -->
        <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用預設值 -->
        <!-- 不了解該含義的前提下,不要随便複制該配置 -->
        <property name="params" value="pageNum=start;pageSize=limit;"/>
        <!-- always總是傳回PageInfo類型,check檢查傳回類型是否為PageInfo,none傳回Page -->
        <property name="returnPageInfo" value="check"/>
    </plugin>
</plugins>
           

第三步:在 sql 語句執行之前,添加一個 PageHelper.startPage(page,rows)

pageNo = pageNo == null?1:pageNo;
pageSize = pageSize == null?10:pageSize;
PageHelper.startPage(pageNo, pageSize);//關鍵步驟
List<OrderListDto> list =  orderListlDao.queryOrderList(map);
           

第四步: 取分頁結果 。建立一個 PageInfo 對象, 需要的參數 : 查詢結果傳回的 list 。從 PageInfo 中取出分頁結果

//用PageInfo對結果進行包裝
 PageInfo<OrderListDto> page = new PageInfo<OrderListDto>(list);
           

好了,就是這麼簡單