分页插件

  • 自定义查询语句分页（自己写sql/mapper）
  • spring 注入 mybatis 配置分页插件
  1. <plugins>
  2.     <!--
  3.      | 分页插件配置
  4.      | 插件提供二种方言选择：1、默认方言 2、自定义方言实现类，两者均未配置则抛出异常！
  5.      | overflowCurrent 溢出总页数，设置第一页 默认false
  6.      | optimizeType Count优化方式 （ 版本 2.0.9 改为使用 jsqlparser 不需要配置 ）
  7.      | -->
  8.     <!-- 注意!! 如果要支持二级缓存分页使用类 CachePaginationInterceptor 默认、建议如下！！ -->
  9.     <plugin interceptor="com.baomidou.mybatisplus.plugins.PaginationInterceptor">
  10.         <property name="sqlParser" ref="自定义解析类、可以没有" />
  11.         <property name="localPage" value="默认 false 改为 true 开启了 pageHeper 支持、可以没有" />
  12.         <property name="dialectClazz" value="自定义方言类、可以没有" />
  13.     </plugin>
  14. </plugins>
  1. //Spring boot方式
  2. @EnableTransactionManagement
  3. @Configuration
  4. @MapperScan("com.baomidou.cloud.service.*.mapper*")
  5. public class MybatisPlusConfig {
  7.     /**
  8.      * 分页插件
  9.      */
  10.     @Bean
  11.     public PaginationInterceptor paginationInterceptor() {
  12.         return new PaginationInterceptor();
  13.     }
  14. }

方式一 、传参区分模式【推荐】

测试用例

  • UserMapper.java 方法内容
  1. public interface UserMapper{//可以继承或者不继承BaseMapper
  2.     /**
  3.      * <p>
  4.      * 查询 : 根据state状态查询用户列表，分页显示
  5.      * </p>
  6.      *
  7.      * @param page
  8.      *            翻页对象，可以作为 xml 参数直接使用，传递参数 Page 即自动分页
  9.      * @param state
  10.      *            状态
  11.      * @return
  12.      */
  13.     List<User> selectUserList(Pagination page, Integer state);
  14. }
  • UserServiceImpl.java 调用翻页方法，需要 page.setRecords 回传给页面
  1. public Page<User> selectUserPage(Page<User> page, Integer state) {
  2.     // 不进行 count sql 优化，解决 MP 无法自动优化 SQL 问题
  3.     // page.setOptimizeCountSql(false);
  4.     // 不查询总记录数
  5.     // page.setSearchCount(false);
  6.     // 注意！！ 分页 total 是经过插件自动 回写 到传入 page 对象
  7.     return page.setRecords(userMapper.selectUserList(page, state));
  8. }
  • UserMapper.xml 等同于编写一个普通 list 查询，mybatis-plus 自动替你分页
  1. <select id="selectUserList" resultType="User">
  2.     SELECT * FROM user WHERE state=#{state}
  3. </select>

方式二、ThreadLocal 模式【容易出错，不推荐】

  • PageHelper 使用方式如下：
// 开启分页
PageHelper.startPage(1, 2);
List<User> data = userService.findAll(params);
// 获取总条数
int total = PageHelper.getTotal();
// 获取总条数，并释放资源
int total = PageHelper.freeTotal();

JSON 序列化移除 transient 修饰的 Page 无关紧要的返回属性

// Jackson 方式
objectMapper.configure(MapperFeature.PROPAGATE_TRANSIENT_MARKER, true);

page total 为 0 检查下是否加入 com.github.pagehelper 插件，有网友反馈它会干扰 MP 分页，请移除。