mybatis-plus自定义mapper如何分页

<think>嗯，用户问的是MyBatis-Plus自定义Mapper如何分页。我需要先回忆一下MyBatis-Plus的分页机制。记得MyBatis-Plus有一个分页插件，通过配置后，可以使用其内置的Page对象来实现分页查询。但用户提到的是自定义Mapper的情况，可能需要结合XML或者注解方式写的SQL。 首先，用户可能已经知道MyBatis-Plus的常规分页方法，比如使用selectPage方法，但现在他们需要在自己的Mapper里写自定义SQL，这时候分页该怎么处理呢？ 步骤大概是这样的：首先确保分页插件已经正确配置。然后，在自定义的Mapper方法中，参数需要传入Page对象，并且SQL里不需要写LIMIT，因为分页插件会自动处理。同时，返回类型应该是Page，这样结果会被封装到Page对象里。 不过，可能用户会遇到的问题是，如何在XML中编写对应的SQL，并且确保分页插件生效。比如，在XML中，方法参数是Page，并且SQL正确的话，插件会自动添加分页语句。但需要确认是否在配置类中添加了分页拦截器，否则可能不生效。 另外，用户可能想知道返回的Page对象里有哪些有用的信息，比如总记录数、当前页数据等。或者是否有其他方式，比如使用IPage接口，或者自己手动处理分页参数。 还有可能用户在使用过程中，自定义的SQL比较复杂，比如多表联查，这时候分页插件是否能正确拦截，并改写SQL。可能需要提醒用户，如果SQL写法特殊，可能需要验证生成的SQL是否正确，是否有正确添加LIMIT和COUNT语句。 也有可能用户想了解，如果不想返回Page对象，而是返回普通的List，但同时又需要分页效果，这时候应该怎么处理。不过通常建议返回Page，以便获取分页信息。 总结下来，回答应该包括以下几个步骤：配置分页插件，自定义Mapper方法参数和返回类型，编写XML中的SQL，以及调用方法的方式。同时，要提醒常见的注意事项，比如插件配置是否正确，SQL是否正确，避免手动添加LIMIT等。</think>MyBatis-Plus 的自定义 Mapper 实现分页功能，需要结合其内置的分页插件和 `Page` 对象。以下是具体步骤和示例： --- ### 1. **配置分页插件** 在 Spring Boot 的配置类中添加分页插件拦截器（若未配置）： ```java @Configuration public class MyBatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); // 根据数据库类型选择 return interceptor; } } ``` --- ### 2. **自定义 Mapper 方法** 在自定义的 Mapper 接口中定义分页查询方法，参数为 `Page` 对象，返回值为 `IPage<T>`： ```java public interface UserMapper extends BaseMapper<User> { // 自定义分页查询 IPage<User> selectUserPage(Page<User> page, @Param("state") Integer state); } ``` --- ### 3. **编写 XML/SQL** 在对应的 XML 文件中编写 SQL，**无需手动添加 `LIMIT`**，分页插件会自动处理： ```xml <!-- UserMapper.xml --> <select id="selectUserPage" resultType="User"> SELECT * FROM user WHERE state = #{state} </select> ``` --- ### 4. **调用分页方法** 在 Service 或 Controller 中调用分页查询： ```java // 创建分页对象，参数：当前页、每页大小 Page<User> page = new Page<>(1, 10); // 调用自定义方法（假设查询 state=1 的用户） IPage<User> userPage = userMapper.selectUserPage(page, 1); // 获取分页数据 List<User> users = userPage.getRecords(); // 当前页数据 long total = userPage.getTotal(); // 总记录数 long pages = userPage.getPages(); // 总页数 ``` --- ### 关键点说明 1. **自动分页** 分页插件会拦截 SQL 并自动追加数据库方言的 `LIMIT` 语句（如 MySQL 的 `LIMIT ?,?`），同时自动执行 `COUNT` 查询总记录数。 2. **复杂 SQL 支持** 即使你的 SQL 包含多表关联或复杂条件，分页插件依然可以正确分页。 3. **返回结果** `IPage<T>` 对象包含分页数据（`records`）、总记录数（`total`）、每页大小（`size`）等所有分页信息。 --- ### 常见问题 - **SQL 未分页？** 检查是否漏了配置分页插件，或 XML 中的方法参数未使用 `Page` 对象。 - **手动编写 `LIMIT`** 如果 SQL 中手动添加了 `LIMIT`，分页插件会失效，需依赖插件自动追加。 - **自定义 `COUNT` 语句** 若自动生成的 `COUNT` 语句效率低，可在 XML 中通过 `@Select` 注解或 XML 的 `<select>` 标签指定自定义 `COUNT` 语句： ```xml <select id="selectUserPage" resultType="User"> SELECT * FROM user WHERE state = #{state} </select> <!-- 指定自定义 COUNT 语句的 ID --> <select id="selectUserPage_COUNT" resultType="java.lang.Long"> SELECT COUNT(*) FROM user WHERE state = #{state} </select> ``` --- 通过以上步骤，即可在 MyBatis-Plus 的自定义 Mapper 中实现灵活的分页查询。