扩展插件(分页插件)
该教程在Spring Boot整合Mybatis 基础上改造操作
1介绍
如果要想在Mybatis中实现分页功能,传统的方式,需要入侵式的修改原sql中的语句,增加limit来分页,增加获取数据总数的查询。
因此想非入侵式的实现分页功能,可使用第三方PageHelper分页插件
原理:在MyBatis中配置了分页拦截器(PageInterceptor),就是在执行相关的Sql之前会做一些拦截的操作,这里通过调用startPage的方法,其实就是在查询getOrderInfoList之前会自动加上limit;这里通过setLocalPage方法,将分页信息保存在当前之后线程当中,查询方法与之处于同一个线程,共享ThreadLocal当中的数据,最后将getOrderInfoList查询好的数据结果放到PageInfo当中即可。
官网尽量看下,第一手资料都是非常重要的
版本要求
详细请查看官网
2.导入坐标
按Spring Boot版本来导入,需在Mybatis导入的情况下使用。真实使用时,PageHelper高于官网所要求也能使用,但最好按官网要求使用对应版本
<!--Mybatis分页插件-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.13</version>
</dependency>
3.配置
在Spring boot配置文件中(application.yml),配置分页插件的信息
#分页插件
pagehelper:
#指明数据库
helper-dialect: mysql
params: count=countSql
#为true pageNum<=0 时会查询第一页, pageNum>pages(超过总数时),会查询最后一页
reasonable: true
supportMethodsArguments: true
4.使用
改造之前的Service
package com.example.demo.service;
import com.example.demo.model.UserEntity;
import com.github.pagehelper.PageInfo;
public interface UserService {
PageInfo<UserEntity> getAll(int pageNum, int pageSize);
}
package com.example.demo.service.impl;
import com.example.demo.mapper.UserMapper;
import com.example.demo.model.UserEntity;
import com.example.demo.service.UserService;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class UserServiceImpl implements UserService {
private final UserMapper userMapper;
public UserServiceImpl(UserMapper userMapper) {
this.userMapper = userMapper;
}
@Override
public PageInfo<UserEntity> getAll(int pageNum, int pageSize) {
//获取第pageNum页,pageSize条内容,默认查询总数count
PageHelper.startPage(pageNum, pageSize);
紧跟着的第一个select方法会被分页
List<UserEntity> list = userMapper.getAll();
//用PageInfo对结果进行包装
return new PageInfo<>(list);
}
}
5.注意
6.测试
package com.example.demo;
import com.example.demo.model.UserEntity;
import com.example.demo.service.UserService;
import com.github.pagehelper.PageInfo;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import javax.annotation.Resource;
@SpringBootTest
class DemoApplicationTests {
@Resource
private UserService userService;
@Test
public void test() {
PageInfo<UserEntity> list = userService.getAll(1, 10);
System.out.println(list);
}
}
输出结果
PageInfo返回数据:
pageNum:当前页的页码
pageSize:每页显示的条数
size:当前页显示的真实条数
total:总记录数
pages:总页数
prePage:上一页的页码
nextPage:下一页的页码
isFirstPage/isLastPage:是否为第一页/最后一页
hasPreviousPage/hasNextPage:是否存在上一页/下一页
navigatePages:导航分页的页码数
navigatepageNums:导航分页的页码,[1,2,3,4,5]