pagehelper mybatis的分頁插件

pagehelper 是mybatis的一款非常好用的分頁插件

支持主流的數據庫

mysql
oracle
sql server
DB2
SQlite
PG

pom

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

配置比較簡單

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>  
<!DOCTYPE configuration  
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
  "http://mybatis.org/dtd/mybatis-3-config.dtd">  
<configuration>
    <settings>  
            <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>
    <plugins>
        <!-- mybatis 分頁插件 -->
        <plugin interceptor="com.github.pagehelper.PageHelper">
            <!-- 數據庫方言 -->
                <property name="dialect" value="oracle"/>
                <!-- 該參數默認爲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>
</configuration>

以上配置做了三件事情：

• 開啓 mybaits 日誌 <setting name="logImpl" value="STDOUT_LOGGING" />
• 設置分頁攔截器 <plugin interceptor="com.github.pagehelper.PageHelper">
• 設置數據庫類型 <property name="dialect" value="oracle"/>

spring.xml

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatis/mybatis-config.xml"/>
    <property name="mapperLocations" value="classpath:com/alibaba/*/mapping/*.xml"/>
</bean>

後端執行分頁查詢

//開啓分頁攔截，僅針對本次操作
PageHelper.startPage(page, rows);
//直接查滿足條件的結果集，分頁由PageHelper控制
List<User> users = userService.selectUserList();
//查詢結果的包裝，可以從pageInfo對象取出分頁後的結果集和總條數
PageInfo<User> pageInfo = new PageInfo<User>(users);

實際上， PageHelper 在SQL執行之前進行了攔截，先查了滿足條件的結果集總條數，再執行了分頁查詢，執行了兩條SQL語句，mybaits 日誌開啓後可以在控制檯上看到。