【Mybatis从入门到实战教程】第八章 Mybatis PageHelper分页插件
八、Mybatis PageHelper分页插件
8.1 导入分页插件jar包
方式一：导入jar包
方式二：配置maven依赖
com.github.pagehelper pagehelper 5.1.108.2 配置分页插件
8.2.1 在MyBatis全局配置文件中配置拦截器插件
8.2.2 配置插件属性
| 属性名称 | 默认值 | 描述 |
|---|---|---|
| helperDialect | 分页插件会自动检测当前的数据库链接，自动选择合适的分页方式你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby | |
| offsetAsPageNum | false | 该参数对使用 RowBounds作为分页参数时有效当该参数设置为 true时，会将 RowBounds中的 offset参数当成 pageNum使用，可以用页码和页面大小两个参数进行分页 |
| rowBoundsWithCount | false | 该参数对使用 RowBounds作为分页参数时有效当该参数设置为true时，使用 RowBounds分页会进行 count查询 |
| pageSizeZero | false | 当该参数设置为 true时，如果 pageSize=0 或者 RowBounds.limit=0 就会查询出全部的结果，相当于没有执行分页查询，但是返回结果仍然是 Page类型 |
| reasonable | false | 分页合理化参数启用合理化时，如果pageNumpages会查询最后一页禁用合理化时，如果pageNumpages会返回空数据 |
| params | pageNum=pageNum; pageSize=pageSize; count=countSql; reasonable=reasonable; pageSizeZero=pageSizeZero | 为了支持startPage(Object params)方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默认值 |
| supportMethodsArguments | false | 支持通过 Mapper接口参数来传递分页参数分页插件会从查询方法的参数值中，自动根据上面 params配置的字段中取值，查找到合适的值时就会自动分页 |
| autoRuntimeDialect | false | 设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页 |
| closeConn | true | 当使用运行时动态数据源或没有设置 helperDialect属性自动获取数据库类型时，会自动获取一个数据库连接， 通过该属性来设置是否关闭获取的这个连接，默认true关闭，设置为 false后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定 |
8.3 在程序中的使用
8.3.1 实体类
public class Emp { private Integer empno; private String ename; private String job; private Integer mgr; private Date hiredate; private Double sal; private Double comm; private Integer deptno; public Integer getEmpno() { return empno; } public void setEmpno(Integer empno) { this.empno = empno; } public String getEname() { return ename; } public void setEname(String ename) { this.ename = ename; } public String getJob() { return job; } public void setJob(String job) { this.job = job; } public Integer getMgr() { return mgr; } public void setMgr(Integer mgr) { this.mgr = mgr; } public Date getHiredate() { return hiredate; } public void setHiredate(Date hiredate) { this.hiredate = hiredate; } public Double getSal() { return sal; } public void setSal(Double sal) { this.sal = sal; } public Double getComm() { return comm; } public void setComm(Double comm) { this.comm = comm; } public Integer getDeptno() { return deptno; } public void setDeptno(Integer deptno) { this.deptno = deptno; } @Override public String toString() { return "Emp{" + "empno=" + empno + ", ename='" + ename + '\'' + ", job='" + job + '\'' + ", mgr=" + mgr + ", hiredate=" + hiredate + ", sal=" + sal + ", comm=" + comm + ", deptno=" + deptno + '}'; }}8.3.2 mapper接口
public interface EmpMapper { List selectByPage();}8.3.3 mapper文件
select empno,ename,job,mgr,hiredate,sal,comm,deptno from emp order by empno 8.3.4 测试
public class PageHelperTest { @Test public void testPageHelper() { SqlSession sqlSession = MybatisUtil.getSession(); EmpMapper empMapper = sqlSession.getMapper(EmpMapper.class); //开启分页拦截器，设置分页的基本属性（当前页面数，每页条数） PageHelper.startPage(1, 5); List empList = empMapper.selectByPage(); for (Emp emp : empList) { System.out.println(emp); } //分页信息对象 PageInfo pageInfo = new PageInfo(empList); System.out.println("当前页数：" + pageInfo.getPageNum()); System.out.println("每页条数：" + pageInfo.getPageSize()); System.out.println("总记录数：" + pageInfo.getTotal()); System.out.println("总页数：" + pageInfo.getPages()); System.out.println("上一页：" + pageInfo.getPrePage()); System.out.println("下一页：" + pageInfo.getNextPage()); System.out.println("是否有上一页：" + pageInfo.isHasPreviousPage()); System.out.println("是否有下一页：" + pageInfo.isHasNextPage()); System.out.println("是否为首页：" + pageInfo.isIsFirstPage()); System.out.println("是否为末页：" + pageInfo.isIsLastPage()); System.out.println("存放页码的数据：" + Arrays.toString(pageInfo.getNavigatepageNums())); System.out.println("获取当前页数据：" + pageInfo.getList()); sqlSession.close(); }}