當(dāng)前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

MyBatis学习总结（17）——Mybatis分页插件PageHelper

發(fā)布時間：2023/12/4 编程问答 48 豆豆

生活随笔收集整理的這篇文章主要介紹了 MyBatis学习总结（17）——Mybatis分页插件PageHelper 小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

2019獨角獸企業(yè)重金招聘Python工程師標(biāo)準(zhǔn)>>>

如果你也在用Mybatis，建議嘗試該分頁插件，這一定是最方便使用的分頁插件。

分頁插件支持任何復(fù)雜的單表、多表分頁，部分特殊情況請看重要提示。

想要使用分頁插件？請看如何使用分頁插件。

物理分頁

該插件目前支持以下數(shù)據(jù)庫的物理分頁:

Oracle

Mysql

MariaDB

SQLite

Hsqldb

PostgreSQL

DB2

SqlServer(2005,2008)

Informix

SqlServer2012

配置dialect屬性時，可以使用小寫形式：

oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012

在4.0.0版本以后，dialect參數(shù)可以不配置，系統(tǒng)能自動識別這里提到的所有數(shù)據(jù)庫。

對于不支持的數(shù)據(jù)庫，可以實現(xiàn)com.github.pagehelper.parser.Parser接口，然后配置到dialect參數(shù)中(4.0.2版本增加)。

特別注意：使用SqlServer2012數(shù)據(jù)庫時，需要手動指定sqlserver2012，否則會使用2005的方式進(jìn)行分頁。

MyBatis工具網(wǎng)站:http://mybatis.tk

分頁插件支持MyBatis3.2.0~3.3.0(包含)

分頁插件最新版本為4.1.6

Maven坐標(biāo)

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

下載JAR包

分頁插件pagehelper.jar：

https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/
http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/

由于使用了sql解析工具，你還需要下載jsqlparser.jar

使用方法

1. 引入分頁插件

引入分頁插件一共有下面2種方式，推薦使用Maven方式，這種方式方便更新。

1). 引入Jar包

如果你想使用本項目的jar包而不是直接引入類，你可以在這里下載各個版本的jar包（點擊Download下的jar即可下載）

https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/
http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/

由于使用了sql解析工具，你還需要下載jsqlparser.jar（這個文件完全獨立，不依賴其他）：

http://repo1.maven.org/maven2/com/github/jsqlparser/jsqlparser/0.9.1/
http://git.oschina.net/free/Mybatis_PageHelper/attach_files

2). 使用maven

添加如下依賴：

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

當(dāng)使用maven中央庫中的快照版（帶"-SNAPSHOT"的版本）時，需要在pom.xml中添加如下配置：

<repositories><repository><id>sonatype-nexus-snapshots</id><name>Sonatype Nexus Snapshots</name><url>http://oss.sonatype.org/content/repositories/snapshots</url><releases><enabled>false</enabled></releases><snapshots><enabled>true</enabled></snapshots></repository> </repositories>

2. 在Mybatis配置xml中配置攔截器插件:

<plugins><plugin interceptor="com.github.pagehelper.PageHelper"><property name="dialect" value="mysql"/><property name="offsetAsPageNum" value="true"/><property name="rowBoundsWithCount" value="true"/><property name="pageSizeZero" value="true"/><property name="reasonable" value="false"/><property name="params" value="pageNum=pageHelperStart;pageSize=pageHelperRows;"/><property name="supportMethodsArguments" value="false"/><property name="returnPageInfo" value="none"/></plugin> </plugins>

這里的com.github.pagehelper.PageHelper使用完整的類路徑。

其他五個參數(shù)說明：

增加dialect屬性，使用時可以指定該屬性（不指定的情況下，分頁插件會自動判斷），可選值為oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012。

增加offsetAsPageNum屬性，默認(rèn)值為false，使用默認(rèn)值時不需要增加該配置，需要設(shè)為true時，需要配置該參數(shù)。當(dāng)該參數(shù)設(shè)置為true時，使用RowBounds分頁時，會將offset參數(shù)當(dāng)成pageNum使用，可以用頁碼和頁面大小兩個參數(shù)進(jìn)行分頁。

增加rowBoundsWithCount屬性，默認(rèn)值為false，使用默認(rèn)值時不需要增加該配置，需要設(shè)為true時，需要配置該參數(shù)。當(dāng)該參數(shù)設(shè)置為true時，使用RowBounds分頁會進(jìn)行count查詢。

增加pageSizeZero屬性，默認(rèn)值為false，使用默認(rèn)值時不需要增加該配置，需要設(shè)為true時，需要配置該參數(shù)。當(dāng)該參數(shù)設(shè)置為true時，如果pageSize=0或者RowBounds.limit = 0就會查詢出全部的結(jié)果（相當(dāng)于沒有執(zhí)行分頁查詢，但是返回結(jié)果仍然是Page類型）。

增加reasonable屬性，默認(rèn)值為false，使用默認(rèn)值時不需要增加該配置，需要設(shè)為true時，需要配置該參數(shù)。具體作用請看上面配置文件中的注釋內(nèi)容。

