后端程序员都知道，在Web系统中，分页是一种常见的功能，我之前写的分页方法都比较麻烦，移植性也不高，这就很不乐观了。作为一个积极开朗的程序员，怎么能不去了解PageHelper分页插件呢？PageHelper是国内非常优秀的一款开源的mybatis分页插件，它支持基本主流与常用的数据库，一致支持mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。OK接下来就一起来了解了解PageHelper分页插件！

@

中文教程

首先，推荐两个PageHelper分页插件项目地址，这里面有中文教程：

github 项目

gitosc 项目

PageHelper使用

至于怎么使用我想上面提供的两个项目讲的绝逼讲的比我清楚，下面直接进入PageHelper使用实战

首先，集成引入分页插件有下面2种方式，一种是直接下jar包一种是mawen依赖，推荐使用 Maven 方式。

方法一： 直接下载jar包

jar包下载地址，由于使用了sql 解析工具，你还需要下载 jsqlparser.jar

方法二： Maven添加依赖

  1.   <dependency>
  2.             <groupId>com.github.pagehelper</groupId>
  3.             <artifactId>pagehelper</artifactId>
  4.             <version>5.1.2</version>
  5.   </dependency>

1.导入maven依赖分页插件

我这里就采用方法二maven依赖

2.各个情况下xml的配置

情况一：如果是mybatis单独使用PageHelper分页插件的时候，就需要在xml配置中添加如下代码：

  1.   <!--
  2. plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下properties?, settings?,
  3.  typeAliases?, typeHandlers?, objectFactory?,objectWrapperFactory?, plugins?,
  4.  environments?, databaseIdProvider?, mappers?
  5.   -->
  6.   <!-- com.github.pagehelper为PageHelper类所在包名 -->
  7.     <plugins>
  8.     <!-- 使用下面的方式配置参数，推荐的两个项目中有所有的参数介绍 -->
  9.         <plugin interceptor="com.github.pagehelper.PageInterceptor">
  10.             <property name="param1" value="value1"/>
  11.         </plugin>
  12.     </plugins>

情况二：显然，我是这个是ssm项目，mybatis是交由spring的IOC容器管理的，就需要在spring的xml配置中添加如下代码（创建工厂中添加）：

  1.   <!-- 把交给IOC管理 SqlSessionFactory -->
  2.  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  3.      <property name="dataSource" ref="dataSource"/>
  4.      <!-- 传入PageHelper的插件 -->
  5.      <property name="plugins">
  6.          <array>
  7.              <!-- 传入插件的对象 -->
  8.              <bean class="com.github.pagehelper.PageInterceptor">
  9.                  <property name="properties">
  10.                      <props>
  11.                          <prop key="helperDialect">oracle</prop>
  12.                          <prop key="reasonable">true</prop>
  13.                      </props>
  14.                  </property>
  15.              </bean>
  16.          </array>
  17.      </property>
  18.  </bean>

下面用一个图来分析一下两个参数作用：



更多情况请参考上面推荐的项目~

3.Controller代码编写

上面我们配置完了，至于为什么从controller代码开始是因为controller调用service嘛，这样编写代码更方便快捷！为了看出差别，未分页的controller代码方法如下：

  1. @Controller
  2. @RequestMapping("/orders")
  3. public class OrdersController {
  5.     @Autowired
  6.     private IOrdersService ordersService;
  8. //查询所有orders未分页
  9.    @RequestMapping("/findAll.do")
  10.     public ModelAndView findAll() {
  11.         ModelAndView mv = new ModelAndView();
  12.         List<Orders> ordersList = ordersService.findAll();
  13.         mv.addObject("ordersList", ordersList);
  14.         mv.setViewName("orders-list");
  15.         return mv;
  16.     }
  17. }

