【第29章】MyBatis-Plus之分页插件

---

媒介

MyBatis-Plus 的分页插件 PaginationInnerInterceptor 提供了强大的分页功能，支持多种数据库，使得分页查询变得简单高效。

---

一、支持的数据库

PaginationInnerInterceptor 支持广泛的数据库，包括但不限于：

如果你需要支持的数据库不在列表中，可以通过 Pull Request 哀求添加。
覆盖范围很广，已经支持了众多国产数据库。
二、配置方法

在 Spring Boot 项目中，你可以通过 Java 配置来添加分页插件：

1. @Configuration
2. @MapperScan("scan.your.mapper.package")
3. public class MybatisPlusConfig {
5.     /**
6.      * 添加分页插件
7.      */
8.     @Bean
9.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
10.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
11.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); // 如果配置多个插件, 切记分页最后添加
12.         // 如果有多数据源可以不配具体类型, 否则都建议配上具体的 DbType
13.         return interceptor;
14.     }
15. }

复制代码

三、属性介绍

PaginationInnerInterceptor 提供了以下属性来定制分页活动：
属性名类型默认值描述overflowbooleanfalse溢出总页数后是否进行处理maxLimitLong单页分页条数限定dbTypeDbType数据库类型dialectIDialect方言实现类   发起单一数据库类型的均设置 dbType
  四、自界说 Mapper 方法中使用分页

你可以通过以下方式在 Mapper 方法中使用分页：

1. IPage<UserVo> selectPageVo(IPage<?> page, Integer state);
2. // 或者自定义分页类
3. MyPage selectPageVo(MyPage page);
4. // 或者返回 List
5. List<UserVo> selectPageVo(IPage<UserVo> page, Integer state);

复制代码

对应的 XML 配置：

1. <select id="selectPageVo" resultType="xxx.xxx.xxx.UserVo">
2.     SELECT id,name FROM user WHERE state=#{state}
3. </select>

复制代码

  如果返回类型是 IPage，则入参的 IPage 不能为 null。如果想暂时不分页，可以在初始化 IPage 时 size 参数传入小于 0 的值。 如果返回类型是 List，则入参的 IPage 可以为 null，但需要手动设置入参的 IPage.setRecords(返回的 List)。 如果 XML 需要从 page 里取值，需要使用 page.属性 获取。
  五、其他注意事项

• 天生 countSql 时，如果 left join 的表不参与 where 条件，会将其优化掉。发起在任何带有 left join 的 SQL 中，都给表和字段加上别名。
  
• 在使用多个插件时，请将分页插件放到插件执行链的最后面，以制止 COUNT SQL 执行不准确的题目。
  

六、Page 类

Page 类继承了 IPage 类，实现了简单分页模型。如果你需要实现自己的分页模型，可以继承 Page 类或实现 IPage 类。
属性名类型默认值描述recordsListemptyList查询数据列表totalLong0查询列表总记录数sizeLong10每页表现条数，默认 10currentLong1当前页ordersListemptyList排序字段信息optimizeCountSqlbooleantrue主动优化 COUNT SQLoptimizeJoinOfCountSqlbooleantrue主动优化 COUNT SQL 是否把 join 查询部门移除searchCountbooleantrue是否进行 count 查询maxLimitLong单页分页条数限定countIdStringXML 自界说 count 查询的 statementId

---

七、实战

1. 配置类

1. package org.example.springboot3.mybatisplus.config;
3. import com.baomidou.mybatisplus.annotation.DbType;
4. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
5. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
6. import org.springframework.context.annotation.Bean;
7. import org.springframework.context.annotation.Configuration;
9. /**
10. * Create by zjg on 2024/7/7
11. */
12. @Configuration
13. public class MybatisPlusConfig {
15.     /**
16.      * 添加分页插件
17.      */
18.     @Bean
19.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
20.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
21.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); // 如果配置多个插件, 切记分页最后添加
22.         // 如果有多数据源可以不配具体类型, 否则都建议配上具体的 DbType
23.         return interceptor;
24.     }
25. }

复制代码

2. 分页类

1. package org.example.springboot3.mybatisplus.controller;
3. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
4. import com.baomidou.mybatisplus.core.metadata.IPage;
5. import com.baomidou.mybatisplus.core.toolkit.Wrappers;
6. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
7. import org.example.springboot3.bigevent.entity.Result;
8. import org.example.springboot3.mybatisplus.model.User;
9. import org.example.springboot3.mybatisplus.service.UserService;
10. import org.springframework.beans.factory.annotation.Autowired;
11. import org.springframework.util.StringUtils;
12. import org.springframework.web.bind.annotation.GetMapping;
13. import org.springframework.web.bind.annotation.RequestMapping;
14. import org.springframework.web.bind.annotation.RequestParam;
15. import org.springframework.web.bind.annotation.RestController;
16. import java.util.List;
18. /**
19. * Create by zjg on 2024/7/7
20. */
21. @RestController
22. @RequestMapping("/page/")
23. public class PageController {
24.     @Autowired
25.     UserService userService;
26.     @GetMapping
27.     Result<List<User>> page(@RequestParam Integer pageNum,@RequestParam Integer pageSize, String name) {
28.         // 假设有一个 QueryWrapper 对象，进行有条件的分页查询
29.         IPage<User> page = new Page<>(pageNum, pageSize);
30.         LambdaQueryWrapper<User> queryWrapper = Wrappers.lambdaQuery(User.class);
31.         if(StringUtils.hasLength(name)){
32.             queryWrapper.eq(User::getName, name);
33.         }
34.         IPage<User> userPage = userService.page(page, queryWrapper); // 调用 page 方法
35.         List<User> userList = userPage.getRecords();
36.         long total = userPage.getTotal();
37.         System.out.println("Total users: " + total);
38.         return Result.success("请求成功",userList);
39.     }
40. }

复制代码

3. 测试

总结

回到顶部
   通过这些配置和使用方法，你可以轻松地在 MyBatis-Plus 中实现分页查询，提高应用的性能和用户体验。
更多插件内容请访问官网

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。