為了支持startPage(Object params)方法，增加了一個params參數(shù)來配置參數(shù)映射，用于從Map或ServletRequest中取值，可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默認(rèn)值。

supportMethodsArguments支持通過Mapper接口參數(shù)來傳遞分頁參數(shù)，默認(rèn)值false，具體用法參考com.github.pagehelper.test.basic包下的ArgumentsMapTest和ArgumentsObjTest測試類。

returnPageInfo用來支持直接返回PageInfo類型，默認(rèn)值none，可選參數(shù)always總是返回PageInfo類型,check檢查返回類型是否為PageInfo,none返回Page(List)類型。用法和配置參考com.github.pagehelper.test.basic包下的PageInfoTest，特別要注意接口的返回值和xml中的resultType類型。

增加closeConn屬性，當(dāng)使用動態(tài)數(shù)據(jù)源或沒有設(shè)置dialect屬性自動獲取數(shù)據(jù)庫類型時，會自動獲取一個數(shù)據(jù)庫連接，通過該屬性來設(shè)置是否關(guān)閉獲取的這個連接，默認(rèn)true關(guān)閉。

重要提示：

當(dāng)offsetAsPageNum=false的時候，由于PageNum問題，RowBounds查詢的時候reasonable會強(qiáng)制為false。使用PageHelper.startPage方法不受影響。

另外使用RowBounds在這種情況下返回的Page對象由于沒有正確的pageNum屬性，所以也不能使用PageInfo處理。

如果你不理解為什么，可以看這樣一個例子：查詢offset=7,limit=10，這個時候pageNum=?，這種情況沒法計算pageNum，沒法判斷當(dāng)前是第幾頁。

3. 如何選擇配置這些參數(shù)

單獨看每個參數(shù)的說明可能是一件讓人不爽的事情，這里列舉一些可能會用到某些參數(shù)的情況。

首先dialect屬性是必須的，不需要解釋。其他的參數(shù)一般情況下我們都不必去管，如果想了解何時使用合適，你可以參考以下場景：

場景一

如果你仍然在用類似ibatis式的命名空間調(diào)用方式，你也許會用到rowBoundsWithCount，分頁插件對RowBounds支持和Mybatis默認(rèn)的方式是一致，默認(rèn)情況下不會進(jìn)行count查詢，如果你想在分頁查詢時進(jìn)行count查詢，以及使用更強(qiáng)大的PageInfo類，你需要設(shè)置該參數(shù)為true。

場景二

如果你仍然在用類似ibatis式的命名空間調(diào)用方式，你覺得RowBounds中的兩個參數(shù)offset,limit不如pageNum,pageSize容易理解，你可以使用offsetAsPageNum參數(shù)，將該參數(shù)設(shè)置為true后，offset會當(dāng)成pageNum使用，limit和pageSize含義相同。

場景三

如果覺得某個地方使用分頁后，你仍然想通過控制參數(shù)查詢?nèi)康慕Y(jié)果，你可以配置pageSizeZero為true，配置后，如可以通過設(shè)置pageSize=0或者RowBounds.limit = 0就會查詢出全部的結(jié)果。

場景四

如果你分頁插件使用于類似分頁查看列表式的數(shù)據(jù)，如新聞列表，軟件列表，你希望用戶輸入的頁數(shù)不在合法范圍（第一頁到最后一頁之外）時能夠正確的響應(yīng)到正確的結(jié)果頁面，那么你可以配置reasonable為true，這時如果pageNum<1會查詢第一頁，如果pageNum>總頁數(shù)會查詢最后一頁。

4. Spring配置方法

首先需要在Spring中配置org.mybatis.spring.SqlSessionFactoryBean。然后配置配置Mybatis的具體配置有兩種方式，一種是用mybatis默認(rèn)的xml配置，另一種就是完全使用spring的屬性配置方式。

1.mybatis默認(rèn)的xml配置

配置configLocation屬性指向上面的mybatis-config.xml文件。有關(guān)分頁插件的配置都在mybatis-config.xml，具體配置內(nèi)容參考上面的mybatis-config.xml。

2.使用spring的屬性配置方式

注意：請不用同時使用spring配置方式和mybatis-config.xml配置方式，只需要選擇其中一個就行。配置多個分頁插件時，會拋出異常提示。

分頁插件配置錯誤:請不要在系統(tǒng)中配置多個分頁插件(使用Spring時,mybatis-config.xml和Spring配置方式，請選擇其中一種，不要同時配置多個分頁插件)！

