SSM集成PageHelper分頁插件

本文部分內容摘選自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` 兩個屬性同時存在才會觸發分頁操作,在這個前提下,其他的分頁參數才會生效。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,119評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,382評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,038評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,853評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,616評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,112評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,192評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,355評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,869評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,727評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,928評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,467評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,165評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,570評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,813評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,585評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,892評論 2 372

推薦閱讀更多精彩內容

  • 在Mybatis配置xml中配置攔截器插件: 這里的com.github.pagehelper.PageHelpe...
    bboymonk閱讀 3,478評論 6 2
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,781評論 18 139
  • 1. Java基礎部分 基礎部分的順序:基本語法,類相關的語法,內部類的語法,繼承相關的語法,異常的語法,線程的語...
    子非魚_t_閱讀 31,711評論 18 399
  • 在使用suds連接webservice時候,遇到了找不到type的錯誤該錯誤一般類型為TypeNotFound:(...
    battle_閱讀 3,212評論 0 0
  • 日子就這樣多好,沒有大喜大悲,沒有轟轟烈烈,沒有海誓山盟,你對我的關切我都記在心上,我對你的坦率你都看在眼里...
    嘆息聲閱讀 580評論 1 1