mybatis分页插件的使用

1. 引入依赖包

XML 复制代码

<dependency>
	<groupId>com.github.pagehelper</groupId>
	<artifactId>pagehelper</artifactId>
	<version>6.1.0</version>
</dependency>

2 添加分页插件配置

2.1 使用配置类的方式（推荐）

java 复制代码

@Configuration
public class MyBatisConfig {
    @Bean
    PageInterceptor pageInterceptor(){
        // 1 创建分页插件 PageInterceptor 对象
        PageInterceptor pageInterceptor = new PageInterceptor();
        // 2 设置 参数配置
        Properties properties = new Properties();
        properties.setProperty("reasonable","true");// 分页合理化设置，输入页面超出范围，返回边界值结果
        pageInterceptor.setProperties(properties);
        return pageInterceptor;
    }
}

此处的分页合理化设置是为了防止前端传入不合理的页面无数据返回。

比如一共有10条数据，每页数据是5条，如果传入页面数值不合理，大于2或小于1，就无数据返回。

有了这个设置后，如果页面数值大于2则返回最后一页数据，小于1则返回第一页数据。

2.2 使用xml文件配置（不推荐）

XML 复制代码

<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <property name="helperDialect" value="mysql"/>
    </plugin>
</plugins>

3 分页插件使用

3.1 测试效果

java 复制代码

@Test
    void getAllEmpsPageInterceptor(){

        PageHelper.startPage(2,5);
        // 1. 紧跟着startPage 之后 的方法就会执行SQL分页
        List<Emp> allEmps = empPageInterceptorService.getAllEmps();
        // 2. 使用 PageInfo 包装返回的数据获取更多信息
        PageInfo<Emp> empPageInfo = new PageInfo<>(allEmps);
        //前端需要的数据
        // 当前第几页
        System.out.println(empPageInfo.getPageNum());
        // 总页码
        System.out.println(empPageInfo.getPages());
        //总记录
        System.out.println(empPageInfo.getTotal());
        //有没有下一页
        System.out.println(empPageInfo.isHasNextPage());
        // 有没有上一页
        System.out.println(empPageInfo.isHasPreviousPage());
        // 本页数据
        System.out.println(empPageInfo.getList());
    }

3.2 实战演示

实际编程中，分页插件的使用集中在controller层，service和mapper层正常查询，在controller层添加必要代码即可。

java 复制代码

@RestController
public class EmpController {
    @Autowired
    EmpPageInterceptorService empPageInterceptorService;

    @GetMapping("/emp/page") // http://localhost:8080/emp/page?pageNum=1&pageSize=2
    public PageInfo getPage(Integer pageNum, Integer pageSize){
        // 1. 执行分页
        PageHelper.startPage(pageNum,pageSize);
        List<Emp> allEmps = empPageInterceptorService.getAllEmps();
        // 2. 包装分页信息
        PageInfo<Object> info = new PageInfo<>(allEmps);
        return info;
    }
}