MyBatis —— 13、分页插件

目录

1、分页插件的使用步骤

1.1、添加插件

1.2、配置分页插件

2、分页插件的使用

2.1、在查询功能之前使用 PageHelper.startPage(int pageNum, int pageSize) 开启分页功能

2.2、获取分页的相关数据

2.2.1、通过 PageHelper.startPage(int pageNum, int pageSize) 获取对应对象并输出

2.2.2、通过获取 PageInfo 对象

---

1、分页插件的使用步骤

1.1、添加插件

<!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper -->
<dependency>
	<groupId>com.github.pagehelper</groupId>
	<artifactId>pagehelper</artifactId>
	<version>5.2.0</version>
</dependency>

1.2、配置分页插件

• 在MyBatis的核心配置文件（mybatis-config.xml）中配置插件，注意位置在 typeAliases 和 

<plugins>
	<!--设置分页插件-->
	<plugin interceptor="com.github.pagehelper.PageInterceptor"></plugin>
</plugins>

2、分页插件的使用

2.1、在查询功能之前使用 PageHelper.startPage(int pageNum, int pageSize) 开启分页功能

① 测试方法：

    @Test
    public void testPageHelper(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession = sqlSessionFactory.openSession(true);
            EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);

            PageHelper.startPage(1, 4);

            List<Emp> emps = mapper.selectByExample(null);
            emps.forEach(emp -> System.out.println(emp));

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

② 输出结果：

DEBUG 03-19 22:36:55,460 Cache Hit Ratio [SQL_CACHE]: 0.0 (LoggingCache.java:60) 
DEBUG 03-19 22:36:55,533 ==>  Preparing: SELECT count(0) FROM t_emp (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:36:55,586 ==> Parameters:  (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:36:55,610 <==      Total: 1 (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:36:55,612 ==>  Preparing: select eid, emp_name, age, sex, email, did from t_emp LIMIT ? (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:36:55,613 ==> Parameters: 4(Integer) (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:36:55,616 <==      Total: 4 (BaseJdbcLogger.java:137) 
Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}
Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}
Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}
Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}

2.2、获取分页的相关数据

• 常用数据：

  • pageNum：当前页的页码

  • pageSize：每页显示的条数

  • size：当前页显示的真实条数

  • total：总记录数

  • pages：总页数

  • prePage：上一页的页码

  • nextPage：下一页的页码

  • isFirstPage/isLastPage：是否为第一页/最后一页

  • hasPreviousPage/hasNextPage：是否存在上一页/下一页

  • navigatePages：导航分页的页码数

  • navigatepageNums：导航分页的页码，[1,2,3,4,5]

2.2.1、通过 PageHelper.startPage(int pageNum, int pageSize) 获取对应对象并输出

① 测试方法：

    @Test
    public void testPageHelper(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession = sqlSessionFactory.openSession(true);
            EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);

            Page<Object> page = PageHelper.startPage(1, 4);

            List<Emp> emps = mapper.selectByExample(null);
            emps.forEach(emp -> System.out.println(emp));

            //System.out.println(page);
            //Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=5, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}, Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}, Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}]


        } catch (IOException e) {
            e.printStackTrace();
        }
    }

② 出结果：

DEBUG 03-19 22:40:09,879 Cache Hit Ratio [SQL_CACHE]: 0.0 (LoggingCache.java:60) 
DEBUG 03-19 22:40:09,938 ==>  Preparing: SELECT count(0) FROM t_emp (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:40:09,972 ==> Parameters:  (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:40:09,999 <==      Total: 1 (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:40:10,002 ==>  Preparing: select eid, emp_name, age, sex, email, did from t_emp LIMIT ? (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:40:10,003 ==> Parameters: 4(Integer) (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:40:10,005 <==      Total: 4 (BaseJdbcLogger.java:137) 
Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}
Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}
Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}
Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}
Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=5, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}, Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}, Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}]

进程已结束，退出代码为 0

page 的相关数据：

Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=5, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}, Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}, Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}]

2.2.2、通过获取 PageInfo 对象

• 在查询获取list集合之后，使用PageInfo<T> pageInfo = new PageInfo<>(List<T> list, intnavigatePages)获取分页相关数据

  • list：分页之后的数据

  • navigatePages：导航分页的页码数

① 测试方法：

    @Test
    public void testPageHelper(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession = sqlSessionFactory.openSession(true);
            EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);

            PageHelper.startPage(1, 4);

            List<Emp> emps = mapper.selectByExample(null);
            emps.forEach(emp -> System.out.println(emp));

            PageInfo<Emp> pageInfo = new PageInfo<>(emps, 5);
            System.out.println(pageInfo);
            //PageInfo{pageNum=1, pageSize=4, size=4, startRow=1, endRow=4, total=5, pages=2, list=Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=5, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}, Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}, Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}], prePage=0, nextPage=2, isFirstPage=true, isLastPage=false, hasPreviousPage=false, hasNextPage=true, navigatePages=5, navigateFirstPage=1, navigateLastPage=2, navigatepageNums=[1, 2]}

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

② 输出结果

DEBUG 03-19 22:42:46,529 Cache Hit Ratio [SQL_CACHE]: 0.0 (LoggingCache.java:60) 
DEBUG 03-19 22:42:46,587 ==>  Preparing: SELECT count(0) FROM t_emp (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:42:46,622 ==> Parameters:  (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:42:46,646 <==      Total: 1 (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:42:46,649 ==>  Preparing: select eid, emp_name, age, sex, email, did from t_emp LIMIT ? (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:42:46,649 ==> Parameters: 4(Integer) (BaseJdbcLogger.java:137) 
DEBUG 03-19 22:42:46,652 <==      Total: 4 (BaseJdbcLogger.java:137) 
Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}
Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}
Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}
Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}
PageInfo{pageNum=1, pageSize=4, size=4, startRow=1, endRow=4, total=5, pages=2, list=Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=5, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}, Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}, Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}], prePage=0, nextPage=2, isFirstPage=true, isLastPage=false, hasPreviousPage=false, hasNextPage=true, navigatePages=5, navigateFirstPage=1, navigateLastPage=2, navigatepageNums=[1, 2]}

进程已结束，退出代码为 0

PageInfo 相关数据：（注：原输出没有换行，这里换行是为了将 list 与其他数据分隔，其中 list 就是上面 page 的内容）

PageInfo{pageNum=1, pageSize=4, size=4, startRow=1, endRow=4, total=5, pages=2,
list=Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=5, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='null', email='456@qq.com', did=3}, Emp{eid=2, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=16, sex='女', email='wangwu@qq.com', did=3}, Emp{eid=4, empName='赵六', age=37, sex='男', email='zhaoliu@qq.com', did=1}], 
prePage=0, nextPage=2, isFirstPage=true, isLastPage=false, hasPreviousPage=false, hasNextPage=true, navigatePages=5, navigateFirstPage=1, navigateLastPage=2, navigatepageNums=[1, 2]}