而采用了分页代码则是如下：

  1. //采用分页代码方法
  2.    @RequestMapping("/findAll.do")
  3.     public ModelAndView findAll(@RequestParam(name="page",required = true,defaultValue = "1")int page,@RequestParam(name="size",required = true,defaultValue = "4")int size ) {
  4.         ModelAndView mv = new ModelAndView();
  5.         List<Orders> ordersList = ordersService.findAll(page,size);
  7.         //PageInfo就是一个分页Bean
  8.         PageInfo pageInfo =new PageInfo(ordersList);
  9.         mv.addObject("pageInfo", pageInfo);
  10.         mv.setViewName("orders-list");
  11.         return mv;
  13.     }

可以发现多了两个参数分别是page和size

4.Service接口代码编写

  1. public interface IOrdersService {
  2.     List<Orders> findAll(int page,int size);
  3. }

5.Service实现类代码编写

在执行sql之前（ServiceImpl），使用PageHelper分页，参数pageNum 是页码值 参数pageSize 代表是每页显示条数。在ServiceImpl中,使用PageHelper分页操作代码如下：

  1. @Service
  2. public class OrdersServiceImpl implements IOrdersService {
  3.     @Autowired
  4.     private IOrdersDao ordersDao;
  6.     @Override
  7.     public List<Orders> findAll(int page,int size) {
  8.         //参数pageNum 是页码值   参数pageSize 代表是每页显示条数
  9.         PageHelper.startPage(page, size);
  10.         return ordersDao.findAll();
  11.     }
  12. }

特别注意：在编写PageHelper分页代码时的 PageHelper.startPage(page, size)这一句必须写在查询方法的上一句，中间不能添加任何代码，否则失效！

6.jsp页面未处理代码

没有更改的jsp页面代码,普通查询关键更改代码块，注意这里接收数据为 ordersList 

  1. <c:forEach items="${ordersList}" var="orders">
  2.    <tr>
  3. 		<td><input name="ids" type="checkbox"></td>
  4. 		...
  5. 		<td>...</td>
  6. 		</td>
  7. 	</tr>
  8. </c:forEach>

这下面的代码则是未分页逻辑代码

  1.  <div class="box-tools pull-right">
  2.                         <ul class="pagination">
  3.                             <li>
  4.                                 <a href="#" aria-label="Previous">首页</a>
  5.                             </li>
  6.                             <li><a href="#">上一页</a></li>
  7.                             <li><a href="#">1</a></li>
  8.                             <li><a href="#">2</a></li>
  9.                             <li><a href="#">3</a></li>
  10.                             <li><a href="#">4</a></li>
  11.                             <li><a href="#">5</a></li>
  12.                             <li><a href="#">下一页</a></li>
  13.                             <li>
  14.                                 <a href="#" aria-label="Next">尾页</a>
  15.                             </li>
  16.                         </ul>
  17.                     </div>
  19.                 </div>

7.jsp页面处理后代码

更改后的jsp页面代码,分页查询的关键更改代码块，注意这里接收数据为 ordersList.list 

  1. <c:forEach items="${ordersList.list}" var="orders">
  2.    <tr>
  3. 		<td><input name="ids" type="checkbox"></td>
  4. 		...
  5. 		<td>...</td>
  6. 		</td>
  7. 	</tr>
  8. </c:forEach>

这下面的代码则是分页逻辑代码

  1. <div class="box-tools pull-right">
  2.    <ul class="pagination">
  3. 		<li>
  4. 			<a href="${pageContext.request.contextPath}/orders/findAll.do?page=1&size=${pageInfo.pageSize}" aria-label="Previous">首页</a>
  5. 		</li>
  6. 		<li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum-1}&size=${pageInfo.pageSize}">上一页</a></li>
  7. 		<c:forEach begin="1" end="${pageInfo.pages}" var="pageNum">
  8. 			<li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageNum}&size=${pageInfo.pageSize}">${pageNum}</a></li>
  9. 		</c:forEach>
  10. 		<li><a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pageNum+1}&size=${pageInfo.pageSize}">下一页</a></li>
  11. 		<li>
  12. 			<a href="${pageContext.request.contextPath}/orders/findAll.do?page=${pageInfo.pages}&size=${pageInfo.pageSize}" aria-label="Next">尾页</a>
  13. 		</li>
  14. 	</ul>
  15. </div>
  16. </div>

