在日常开发中经常会使用分页查询操作,而分页语句以及分页对象的处理,对于程序员来说是一个绕不开的小难题,虽然有很多Mybatis分页插件可以简化部分步骤,但是使用起来依旧比较繁琐。MybatisPlus的出现,进一步减低了进行分页操作的门槛。本文带着大家学会使用MybatisPlus是分页插件,并对其原理进行一定的分析。接下来我们主要在Spring boot环境下看看如何使用MybatisPlus进行分页查询。
关于分页插件,我们还需要知道以下两点:
我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能,在此之前,我们假设您已经:
现在有一张表 t_user 结构如下
编写实体类User:(使用lombok简化)
@Data@TableName("tb_user")public class User { //告知id是主键 采用的自增形式 @TableId(type= IdType.AUTO) private Long id; @TableField("user_name") private String userName; private String password; private String name; private Integer age; private String email;}
编写 Mapper 包下的 UserMapper接口
public interface UserMapper extends BaseMapper {}
由于mp分页是基于插件产生,所以我们需要先 导入核心插件到springboot中.
@Configuration@MapperScan("com.itheima.mapper")public class MybatisPlusConfig { /** * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除) */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); // 配置分页插件 interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } @Bean public ConfigurationCustomizer configurationCustomizer() { return configuration -> configuration.setUseDeprecatedExecutor(false); }}
// 根据 entity 条件,查询全部记录(并翻页)IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);// 根据 Wrapper 条件,查询全部记录(并翻页)IPage
@SpringBootTestclass PageQueryTests { @Autowired private UserMapper userMapper; @Test void testSelectPage() { //当前页码 int current = 2; //每页条数 int size = 2; //构建 分页构造器 IPage page = new Page(current, size); //构建 条件构造器 QueryWrapper wrapper = new QueryWrapper<>(); wrapper.lt("age",23); //执行查询 userMapper.selectPage(page, wrapper); //它会自动完成 数据的封装 并把查询出来的数据 存储到page对象的一个属性中 // setRecords 把数据存到 Records 里面了 // 总条数 总页数 --page也有封装 //获取page的 Records属性 List records = page.getRecords();//当前页数据 long total = page.getTotal();//总条数 long pages = page.getPages();//总页数 System.out.println("当前数据总共有:"+total); System.out.println("共"+pages+"页"); System.out.println("当前页数据:"+records); }
MybatisPlus核心插件 MybatisPlusInterceptor,基于该插件mp实现了丰富的特性,
该插件是核心插件,目前代理了 Executor#query 和 Executor#update 和 StatementHandler#prepare 方法.
也就是说该插件可以对查询的执行,增删改的执行以及预处理对象进行功能性的增强.
那么是如何对sql实现拦截增强的呢,我们就要研究一下该分页插件的拦截器集合属性.
private List interceptors = new ArrayList<>();
InnerInterceptor
我们提供的插件都将基于此接口来实现功能
目前已有的功能:s
由上可知,如果想要研究分页的实现原理就要研究分页拦截器"PaginationInnerInterceptor"
当我们执行该语句时,会在执行sql之前被拦截器拦截
userMapper.selectPage(page, wrapper);
先从我们在mybatis-plus的配置说起
我们对 分页插件进行拦截会发现,当我们执行sql的时候mybatis-plus会对所有SQL语句进行拦截并做各种判断与附加操作,会进入到Mybatis-Plus全局拦截器.
下图中是针对分页情况下的特定操作
由82行可知,当前sql执行时,被拦截器拦截,发现是查询语句,就会先执行winllDoQuery方法,其次做完在执行 beforeQuery.
因为在配置中new出来的是 PaginationInnerInterceptor 对象,所以这里的方法就会走该对象中的方法
从源码中不难看出,此处对查询参数做了提取并通过ParameterUtils.findPage()方法进行了转换判断,继续往里看:
可以看到方法中是提取Map类型参数中的IPage类型参数或者是直接传入IPage类型的参数进行提取,如果有则直接返回IPage类型的参数,如果为空则返回null不进行count查询.
上面就是我们在看到的count查询
那么在什么时候实现的分页查询呢? 刚才在追踪源码的时候也发现了 winllDoQuery方法执行完调用了 beforeQuery().beforeQuery()方法对分页查询进行了拦截.
其实我们发现,mybatisplus的分页实现其实是借助了拦截器的拦截功能,在查询之前进行了两次拦截,最终完成封装操作,通过本文的介绍,你是否比之前更加清晰了呢。
留言与评论(共有 0 条评论) “” |