Mybatis分頁插件PageHelper使用
阿新 • • 發佈:2018-10-18
request req fin agen always let 官方文檔 exceptio reason
在mybatis中我們需要實現分頁功能,如果我們連接的是mysql我們就要寫mysql的分頁sql,連接oracle就要寫oracle的sql語句,這是很不友好的,而我們針對各種不同的數據庫的分頁我們有一個插件PageHelper
這一定是最方便使用的分頁插件。分頁插件支持任何復雜的單表、多表分頁。 支持常見的 12 種數據庫。Oracle,MySql,MariaDB,SQLite,DB2, PostgreSQL,SqlServer 等
支持常見的RowBounds(PageRowBounds), PageHelper.startPage 方法調用, Mapper 接口參數調用
更多用法參照請官方文檔:https://pagehelper.github.io/docs/howtouse/
添加依賴
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>4.1.6</version> </dependency> <!--由於使用了sql 解析工具--> <dependency> <groupId>com.github.jsqlparser</groupId> <artifactId>jsqlparser</artifactId> <version>0.9.6</version> </dependency>
在mybatis-config.xml中配置插件攔截器
<!-- 插件配置 --> <plugins> <!-- com.github.pagehelper為PageHelper類所在包名 --> <plugin interceptor="com.github.pagehelper.PageHelper"> <!-- 4.0.0以後版本可以不設置該參數 --> <!-- <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="true"/> <!-- 3.5.0版本可用 - 為了支持startPage(Object params)方法 --> <!-- 增加了一個`params`參數來配置參數映射,用於從Map或ServletRequest中取值 --> <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默認值 --> <!-- 不理解該含義的前提下,不要隨便復制該配置 --> <property name="params" value="pageNum=start;pageSize=limit;"/> <!-- 支持通過Mapper接口參數來傳遞分頁參數 --> <property name="supportMethodsArguments" value="true"/> <!-- always總是返回PageInfo類型,check檢查返回類型是否為PageInfo,none返回Page --> <property name="returnPageInfo" value="check"/> </plugin> </plugins>
使用方式非常簡單,我們只需要在執行查詢直接插入PageHelper.startPage(當前頁,每頁多少數據)就可以完成分頁,必須在執行mapper.findAll()之前插入。
public static void main(String[] args) throws IOException { InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml"); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); EmployeeMapper mapper = sqlSessionFactory.openSession().getMapper(EmployeeMapper.class); //設置分頁參數 PageHelper.startPage(0, 5); List<Employee> lists= mapper.findAll(); //傳入結果集獲取分頁數據 PageInfo<Employee> info = new PageInfo<>(lists); System.out.println("總記錄數:" + info.getTotal()); System.out.println("當前頁數:" + info.getPageNum()); System.out.println("每頁數:" + info.getPageSize()); System.out.println("總頁數:" + info.getPages()); System.out.println("結果集:" + info.getList()); }
Mybatis分頁插件PageHelper使用