8.jsp页面处理前后代码分析



  1.     //PageInfo就是一个分页Bean
  2.    PageInfo pageInfo =new PageInfo(ordersList);

为了能看到上面的pageInfo源代码，我就把代码贴在下面了

  1. package com.github.pagehelper;
  3. import java.io.Serializable;
  4. import java.util.Collection;
  5. import java.util.List;
  7. public class PageInfo<T> implements Serializable {
  8.     private static final long serialVersionUID = 1L;
  9.     private int pageNum;
  10.     private int pageSize;
  11.     private int size;
  12.     private int startRow;
  13.     private int endRow;
  14.     private long total;
  15.     private int pages;
  16.     private List<T> list;
  17.     private int prePage;
  18.     private int nextPage;
  19.     private boolean isFirstPage;
  20.     private boolean isLastPage;
  21.     private boolean hasPreviousPage;
  22.     private boolean hasNextPage;
  23.     private int navigatePages;
  24.     private int[] navigatepageNums;
  25.     private int navigateFirstPage;
  26.     private int navigateLastPage;
  28.     public PageInfo() {
  29.         this.isFirstPage = false;
  30.         this.isLastPage = false;
  31.         this.hasPreviousPage = false;
  32.         this.hasNextPage = false;
  33.     }
  35.     public PageInfo(List<T> list) {
  36.         this(list, 8);
  37.     }
  39.     public PageInfo(List<T> list, int navigatePages) {
  40.         this.isFirstPage = false;
  41.         this.isLastPage = false;
  42.         this.hasPreviousPage = false;
  43.         this.hasNextPage = false;
  44.         if (list instanceof Page) {
  45.             Page page = (Page)list;
  46.             this.pageNum = page.getPageNum();
  47.             this.pageSize = page.getPageSize();
  48.             this.pages = page.getPages();
  49.             this.list = page;
  50.             this.size = page.size();
  51.             this.total = page.getTotal();
  52.             if (this.size == 0) {
  53.                 this.startRow = 0;
  54.                 this.endRow = 0;
  55.             } else {
  56.                 this.startRow = page.getStartRow() + 1;
  57.                 this.endRow = this.startRow - 1 + this.size;
  58.             }
  59.         } else if (list instanceof Collection) {
  60.             this.pageNum = 1;
  61.             this.pageSize = list.size();
  62.             this.pages = this.pageSize > 0 ? 1 : 0;
  63.             this.list = list;
  64.             this.size = list.size();
  65.             this.total = (long)list.size();
  66.             this.startRow = 0;
  67.             this.endRow = list.size() > 0 ? list.size() - 1 : 0;
  68.         }
  70.         if (list instanceof Collection) {
  71.             this.navigatePages = navigatePages;
  72.             this.calcNavigatepageNums();
  73.             this.calcPage();
  74.             this.judgePageBoudary();
  75.         }
  77.     }
  79.     private void calcNavigatepageNums() {
  80.         int i;
  81.         if (this.pages <= this.navigatePages) {
  82.             this.navigatepageNums = new int[this.pages];
  84.             for(i = 0; i < this.pages; ++i) {
  85.                 this.navigatepageNums[i] = i + 1;
  86.             }
  87.         } else {
  88.             this.navigatepageNums = new int[this.navigatePages];
  89.             i = this.pageNum - this.navigatePages / 2;
  90.             int endNum = this.pageNum + this.navigatePages / 2;
  91.             int i;
  92.             if (i < 1) {
  93.                 i = 1;
  95.                 for(i = 0; i < this.navigatePages; ++i) {
  96.                     this.navigatepageNums[i] = i++;
  97.                 }
  98.             } else if (endNum > this.pages) {
  99.                 endNum = this.pages;
  101.                 for(i = this.navigatePages - 1; i >= 0; --i) {
  102.                     this.navigatepageNums[i] = endNum--;
  103.                 }
  104.             } else {
  105.                 for(i = 0; i < this.navigatePages; ++i) {
  106.                     this.navigatepageNums[i] = i++;
  107.                 }
  108.             }
  109.         }
  111.     }
  113.     private void calcPage() {
  114.         if (this.navigatepageNums != null && this.navigatepageNums.length > 0) {
  115.             this.navigateFirstPage = this.navigatepageNums[0];
  116.             this.navigateLastPage = this.navigatepageNums[this.navigatepageNums.length - 1];
  117.             if (this.pageNum > 1) {
  118.                 this.prePage = this.pageNum - 1;
  119.             }
  121.             if (this.pageNum < this.pages) {
  122.                 this.nextPage = this.pageNum + 1;
  123.             }
  124.         }
  126.     }
  128.     private void judgePageBoudary() {
  129.         this.isFirstPage = this.pageNum == 1;
  130.         this.isLastPage = this.pageNum == this.pages || this.pages == 0;
  131.         this.hasPreviousPage = this.pageNum > 1;
  132.         this.hasNextPage = this.pageNum < this.pages;
  133.     }
  135.     public int getPageNum() {
  136.         return this.pageNum;
  137.     }
  139.     public void setPageNum(int pageNum) {
  140.         this.pageNum = pageNum;
  141.     }
  143.     public int getPageSize() {
  144.         return this.pageSize;
  145.     }
  147.     public void setPageSize(int pageSize) {
  148.         this.pageSize = pageSize;
  149.     }
  151.     public int getSize() {
  152.         return this.size;
  153.     }
  155.     public void setSize(int size) {
  156.         this.size = size;
  157.     }
  159.     public int getStartRow() {
  160.         return this.startRow;
  161.     }
  163.     public void setStartRow(int startRow) {
  164.         this.startRow = startRow;
  165.     }
  167.     public int getEndRow() {
  168.         return this.endRow;
  169.     }
  171.     public void setEndRow(int endRow) {
  172.         this.endRow = endRow;
  173.     }
  175.     public long getTotal() {
  176.         return this.total;
  177.     }
  179.     public void setTotal(long total) {
  180.         this.total = total;
  181.     }
  183.     public int getPages() {
  184.         return this.pages;
  185.     }
  187.     public void setPages(int pages) {
  188.         this.pages = pages;
  189.     }
  191.     public List<T> getList() {
  192.         return this.list;
  193.     }
  195.     public void setList(List<T> list) {
  196.         this.list = list;
  197.     }
  199.     /** @deprecated */
  200.     @Deprecated
  201.     public int getFirstPage() {
  202.         return this.navigateFirstPage;
  203.     }
  205.     /** @deprecated */
  206.     @Deprecated
  207.     public void setFirstPage(int firstPage) {
  208.         this.navigateFirstPage = firstPage;
  209.     }
  211.     public int getPrePage() {
  212.         return this.prePage;
  213.     }
  215.     public void setPrePage(int prePage) {
  216.         this.prePage = prePage;
  217.     }
  219.     public int getNextPage() {
  220.         return this.nextPage;
  221.     }
  223.     public void setNextPage(int nextPage) {
  224.         this.nextPage = nextPage;
  225.     }
  227.     /** @deprecated */
  228.     @Deprecated
  229.     public int getLastPage() {
  230.         return this.navigateLastPage;
  231.     }
  233.     /** @deprecated */
  234.     @Deprecated
  235.     public void setLastPage(int lastPage) {
  236.         this.navigateLastPage = lastPage;
  237.     }
  239.     public boolean isIsFirstPage() {
  240.         return this.isFirstPage;
  241.     }
  243.     public void setIsFirstPage(boolean isFirstPage) {
  244.         this.isFirstPage = isFirstPage;
  245.     }
  247.     public boolean isIsLastPage() {
  248.         return this.isLastPage;
  249.     }
  251.     public void setIsLastPage(boolean isLastPage) {
  252.         this.isLastPage = isLastPage;
  253.     }
  255.     public boolean isHasPreviousPage() {
  256.         return this.hasPreviousPage;
  257.     }
  259.     public void setHasPreviousPage(boolean hasPreviousPage) {
  260.         this.hasPreviousPage = hasPreviousPage;
  261.     }
  263.     public boolean isHasNextPage() {
  264.         return this.hasNextPage;
  265.     }
  267.     public void setHasNextPage(boolean hasNextPage) {
  268.         this.hasNextPage = hasNextPage;
  269.     }
  271.     public int getNavigatePages() {
  272.         return this.navigatePages;
  273.     }
  275.     public void setNavigatePages(int navigatePages) {
  276.         this.navigatePages = navigatePages;
  277.     }
  279.     public int[] getNavigatepageNums() {
  280.         return this.navigatepageNums;
  281.     }
  283.     public void setNavigatepageNums(int[] navigatepageNums) {
  284.         this.navigatepageNums = navigatepageNums;
  285.     }
  287.     public int getNavigateFirstPage() {
  288.         return this.navigateFirstPage;
  289.     }
  291.     public int getNavigateLastPage() {
  292.         return this.navigateLastPage;
  293.     }
  295.     public void setNavigateFirstPage(int navigateFirstPage) {
  296.         this.navigateFirstPage = navigateFirstPage;
  297.     }
  299.     public void setNavigateLastPage(int navigateLastPage) {
  300.         this.navigateLastPage = navigateLastPage;
  301.     }
  303.     public String toString() {
  304.         StringBuffer sb = new StringBuffer("PageInfo{");
  305.         sb.append("pageNum=").append(this.pageNum);
  306.         sb.append(", pageSize=").append(this.pageSize);
  307.         sb.append(", size=").append(this.size);
  308.         sb.append(", startRow=").append(this.startRow);
  309.         sb.append(", endRow=").append(this.endRow);
  310.         sb.append(", total=").append(this.total);
  311.         sb.append(", pages=").append(this.pages);
  312.         sb.append(", list=").append(this.list);
  313.         sb.append(", prePage=").append(this.prePage);
  314.         sb.append(", nextPage=").append(this.nextPage);
  315.         sb.append(", isFirstPage=").append(this.isFirstPage);
  316.         sb.append(", isLastPage=").append(this.isLastPage);
  317.         sb.append(", hasPreviousPage=").append(this.hasPreviousPage);
  318.         sb.append(", hasNextPage=").append(this.hasNextPage);
  319.         sb.append(", navigatePages=").append(this.navigatePages);
  320.         sb.append(", navigateFirstPage=").append(this.navigateFirstPage);
  321.         sb.append(", navigateLastPage=").append(this.navigateLastPage);
  322.         sb.append(", navigatepageNums=");
  323.         if (this.navigatepageNums == null) {
  324.             sb.append("null");
  325.         } else {
  326.             sb.append('[');
  328.             for(int i = 0; i < this.navigatepageNums.length; ++i) {
  329.                 sb.append(i == 0 ? "" : ", ").append(this.navigatepageNums[i]);
  330.             }
  332.             sb.append(']');
  333.         }
  335.         sb.append('}');
  336.         return sb.toString();
  337.     }
  338. }

