首页
/ MyBatis-Plus 数据权限拦截器在分页查询中的注意事项

MyBatis-Plus 数据权限拦截器在分页查询中的注意事项

2025-05-13 02:41:39作者:田桥桑Industrious

问题背景

在使用 MyBatis-Plus 3.5.5 版本时,开发者发现当配置了自定义数据权限处理器(CustomDataPermissionHandler)并实现了多数据权限接口(MultiDataPermissionHandler)后,将拦截器添加到执行链中时,分页查询中的 count 查询部分无法被正常拦截,导致 count SQL 语句中不包含数据权限相关的过滤条件。

技术原理分析

MyBatis-Plus 的分页插件在执行分页查询时,实际上会执行两个操作:

  1. 先执行 count 查询获取总记录数
  2. 然后执行实际的数据查询

这两个查询是分开执行的,因此拦截器需要分别对这两个查询进行处理。默认情况下,拦截器可能只对主查询生效,而忽略了 count 查询。

解决方案

根据官方维护者的建议,正确的处理方式是将数据权限拦截器放在分页插件之前。这是因为:

  1. MyBatis 的拦截器是按照添加顺序逆序执行的(后添加的先执行)
  2. 分页插件会在执行主查询前先执行 count 查询
  3. 如果数据权限拦截器在分页插件之后添加,可能无法拦截到 count 查询

最佳实践

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    
    // 先添加数据权限拦截器
    interceptor.addInnerInterceptor(new DataPermissionInterceptor(new CustomDataPermissionHandler()));
    
    // 后添加分页拦截器
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
    
    return interceptor;
}

深入理解

这种设计的原因是 MyBatis 拦截器的执行机制决定的。拦截器形成一个责任链,请求会从最后一个添加的拦截器开始执行。对于分页查询:

  1. 请求首先进入分页拦截器
  2. 分页拦截器执行 count 查询
  3. count 查询会经过之前添加的所有拦截器
  4. 然后执行主查询,同样经过所有拦截器

如果把数据权限拦截器放在分页拦截器之后,count 查询就无法经过数据权限拦截器处理。

总结

在使用 MyBatis-Plus 的数据权限功能时,特别是与分页功能结合使用时,必须注意拦截器的添加顺序。将数据权限拦截器放在分页拦截器之前,可以确保 count 查询和主查询都能被正确处理,从而保证数据权限的一致性。这是 MyBatis 拦截器机制下的一个典型设计模式,理解这一原理有助于开发者更好地使用和扩展 MyBatis-Plus 的功能。

登录后查看全文
热门项目推荐
相关项目推荐