本文部分內容摘選自PageHelper GitHub,可按照文中步驟進行插件快速集成
一、Maven配置
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.0.0</version>
</dependency> ```
#### 二、 SqlSessionFactoryBean配置
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="readWriteDataSource"/>
<property name="typeAliasesPackage" value="com.tg..entity"/>
<property name="mapperLocations" value="classpath:mybatis//Mapper.xml"/>
<property name="plugins">
<array>
<bean class="com.github.pagehelper.PageInterceptor">
<property name="properties">
<value>
helperDialect=mysql
reasonable=true
supportMethodsArguments=true
</value>
</property>
</bean>
</array>
</property>
</bean>
#### 三、分頁插件參數介紹
分頁插件提供了多個可選參數,這些參數使用時,按照上面兩種配置方式中的示例配置即可。
分頁插件可選參數如下:
- *dialect*:默認情況下會使用 `PageHelper`方式進行分頁,如果想要實現自己的分頁邏輯,可以實現 `Dialect(com.github.pagehelper.Dialect)` 接口,然后配置該屬性為實現類的全限定名稱。
下面幾個參數都是針對默認 `dialect` 情況下的參數。使用自定義 `dialect` 實現時,下面的參數沒有任何作用。
- *helperDialect*:分頁插件會自動檢測當前的數據庫鏈接,自動選擇合適的分頁方式。 你可以配置`helperDialect`屬性來指定分頁插件使用哪種方言。配置時,可以使用下面的縮寫值:
`oracle`,`mysql`,`mariadb`,`sqlite`,`hsqldb`,`postgresql`,`db2`,`sqlserver`,`informix`,`h2`,`sqlserver2012`,`derby`
**特別注意**:使用 `SqlServer2012` 數據庫時,需要手動指定為 `sqlserver2012`,否則會使用 `SqlServer2005` 的方式進行分頁。
你也可以實現 `AbstractHelperDialect`,然后配置該屬性為實現類的全限定名稱即可使用自定義的實現方法。
- *offsetAsPageNum*:默認值為 `false`,該參數對使用 `RowBounds` 作為分頁參數時有效。 當該參數設置為 `true` 時,會將 `RowBounds` 中的 `offset` 參數當成 `pageNum` 使用,可以用頁碼和頁面大小兩個參數進行分頁。
- *rowBoundsWithCount*:默認值為`false`,該參數對使用 `RowBounds` 作為分頁參數時有效。 當該參數設置為`true`時,使用 `RowBounds` 分頁會進行 `count`查詢。
- *pageSizeZero*:默認值為 `false`,當該參數設置為 `true` 時,如果 `pageSize=0` 或者 `RowBounds.limit = 0` 就會查詢出全部的結果(相當于沒有執行分頁查詢,但是返回結果仍然是 `Page` 類型)。
- *reasonable*:分頁合理化參數,默認值為`false`。當該參數設置為 `true` 時,`pageNum<=0` 時會查詢第一頁, `pageNum>pages`(超過總數時),會查詢最后一頁。默認false 時,直接根據參數進行查詢。
- *params*:為了支持`startPage(Object params)`方法,增加了該參數來配置參數映射,用于從對象中根據屬性名取值, 可以配置 `pageNum`,`pageSize`,`count`,`pageSizeZero`,`reasonable`,不配置映射的用默認值, 默認值為`pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero`。
- *supportMethodsArguments*:支持通過 `Mapper` 接口參數來傳遞分頁參數,默認值`false`,分頁插件會從查詢方法的參數值中,自動根據上面 `params` 配置的字段中取值,查找到合適的值時就會自動分頁。 使用方法可以參考測試代碼中的 `com.github.pagehelper.test.basic` 包下的 `ArgumentsMapTest` 和 `ArgumentsObjTest`。
- *autoRuntimeDialect*:默認值為 *`false`*。設置為 *`true`* 時,允許在運行時根據多數據源自動識別對應方言的分頁 (不支持自動選擇`sqlserver2012`,只能使用`sqlserver`),用法和注意事項參考下面的場景五。
- *closeConn*:默認值為 `true`。當使用運行時動態數據源或沒有設置 `helperDialect` 屬性自動獲取數據庫類型時,會自動獲取一個數據庫連接, 通過該屬性來設置是否關閉獲取的這個連接,默認`true`關閉,設置為 `false` 后,不會關閉獲取的連接,這個參數的設置要根據自己選擇的數據源來決定。
**重要提示**:
當 `offsetAsPageNum=false` 的時候,由于 `PageNum` 問題,`RowBounds`查詢的時候 `reasonable` 會強制為 *`false`*。使用 `PageHelper.startPage` 方法不受影響。
#### 四、項目集成
經過實際項目中的測試,總結出如下兩種使用方式:
> - 用`PageHelper.startPage(pageNum, pageSize);`方式進行分頁設置,代碼侵入小,只需要在調用`initPage()`方法中加入此代碼即可;
> - 使用參數傳遞的方式,此方法不支持`@Param("xxx")`注解,改造起來相對費時。
**代碼參考**
List<User> userList = userService.query(userParams);
PageInfo<PaymentRequest> result = new PageInfo<>(userList );
System.out.println(result.getTotal());
System.out.println(result.getPageNum());
System.out.println(result.getList().size());
**TODO:集成后可將代碼中所有`count()`方法全部去掉**
**注意**:`pageNum` 和 `pageSize` 兩個屬性同時存在才會觸發分頁操作,在這個前提下,其他的分頁參數才會生效。