Mybatis分頁外掛PageHelper使用

資料庫 MyBatis · 發表 2018-10-17 22:49:00

摘要： MyBatis分頁外掛 Author:SimpleWu 在mybatis中我們需要實現分頁功能，如果我們連線的是mysql我們就要寫mysql的分頁sql，連線oracle就要寫oracle的sql語句，這是很不友好的，而我們針對各種不同的資料庫的分頁我們有一個外掛PageHelpe...

MyBatis分頁外掛

Author:SimpleWu

在mybatis中我們需要實現分頁功能，如果我們連線的是mysql我們就要寫mysql的分頁sql，連線oracle就要寫oracle的sql語句，這是很不友好的，而我們針對各種不同的資料庫的分頁我們有一個外掛PageHelper

PageHelper

這一定是最方便使用的分頁外掛。分頁外掛支援任何複雜的單表、多表分頁。支援常見的 12 種資料庫。Oracle,MySql,MariaDB,SQLite,DB2, PostgreSQL,SqlServer 等

支援常見的RowBounds(PageRowBounds)， PageHelper.startPage 方法呼叫， Mapper 介面引數呼叫

更多用法參照請官方文件：ofollow,noindex" target="_blank">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使用