到这里，基本就OK了，我再次强调我推荐的那两个项目，那里面讲的很详细大佬写的，强调完毕，挥爪~

Mybatis分页插件PageHelper的学习与使用的更多相关文章

  1. Mybatis学习---Mybatis分页插件 - PageHelper

    1. Mybatis分页插件 - PageHelper说明 如果你也在用Mybatis,建议尝试该分页插件,这个一定是最方便使用的分页插件. 该插件目前支持Oracle,Mysql,MariaDB,S ...

  2. MyBatis 分页插件PageHelper 后台报错

    今天遇到一个问题,使用MyBatis 分页插件PageHelper 进行排序分页后,能正常返回正确的结果,但后台却一直在报错 net.sf.jsqlparser.parser.ParseExcepti ...

  3. Mybatis分页插件PageHelper的配置和使用方法

     Mybatis分页插件PageHelper的配置和使用方法 前言 在web开发过程中涉及到表格时,例如dataTable,就会产生分页的需求,通常我们将分页方式分为两种:前端分页和后端分页. 前端分 ...

  4. Mybatis分页插件PageHelper使用

    一． Mybatis分页插件PageHelper使用  1.不使用插件如何分页: 使用mybatis实现: 1)接口: List<Student> selectStudent(Map< ...

  5. Java SSM框架之MyBatis3（三）Mybatis分页插件PageHelper

    引言 对于使用Mybatis时,最头痛的就是写分页,需要先写一个查询count的select语句,然后再写一个真正分页查询的语句,当查询条件多了之后,会发现真不想花双倍的时间写count和select ...

  6. Mybatis分页插件PageHelper的实现

    Mybatis分页插件PageHelper的实现 前言 分页这个概念在做web网站的时候很多都会碰到 说它简单吧 其实也简单 小型的网站,完全可以自己写一个,首先查出数据库总条数,然后按照分页大小分为 ...

  7. 基于Mybatis分页插件PageHelper

    基于Mybatis分页插件PageHelper 1.分页插件使用 1.POM依赖 PageHelper的依赖如下.需要新的版本可以去maven上自行选择 <!-- PageHelper 插件分页 ...

  8. Mybatis分页插件-PageHelper的使用

    转载:http://blog.csdn.net/u012728960/article/details/50791343 Mybatis分页插件-PageHelper的使用 怎样配置mybatis这里就 ...

  9. （转）淘淘商城系列——MyBatis分页插件(PageHelper)的使用以及商品列表展示

    http://blog.csdn.net/yerenyuan_pku/article/details/72774381 上文我们实现了展示后台页面的功能,而本文我们实现的主要功能是展示商品列表,大家要 ...

随机推荐

  1. access 2013下载 access 2010下载 access 2007下载 Access 2003下载 安装交流的论坛

    在网上搜索了一个access 2013下载 access 2010下载 access 2007下载 Access 2003下载 安装交流的论坛 office安装的常见问题: http://www.of ...

  2. Openmp多线程编程练习

    环境配置 一般使用Visual Studio2019来作为openmp的编程环境 调试-->属性-->C/C++-->所有选项-->Openmp支持改为 是(可以使用下拉菜单) ...

  3. 货物移动BAPI：BAPI_GOODSMVT_CREATE报错提示“不能执行功能模块 MB_CREATE_GOODS_MOVEMENT”的原因

    在开发过程中,我们调用BAPI:BAPI_GOODSMVT_CREATE进行货物移动生成物料凭证时,出现了报错提示:“不能执行功能模块 MB_CREATE_GOODS_MOVEMENT”,如下图所示: ...

  4. UiPath之如何打印PDF

    各位小伙伴,大家好,今天写一点基础知识,如何在UiPath中打印PDF. ---小U的QQ群(714733686):小U的订阅号[UiPath8888]--- 当然,我们最希望的就是有一个Activi ...

  5. Opencv python（3）| cv. VideoCapture.get() 参数介绍

    cv2.VideoCapture.get ()  的 (0-18)参数 cv2.VideoCapture.get(0)            视频文件的当前位置(播放)以毫秒为单位 cv2.Video ...

  6. MySQL-配置环境变量及修改密码（附-mysql安装教程）

    MySQL-配置环境变量和修改密码 mysql的安装教程:链接:https://pan.baidu.com/s/1rrPT2X0yRF58kN8jZZx-Mg 密码:55dh 一. 闪退问题 1.1. ...

  7. Okhttp3源码解析

    首先是Okhttp的使用: //缓存文件夹 File cacheFile = new File(getExternalCacheDir().toString(), "cache") ...

  8. hash值生成表后缀（分表方案）

    //businessId分表目标值,tableSize:表数量,tableSuffix:表后缀 public static String getTableSuffix(String businessI ...

  9. Spring Security登录验证流程源码解析

    一.登录认证基于过滤器链 Spring Security的登录验证流程核心就是过滤器链.当一个请求到达时按照过滤器链的顺序依次进行处理,通过所有过滤器链的验证,就可以访问API接口了. SpringS ...

  10. 区块链轻松上手：原理、源码、搭建与应用pdf电子版下载

    区块链轻松上手:原理.源码.搭建与应用pdf电子版下载 链接:https://pan.baidu.com/s/1rKF4U9wq612RMIChs0zv8w提取码:hquz <区块链轻松上手:原 ...