SpringBoot集成MyBatis的分页插件PageHelper实例代码

昨天给各位总结了本人学习springboot整合mybatis第一阶段的一些学习心得和源码，主要就算是敲了一下springboot的门儿，希望能给各位的入门带给一点儿捷径，今天给各位温习一下mybatis的分页插件pagehelper和springboot的集成，它的使用也非常简单，开发更为高效。因为pagehelper插件是属于mybatis框架的，所以相信很多哥们儿都已经用烂了，下面带着各位吃一下回头草。

       首先说说mybatis框架的pagehelper插件吧，它是一个非常好用的分页插件，通常我们的项目中如果集成了mybatis的话，几乎都会用到它，因为分页的业务逻辑说复杂也不复杂，但是有插件我们何乐而不为？通常引入它们只需三步骤，不管是spring集成还是springboot集成都是老套路，我就分开总结了，望各位笑纳。

spring集成pagehelper：

第一步：pom文件引入依赖

<!-- mybatis的分页插件 -->
 <dependency>
   <groupid>com.github.pagehelper</groupid>
   <artifactid>pagehelper</artifactid>
 </dependency>

第二步：mybatis的核心配置文件中引入配置项

<?xml version="1.0" encoding="utf-8"?>
<!doctype configuration
public "-//mybatis.org//dtd config 3.0//en"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <!-- 【mybatis的核心配置文件】 -->
  <!-- 批量设置别名(可以不配) 作用：就是在mapper.xml文件中直接写类名，也可以不用写全路径名。 -->
  <typealiases>
    <package name="cn.e3mall.manager.po" />
  </typealiases>
  <!-- 配置mybatis的分页插件pagehelper -->
  <plugins>
    <!-- com.github.pagehelper为pagehelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.pagehelper">
      <!-- 设置数据库类型oracle,mysql,mariadb,sqlite,hsqldb,postgresql六种数据库 -->
      <property name="dialect" value="mysql"/>
    </plugin>
  </plugins>
</configuration>

第三步：业务逻辑实现分页功能，我们只需将当前查询的页数page和每页显示的总条数rows传进去，然后pagehelper已经帮我们分好数据了，只需在web层获取数据即可。

//分页查询商品列表：
  @override
  public datagridresult itemlist(integer page, integer rows) {
    //为了程序的严谨性，判断非空：
    if(page == null){
      page = 1;  //设置默认当前页
    }
    if(page <= 0){
      page = 1;
    }
    if(rows == null){
      rows = 30;  //设置默认每页显示的商品数(因为jsp页面上默认写的就是30条)
    }
    //1、设置分页信息，包括当前页数和每页显示的总计数
    pagehelper.startpage(page, rows);
    //2、执行查询
    tbitemexample example = new tbitemexample();
    list<tbitem> list = tbitemmapper.selectbyexample(example);
    //3、获取分页查询后的数据
    pageinfo<tbitem> pageinfo = new pageinfo<>(list);
    //4、封装需要返回的分页实体
    datagridresult result = new datagridresult();
    //设置获取到的总记录数total：
    result.settotal(pageinfo.gettotal());
    //设置数据集合rows：
    result.setrows(list);
    return result;
  }

springboot集成pagehelper：

第一步：pom文件还是需要引入依赖

<dependency>
   <groupid>com.github.pagehelper</groupid>
   <artifactid>pagehelper</artifactid>
   <version>4.1.6</version>
 </dependency>

第二步：这次直接是在项目的入口类application.java中直接设置pagehelper插件即可

//配置mybatis的分页插件pagehelper
  @bean
  public pagehelper pagehelper(){
    pagehelper pagehelper = new pagehelper();
    properties properties = new properties();
    properties.setproperty("offsetaspagenum","true");
    properties.setproperty("rowboundswithcount","true");
    properties.setproperty("reasonable","true");
    properties.setproperty("dialect","mysql");  //配置mysql数据库的方言
    pagehelper.setproperties(properties);
    return pagehelper;
  }

第三步：同理，使用插件实现分页功能，方式还是一样，只需将当前查询的页数和每页显示的条数穿进去即可，直接源码

这是需要用到的分页实体，各位可以直接享用。

package com.zxz.utils;
/**
 * 分页bean
 */
import java.util.list;
public class pagebean<t> {
  // 当前页
  private integer currentpage = 1;
  // 每页显示的总条数
  private integer pagesize = 10;
  // 总条数
  private integer totalnum;
  // 是否有下一页
  private integer ismore;
  // 总页数
  private integer totalpage;
  // 开始索引
  private integer startindex;
  // 分页结果
  private list<t> items;
  public pagebean() {
    super();
  }
  public pagebean(integer currentpage, integer pagesize, integer totalnum) {
    super();
    this.currentpage = currentpage;
    this.pagesize = pagesize;
    this.totalnum = totalnum;
    this.totalpage = (this.totalnum+this.pagesize-1)/this.pagesize;
    this.startindex = (this.currentpage-1)*this.pagesize;
    this.ismore = this.currentpage >= this.totalpage?0:1;
  }
  public integer getcurrentpage() {
    return currentpage;
  }
  public void setcurrentpage(integer currentpage) {
    this.currentpage = currentpage;
  }
  public integer getpagesize() {
    return pagesize;
  }
  public void setpagesize(integer pagesize) {
    this.pagesize = pagesize;
  }
  public integer gettotalnum() {
    return totalnum;
  }
  public void settotalnum(integer totalnum) {
    this.totalnum = totalnum;
  }
  public integer getismore() {
    return ismore;
  }
  public void setismore(integer ismore) {
    this.ismore = ismore;
  }
  public integer gettotalpage() {
    return totalpage;
  }
  public void settotalpage(integer totalpage) {
    this.totalpage = totalpage;
  }
  public integer getstartindex() {
    return startindex;
  }
  public void setstartindex(integer startindex) {
    this.startindex = startindex;
  }
  public list<t> getitems() {
    return items;
  }
  public void setitems(list<t> items) {
    this.items = items;
  }
}

分页功能源码(web层和service层)。

@override
  public list<item> finditembypage(int currentpage,int pagesize) {
    //设置分页信息，分别是当前页数和每页显示的总记录数【记住：必须在mapper接口中的方法执行之前设置该分页信息】
    pagehelper.startpage(currentpage, pagesize);
    list<item> allitems = itemmapper.findall();    //全部商品
    int countnums = itemmapper.countitem();      //总记录数
    pagebean<item> pagedata = new pagebean<>(currentpage, pagesize, countnums);
    pagedata.setitems(allitems);
    return pagedata.getitems();
  }
/**
   * 商品分页功能(集成mybatis的分页插件pagehelper实现)
   * 
   * @param currentpage  :当前页数
   * @param pagesize    :每页显示的总记录数
   * @return
   */
  @requestmapping("/itemspage")
  @responsebody
  public list<item> itemspage(int currentpage,int pagesize){
    return itemservice.finditembypage(currentpage, pagesize);
  }

到这儿呢，mybatis的分页插件pagehelper就完全和springboot集成到一起了，确实没有什么新鲜的，标题有个"回头草"就是这个意思，重点和各位复习一下mybatis的分页插件的运用，好久没用了正好一块总结一下哈。