使用spring的屬性配置方式，可以使用plugins屬性像下面這樣配置：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="mapperLocations"><array><value>classpath:mapper/*.xml</value></array></property><property name="typeAliasesPackage" value="com.isea533.ssm.model"/><property name="plugins"><array><bean class="com.github.pagehelper.PageHelper"><property name="properties"><value>dialect=hsqldb</value></property></bean></array></property> </bean>

屬性配置按照上面的方式配置，每個配置獨立一行即可。

5. 如何在代碼中使用

閱讀前后請注意看重要提示

首先該分頁插件支持以下兩種調(diào)用方式：

//第一種，RowBounds方式的調(diào)用 List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));//第二種，Mapper接口方式的調(diào)用，推薦這種使用方式。 PageHelper.startPage(1, 10); List<Country> list = countryMapper.selectIf(1);

下面分別對這兩種方式進(jìn)行詳細(xì)介紹

1). RowBounds方式的調(diào)用

List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));

使用這種調(diào)用方式時，你可以使用RowBounds參數(shù)進(jìn)行分頁，這種方式侵入性最小，我們可以看到，通過RowBounds方式調(diào)用只是使用了這個參數(shù)，并沒有增加其他任何內(nèi)容。

分頁插件檢測到使用了RowBounds參數(shù)時，就會對該查詢進(jìn)行物理分頁。

關(guān)于這種方式的調(diào)用，有兩個特殊的參數(shù)是針對RowBounds的，你可以參看上面的場景一和場景二

注：不只有命名空間方式可以用RowBounds，使用接口的時候也可以增加RowBounds參數(shù)，例如：

//這種情況下也會進(jìn)行物理分頁查詢 List<Country> selectAll(RowBounds rowBounds);

2).?PageHelper.startPage靜態(tài)方法調(diào)用

在你需要進(jìn)行分頁的Mybatis方法前調(diào)用PageHelper.startPage靜態(tài)方法即可，緊跟在這個方法后的第一個Mybatis查詢方法會被進(jìn)行分頁。

例一：

SqlSession sqlSession = MybatisHelper.getSqlSession(); CountryMapper countryMapper = sqlSession.getMapper(CountryMapper.class); try {//獲取第1頁，10條內(nèi)容，默認(rèn)查詢總數(shù)countPageHelper.startPage(1, 10);//緊跟著的第一個select方法會被分頁List<Country> list = countryMapper.selectIf(1);assertEquals(2, list.get(0).getId());assertEquals(10, list.size());//分頁時，實際返回的結(jié)果list類型是Page<E>，如果想取出分頁信息，需要強(qiáng)制轉(zhuǎn)換為Page<E>，//或者使用PageInfo類（下面的例子有介紹）assertEquals(182, ((Page) list).getTotal()); } finally {sqlSession.close(); }

例二：

SqlSession sqlSession = MybatisHelper.getSqlSession(); CountryMapper countryMapper = sqlSession.getMapper(CountryMapper.class); try {//獲取第1頁，10條內(nèi)容，默認(rèn)查詢總數(shù)countPageHelper.startPage(1, 10);//緊跟著的第一個select方法會被分頁List<Country> list = countryMapper.selectIf(1);//后面的不會被分頁，除非再次調(diào)用PageHelper.startPageList<Country> list2 = countryMapper.selectIf(null);//list1assertEquals(2, list.get(0).getId());assertEquals(10, list.size());//分頁時，實際返回的結(jié)果list類型是Page<E>，如果想取出分頁信息，需要強(qiáng)制轉(zhuǎn)換為Page<E>，//或者使用PageInfo類（下面的例子有介紹）assertEquals(182, ((Page) list).getTotal());//list2assertEquals(1, list2.get(0).getId());assertEquals(182, list2.size()); } finally {sqlSession.close(); }

例三，使用PageInfo的用法：

//獲取第1頁，10條內(nèi)容，默認(rèn)查詢總數(shù)count PageHelper.startPage(1, 10); List<Country> list = countryMapper.selectAll(); //用PageInfo對結(jié)果進(jìn)行包裝 PageInfo page = new PageInfo(list); //測試PageInfo全部屬性 //PageInfo包含了非常全面的分頁屬性 assertEquals(1, page.getPageNum()); assertEquals(10, page.getPageSize()); assertEquals(1, page.getStartRow()); assertEquals(10, page.getEndRow()); assertEquals(183, page.getTotal()); assertEquals(19, page.getPages()); assertEquals(1, page.getFirstPage()); assertEquals(8, page.getLastPage()); assertEquals(true, page.isFirstPage()); assertEquals(false, page.isLastPage()); assertEquals(false, page.isHasPreviousPage()); assertEquals(true, page.isHasNextPage());

本項目中包含大量測試，您可以通過查看測試代碼了解使用方法。

測試代碼地址：http://git.oschina.net/free/Mybatis_PageHelper/tree/master/src/test/java/com/github/pagehelper/test

MyBatis和Spring集成示例

如果和Spring集成不熟悉，可以參考下面兩個

只有基礎(chǔ)的配置信息，沒有任何現(xiàn)成的功能，作為新手入門搭建框架的基礎(chǔ)

集成Spring3.x
集成Spring4.x

這兩個集成框架集成了MyBatis分頁插件和MyBatis通用Mapper。

轉(zhuǎn)載于:https://my.oschina.net/zhanghaiyang/blog/725672

總結(jié)

以上是生活随笔為你收集整理的MyBatis学习总结（17）——Mybatis分页插件PageHelper的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。

上一篇：使用ArcGIS Server发布我们的
下一篇：使用CDN引用jQuery