1. 项目概述
在Web应用开发中,分页查询是最基础也最常用的功能之一。最近接手一个后台管理系统项目时,我发现很多新人对SpringBoot整合Mybatis-Plus实现分页存在不少困惑。本文将分享我在电商平台开发中总结的分页实现方案,从配置到实战完整走一遍流程。
这个方案的特点是:
- 零XML配置,完全注解驱动
- 支持前端多种分页参数格式
- 自动处理count查询优化
- 整合Swagger文档展示
2. 环境准备与基础配置
2.1 依赖引入
首先在pom.xml中添加必要依赖(以SpringBoot 2.7.x为例):
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.2</version> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-extension</artifactId> <version>3.5.2</version> </dependency>注意:避免同时引入mybatis和mybatis-plus的starter,可能引起冲突
2.2 分页插件配置
在SpringBoot启动类或配置类中添加:
@Configuration public class MybatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); // 分页插件 interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } }这里有几个关键点:
- DbType需根据实际数据库类型设置
- 可以配置maxLimit防止全表查询
- 支持多租户等其它插件组合使用
3. 核心实现方案
3.1 基础分页查询
假设有用户表user,对应的Mapper接口:
public interface UserMapper extends BaseMapper<User> { // 无需额外方法 }Service层实现:
@Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { public Page<User> pageList(int current, int size) { Page<User> page = new Page<>(current, size); return baseMapper.selectPage(page, null); } }Controller示例:
@GetMapping("/users") public R<Page<User>> getUsers( @RequestParam(defaultValue = "1") int current, @RequestParam(defaultValue = "10") int size) { return R.success(userService.pageList(current, size)); }3.2 带条件的分页查询
实际项目更多需要组合查询条件:
public Page<User> pageQuery(UserQuery query) { LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>(); wrapper.eq(StringUtils.isNotBlank(query.getName()), User::getName, query.getName()) .ge(query.getStartTime() != null, User::getCreateTime, query.getStartTime()); return baseMapper.selectPage(new Page<>(query.getCurrent(), query.getSize()), wrapper); }3.3 自定义分页SQL
对于复杂SQL,可以在Mapper中定义:
@Select("SELECT * FROM user ${ew.customSqlSegment}") Page<User> customPage(Page<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);4. 高级功能实现
4.1 分页参数自动转换
创建PageParam类统一接收参数:
@Data public class PageParam { @ApiModelProperty(value = "页码", example = "1") private long current = 1; @ApiModelProperty(value = "每页数量", example = "10") private long size = 10; @ApiModelProperty("排序字段") private String orderBy; @ApiModelProperty("是否升序") private Boolean isAsc; public <T> Page<T> buildPage() { Page<T> page = new Page<>(current, size); if (StringUtils.isNotBlank(orderBy)) { if (Boolean.TRUE.equals(isAsc)) { page.addOrder(OrderItem.asc(orderBy)); } else { page.addOrder(OrderItem.desc(orderBy)); } } return page; } }4.2 分页结果统一包装
建议统一返回格式:
@Data public class PageResult<T> implements Serializable { private long current; private long size; private long total; private List<T> records; public static <T> PageResult<T> success(Page<T> page) { PageResult<T> result = new PageResult<>(); result.setCurrent(page.getCurrent()); result.setSize(page.getSize()); result.setTotal(page.getTotal()); result.setRecords(page.getRecords()); return result; } }5. 性能优化技巧
5.1 Count查询优化
大数据量表count操作很耗性能,可以通过以下方式优化:
- 使用缓存count结果
- 不查询count(设置page.setSearchCount(false))
- 覆盖默认的countSql:
@Select("SELECT COUNT(1) FROM user ${ew.customSqlSegment}") Long selectCountCustom(@Param(Constants.WRAPPER) Wrapper<User> wrapper);5.2 多表联查分页
推荐两种方案:
- 先分页主表ID,再联查明细
- 使用子查询分页:
SELECT * FROM order o WHERE o.id IN ( SELECT id FROM order WHERE user_id = #{userId} LIMIT #{offset}, #{size} )6. 常见问题排查
6.1 分页失效问题
可能原因:
- 未配置分页插件
- 方法参数没有Page对象
- 自定义SQL未保留${ew.customSqlSegment}
6.2 排序不生效
检查点:
- 字段名是否正确(数据库字段名)
- 是否被后续wrapper条件覆盖
- PageParam中的orderBy是否传递到Page对象
6.3 性能问题
优化方向:
- 检查是否走了正确的索引
- 大数据量考虑游标分页
- 合理设置pageSize(建议不超过1000)
7. 最佳实践建议
- 统一分页参数接收格式
- 限制最大pageSize(可在拦截器配置)
- 重要查询添加分页审计日志
- 前端配合实现优雅的滚动加载
- 导出功能单独处理(不分页)
实际项目中,我们还会结合Redis缓存热点数据的分页结果,对订单历史等查询采用时间分区等方式优化。Mybatis-Plus的分页功能虽然简单,但用好需要结合具体业务场景做适当调整。