SpringBoot集成MyBatis的分页插件PageHelper

来源：http://www.cnblogs.com/1315925303zxz/p/7364552.html

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

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

Spring集成PageHelper：

第一步：pom文件引入依赖

1 <!-- mybatis的分页插件 -->2 <dependency>3     <groupId>com.github.pagehelper</groupId>4     <artifactId>pagehelper</artifactId>5 </dependency>

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

 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     <!-- 【mybatis的核心配置文件】 --> 8  9     <!-- 批量设置别名(可以不配) 作用：就是在mapper.xml文件中直接写类名，也可以不用写全路径名。 -->10     <typeAliases>11         <package name="cn.e3mall.manager.po" />12     </typeAliases>13 14     <!-- 配置mybatis的分页插件PageHelper -->15     <plugins>16         <!-- com.github.pagehelper为PageHelper类所在包名 -->17         <plugin interceptor="com.github.pagehelper.PageHelper">18             <!-- 设置数据库类型Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库 -->19             <property name="dialect" value="mysql"/>20         </plugin>21     </plugins>22 23 </configuration>

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

 1 //分页查询商品列表： 2     @Override 3     public DatagridResult itemList(Integer page, Integer rows) { 4         //为了程序的严谨性，判断非空： 5         if(page == null){ 6             page = 1;   //设置默认当前页 7         } 8         if(page <= 0){ 9             page = 1;10         }11         if(rows == null){12             rows = 30;    //设置默认每页显示的商品数(因为jsp页面上默认写的就是30条)13         }14         15         //1、设置分页信息，包括当前页数和每页显示的总计数16         PageHelper.startPage(page, rows);17         //2、执行查询18         TbItemExample example = new TbItemExample();19         List<TbItem> list = tbItemMapper.selectByExample(example);20         //3、获取分页查询后的数据21         PageInfo<TbItem> pageInfo = new PageInfo<>(list);22         //4、封装需要返回的分页实体23         DatagridResult result = new DatagridResult();24         //设置获取到的总记录数total：25         result.setTotal(pageInfo.getTotal());26         //设置数据集合rows：27         result.setRows(list);28         29         return result;30     }

 springboot集成PageHelper：

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

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

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

 1     //配置mybatis的分页插件pageHelper 2     @Bean 3     public PageHelper pageHelper(){ 4         PageHelper pageHelper = new PageHelper(); 5         Properties properties = new Properties(); 6         properties.setProperty("offsetAsPageNum","true"); 7         properties.setProperty("rowBoundsWithCount","true"); 8         properties.setProperty("reasonable","true"); 9         properties.setProperty("dialect","mysql");    //配置mysql数据库的方言10         pageHelper.setProperties(properties);11         return pageHelper;12     }

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

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

 View Code

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

 1     @Override 2     public List<Item> findItemByPage(int currentPage,int pageSize) { 3         //设置分页信息，分别是当前页数和每页显示的总记录数【记住：必须在mapper接口中的方法执行之前设置该分页信息】 4         PageHelper.startPage(currentPage, pageSize); 5          6         List<Item> allItems = itemMapper.findAll();        //全部商品 7         int countNums = itemMapper.countItem();            //总记录数 8         PageBean<Item> pageData = new PageBean<>(currentPage, pageSize, countNums); 9         pageData.setItems(allItems);10         return pageData.getItems();11     }

 View Code

 

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