当前位置：首页 > news >正文

MyBatis-Plus 分页功能详解

news 来源：原创 2025/4/21 8:04:52

MyBatis-Plus 分页功能详解

1. 前言

MyBatis-Plus 是 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，简化开发、提高效率。其中分页功能是日常开发中非常常用的功能，本文将详细介绍 MyBatis-Plus 的分页功能使用。

2. 配置分页插件

首先需要在 Spring Boot 项目中配置分页插件：

@Configuration
public class MybatisPlusConfig {/*** 分页插件配置*/@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));return interceptor;}
}

3. 基本分页查询

3.1 使用 Page 对象

@GetMapping("/page")
public R<IPage<User>> page(@RequestParam(defaultValue = "1") int current, @RequestParam(defaultValue = "10") int size) {// 创建分页对象Page<User> page = new Page<>(current, size);// 执行分页查询IPage<User> userPage = userService.page(page);return R.ok(userPage);
}

3.2 带条件的分页查询

@GetMapping("/pageByCondition")
public R<IPage<User>> pageByCondition(@RequestParam(defaultValue = "1") int current,@RequestParam(defaultValue = "10") int size,String name) {Page<User> page = new Page<>(current, size);LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();wrapper.like(StringUtils.isNotBlank(name), User::getName, name);IPage<User> userPage = userService.page(page, wrapper);return R.ok(userPage);
}

4. 自定义SQL分页

4.1 Mapper 接口

public interface UserMapper extends BaseMapper<User> {/*** 自定义分页查询* @param page 分页对象* @param state 状态* @return 分页结果*/IPage<User> selectPageByCustom(@Param("page") Page<User> page, @Param("state") Integer state);
}

4.2 XML 映射文件

<select id="selectPageByCustom" resultType="com.example.entity.User">SELECT * FROM user WHERE state = #{state}
</select>

4.3 使用自定义分页

@GetMapping("/customPage")
public R<IPage<User>> customPage(@RequestParam(defaultValue = "1") int current,@RequestParam(defaultValue = "10") int size,Integer state) {Page<User> page = new Page<>(current, size);IPage<User> userPage = userMapper.selectPageByCustom(page, state);return R.ok(userPage);
}

5. 分页结果处理

MyBatis-Plus 的分页结果 IPage 对象包含以下常用属性：

records: 当前页的数据列表
total: 总记录数
size: 每页显示条数
current: 当前页
pages: 总页数

可以对这些数据进行处理后再返回给前端：

@GetMapping("/pageWithProcess")
public R<Map<String, Object>> pageWithProcess(@RequestParam(defaultValue = "1") int current,@RequestParam(defaultValue = "10") int size) {Page<User> page = new Page<>(current, size);IPage<User> userPage = userService.page(page);Map<String, Object> result = new HashMap<>();result.put("list", userPage.getRecords());result.put("total", userPage.getTotal());result.put("pageSize", userPage.getSize());result.put("currentPage", userPage.getCurrent());result.put("totalPages", userPage.getPages());return R.ok(result);
}

6. 分页优化

6.1 不查询总记录数

对于大数据量的分页，如果不需要知道总记录数，可以设置不查询 count:

@GetMapping("/pageWithoutCount")
public R<IPage<User>> pageWithoutCount(@RequestParam(defaultValue = "1") int current,@RequestParam(defaultValue = "10") int size) {Page<User> page = new Page<>(current, size, false);IPage<User> userPage = userService.page(page);return R.ok(userPage);
}

6.2 最大单页限制

可以配置分页插件的最大单页限制：

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);// 设置最大单页限制数量，默认 500 条，-1 不受限制paginationInnerInterceptor.setMaxLimit(1000L);interceptor.addInnerInterceptor(paginationInnerInterceptor);return interceptor;
}