java - mybatisPlus中如何将分页插件应用于自定义查询方法？

Question

我想要通过在MybatisPlus的BaseMapper的子类接口上增加查询实体的方法，这个方法的查询条件通过注解来定义，可能会比较复杂和使用到脚本，比如

    @Select("<script>" +            "SELECT * FROM t_my_table WHERE deleted=false AND uuid IN " +            "<foreach collection='collection' item='item' separator=','>" +            "#{item}" +            "</foreach>" +            "</script>")    List<MyEntity> selectByUuid(List<String> uuid);

我想让这个方法通过myBatisPlus的分页插件进行自动分页，需要对方法进行什么改动呢？除了需要改动方法的返回值为IPage<MyEntity>类型，然后传参肯定需要有IPage<MyEntity>类型的传参，有这些就足够了吗？
换句话解释我的疑问就是，mybatisPlus的分页插件是通过什么方式识别可以分页的方法并自动填充IPage对象的呢？

Answer 1

MybatisPlus 的分页插件是在 SQL 查询执行之前自动注入的，它通过解析你的查询方法（例如，通过注解）来获取分页信息，并在查询中加入分页语句。

对于你的情况，你的查询方法已经返回 List<MyEntity> 类型的数据，如果要使用 MybatisPlus 的分页插件进行自动分页，你需要将返回类型更改为 IPage<MyEntity>。同时，你需要在查询方法中加入分页参数。具体如下：

public interface MyMapper extends BaseMapper<MyEntity> {    @Select("<script>" +            "SELECT * FROM t_my_table WHERE deleted=false AND uuid IN " +            "<foreach collection='collection' item='item' separator=','>" +            "#{item}" +            "</foreach>" +            "</script>")    IPage<MyEntity> selectByUuid(List<String> uuid, Pagination pagination);}

在上面的代码中，我们在查询方法中加入了一个 Pagination 类型的参数。Pagination 参数包含了分页信息，例如当前页数和每页显示的数量。

然后，你需要在调用这个查询方法时传入 Pagination 参数。例如：

MyMapper mapper = sqlSession.getMapper(MyMapper.class);Pagination pagination = new Pagination(page, size); // page 为当前页数，size 为每页显示的数量IPage<MyEntity> result = mapper.selectByUuid(uuids, pagination);

MybatisPlus 的分页插件在执行查询时会自动处理分页语句的注入，所以你不需要担心分页的实现细节。你只需要关注你的查询方法和如何调用它们即可。