Spring集成PageHelper的簡單用法

一、Maven依賴，注意使用PageHelper時的版本必須與Mybatis版本對應

 1         <!-- 添加Mybatis依賴 -->
 2         <dependency>
 3             <groupId>org.mybatis</groupId>
 4             <artifactId>mybatis</artifactId>
 5             <version>3.3.0</version>
 6         </dependency>
 7         <dependency>
 8             <groupId>org.mybatis</groupId>
 9             <artifactId>mybatis-spring</artifactId>
10             <version>1.2.3</version>
11         </dependency>
12         <!-- pageHelper -->
13         <dependency>
14             <groupId>com.github.pagehelper</groupId>
15             <artifactId>pagehelper</artifactId>
16             <version>4.1.4</version>
17         </dependency>

二、須要在Mybatis的配置信息中使用PageHelper插件，mybatis-config.xml

 1 <?xml version="1.0" encoding="utf-8" ?>
 2 <!DOCTYPE configuration
 3         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
 4         "http://mybatis.org/dtd/mybatis-3-config.dtd">
 5 
 6 <configuration>
 7     <plugins>
 8         <plugin interceptor="com.github.pagehelper.PageHelper">
 9             <!--指明數據庫 4.0.0之後不須要設置此屬性-->
10             <property name="dialect" value="mysql"/>
11             <!-- 該參數默認爲false -->
12             <!-- 設置爲true時，會將RowBounds第一個參數offset當成pageNum頁碼使用 -->
13             <!-- 和startPage中的pageNum效果同樣-->
14             <property name="offsetAsPageNum" value="true"/>
15             <!-- 該參數默認爲false -->
16             <!-- 設置爲true時，使用RowBounds分頁會進行count查詢 -->
17             <property name="rowBoundsWithCount" value="true"/>
18             <!-- 設置爲true時，若是pageSize=0或者RowBounds.limit = 0就會查詢出所有的結果 -->
19             <!-- （至關於沒有執行分頁查詢，可是返回結果仍然是Page類型）-->
20             <property name="pageSizeZero" value="true"/>
21             <!-- 3.3.0版本可用 - 分頁參數合理化，默認false禁用 -->
22             <!-- 啓用合理化時，若是pageNum<1會查詢第一頁，若是pageNum>pages會查詢最後一頁 -->
23             <!-- 禁用合理化時，若是pageNum<1或pageNum>pages會返回空數據 -->
24             <property name="reasonable" value="true"/>
25             <!-- 3.5.0版本可用 - 爲了支持startPage(Object params)方法 -->
26             <!-- 增長了一個`params`參數來配置參數映射，用於從Map或ServletRequest中取值 -->
27             <!-- 能夠配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默認值 -->
28             <!-- 不理解該含義的前提下，不要隨便複製該配置 -->
29             <property name="params" value="pageNum=start;pageSize=limit;"/>
30             <!-- 支持經過Mapper接口參數來傳遞分頁參數 -->
31             <property name="supportMethodsArguments" value="true"/>
32             <!-- always老是返回PageInfo類型,check檢查返回類型是否爲PageInfo,none返回Page -->
33             <property name="returnPageInfo" value="check"/>
34         </plugin>
35     </plugins>
36 </configuration>

三、在配置Spring配置文件中，配置Mybatis的SqlSessionFactory時，須要把mybatis-config.xml添加到屬性中

1     <!-- SqlSessionFactory -->
2     <bean id="sessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
3         <!--設置數據源-->
4         <property name="dataSource" ref="dataSource"></property>
5         <!--設置映射文件-->
6         <property name="mapperLocations" value="classpath:mybatis/sqlmap/mapper/*.xml"></property>
7         <!--設置pageHelper-->
8         <property name="configLocation" value="classpath:mybatis/mybatis-config.xml"></property>
9     </bean>

四、使用Mybatis的mapper接口進行查詢，在查詢時，須要使用PageHelper.startPage方法

 1     @Test
 2     public void testSelectAll() {
 3         Page<Doctor> page = PageHelper.startPage(1, 3);
 4         //selectAll查詢出的List即爲上面定義的page
 5         doctorMapper.selectAll();
 6         //注意：
 7         //使用PageHelper.startPage只是針對接下來的一條查詢語句，
 8         //若是又查詢了一次數據，則還須要使用一次PageHelper.startPage
 9         logger.info("獲取全部Doctor信息，得到記錄數：{}", page.size());
10         logger.info("獲取全部Doctor信息，得到記錄：{}", page);
11         //使用PageInfo封裝
12         PageInfo<Doctor> info = new PageInfo<Doctor>(page);
13         logger.info("info.getPages:{}",info.getPages());
14     }

五、Page對象繼承了ArrayList，所以在使用了PageHelper.startPage以後，Page即爲查詢到的數據，而且在Page中還額外封裝了pageNum，pageSize等屬性，還可使用PageInfo封裝Page，PageInfo中有更多的分頁屬性，例如isFirstPage是否爲首頁、isLastPage是否爲末尾、hasNextPage是否存在下一頁等。