Mybatis的 PageHelper分頁插件的使用

PageHelper介紹

PageHelper是國內非常優秀的一款開源的mybatis分頁插件，它支持基本主流與常用的數據庫，例如mysql、
oracle、mariaDB、DB2、SQLite、Hsqldb等。
本項目在 github 的項目地址：https://github.com/pagehelper/Mybatis-PageHelper
本項目在 gitosc 的項目地址：http://git.oschina.net/free/Mybatis_PageHelper

PageHelper使用

使用 Maven
在 pom.xml 中添加如下依賴：

<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>最新版本</version>
</dependency>

配置
reasonable ：分頁合理化參數，默認值爲 false 。當該參數設置爲 true 時， pageNum<=0 時會查詢第一
頁， pageNum>pages （超過總數時），會查詢最後一頁。默認 false 時，直接根據參數進行查詢。
.在 Spring 配置文件中配置攔截器插件

  <!-- 把交給IOC管理 SqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="plugins">
            <array>
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <props>
                            <prop key="helperDialect">oracle</prop>
                            <prop key="reasonable">true</prop>
                        </props>
                    </property>
                </bean>
            </array>
        </property>
    </bean>

分頁插件參數介紹

1. helperDialect ：分頁插件會自動檢測當前的數據庫鏈接，自動選擇合適的分頁方式。 你可以配置
   helperDialect 屬性來指定分頁插件使用哪種方言。配置時，可以使用下面的縮寫值：
   oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver201
   2 , derby
   特別注意：使用 SqlServer2012 數據庫時，需要手動指定爲 sqlserver2012 ，否則會使用 SqlServer2005 的
   方式進行分頁。
   你也可以實現 AbstractHelperDialect ，然後配置該屬性爲實現類的全限定名稱即可使用自定義的實現方
   法。
2. offsetAsPageNum ：默認值爲 false ，該參數對使用 RowBounds 作爲分頁參數時有效。 當該參數設置爲
   true 時，會將 RowBounds 中的 offset 參數當成 pageNum 使用，可以用頁碼和頁面大小兩個參數進行分
   頁。
3. rowBoundsWithCount ：默認值爲 false ，該參數對使用 RowBounds 作爲分頁參數時有效。 當該參數設置
   爲 true 時，使用 RowBounds 分頁會進行 count 查詢。
4. pageSizeZero ：默認值爲 false ，當該參數設置爲 true 時，如果 pageSize=0 或者 RowBounds.limit =
   0 就會查詢出全部的結果（相當於沒有執行分頁查詢，但是返回結果仍然是 Page 類型）。
5. reasonable ：分頁合理化參數，默認值爲 false 。當該參數設置爲 true 時， pageNum<=0 時會查詢第一
   頁， pageNum>pages （超過總數時），會查詢最後一頁。默認 false 時，直接根據參數進行查詢。
6. params ：爲了支持 startPage(Object params) 方法，增加了該參數來配置參數映射，用於從對象中根據屬
   性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默認值， 默認
   值爲
   pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero
   。
7. supportMethodsArguments ：支持通過 Mapper 接口參數來傳遞分頁參數，默認值 false ，分頁插件會從查
   詢方法的參數值中，自動根據上面 params 配置的字段中取值，查找到合適的值時就會自動分頁。 使用方法
   可以參考測試代碼中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和
   ArgumentsObjTest 。
8. autoRuntimeDialect ：默認值爲 false 。設置爲 true 時，允許在運行時根據多數據源自動識別對應方言
   的分頁 （不支持自動選擇 sqlserver2012 ，只能使用 sqlserver ），用法和注意事項參考下面的場景五。
9. closeConn ：默認值爲 true 。當使用運行時動態數據源或沒有設置 helperDialect 屬性自動獲取數據庫類
   型時，會自動獲取一個數據庫連接， 通過該屬性來設置是否關閉獲取的這個連接，默認 true 關閉，設置爲
   false 後，不會關閉獲取的連接，這個參數的設置要根據自己選擇的數據源來決定。

  @RequestMapping("/findAll.do")
    public ModelAndView findAll(@RequestParam(name = "page", required = true, defaultValue = "1") int page, @RequestParam(name = "size", required = true, defaultValue = "4") int size) throws Exception {
        ModelAndView mv = new ModelAndView();
        List<Orders> ordersList = ordersService.findAll(page, size);
        //PageInfo就是一個分頁Bean
        PageInfo pageInfo=new PageInfo(ordersList);
        mv.addObject("pageInfo",pageInfo);
        mv.setViewName("orders-page-list");
        return mv;
    }

JSP中做分頁處理

<div class="box-footer">
					<div class="pull-left">
						<div class="form-group form-inline">
							總共${pageInfo.pages} 頁，共${pageInfo.total} 條數據。 每頁
							<select class="form-control" id="changePageSize" onchange="changePageSize()">
								<option>1</option>
								<option>2</option>
								<option>3</option>
								<option>4</option>
								<option>5</option>
							</select> 條
						</div>
					</div>

					<div class="box-tools pull-right">
						<ul class="pagination">
							<li>
								<a href="${pageContext.request.contextPath}/orders/findAll.do?page=1&size=${pageInfo.pageSize}" aria-label="Previous">首頁</a>
							</li>
							<li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum-1}&size=${pageInfo.pageSize}">上一頁</a></li>
							<c:forEach begin="1" end="${pageInfo.pages}" var="pageNum">
								<li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageNum}&size=${pageInfo.pageSize}">${pageNum}</a></li>
							</c:forEach>
							<li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum+1}&size=${pageInfo.pageSize}">下一頁</a></li>
							<li>
								<a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pages}&size=${pageInfo.pageSize}" aria-label="Next">尾頁</a>
							</li>
						</ul>
					</div>