作者:yhjyumi的专栏

数据权限实现(Mybatis拦截器+JSqlParser)

Mybatis的拦截器实现机制,使用的是JDK的InvocationHandler.

当我们调用ParameterHandler,ResultSetHandler,StatementHandler,Executor的对象的时候,
实际上使用的是Plugin这个代理类的对象,这个类实现了InvocationHandler接口.
接下来我们就知道了,在调用上述被代理类的方法的时候,就会执行Plugin的invoke方法.
Plugin在invoke方法中根据@Intercepts的配置信息(方法名,参数等)动态判断是否需要拦截该方法.
再然后使用需要拦截的方法Method封装成Invocation,并调用Interceptor的proceed方法.
这样我们就达到了拦截目标方法的结果.
例如Executor的执行大概是这样的流程:
拦截器代理类对象->拦截器->目标方法
Executor->Plugin->Interceptor->Invocation
Executor.Method->Plugin.invoke->Interceptor.intercept->Invocation.proceed->method.invoke


注解
@Intercepts 在实现Interceptor接口的类声明,使该类注册成为拦截器
Signature[] value//定义需要拦截哪些类,哪些方法
@Signature 定义哪些类(4种),方法,参数需要被拦截
Class<?> type()//ParameterHandler,ResultSetHandler,StatementHandler,Executor
String method()//
Class<?>[] args()// 接口
Interceptor 实现拦截器的接口 类
InterceptorChain 拦截器链,保存了Mybatis配置的所有拦截器,保存在Configuration
List<Interceptor> interceptors//拦截器 Invocation 类方法的一个封装,在拦截器中就是被调用的目标方法
Object target//调用的对象
Method method//调用的方法
Object[] args//参数 Plugin 插件,其实就是ParameterHandler,ResultSetHandler,StatementHandler,Executor的代理类(Mybatis使用的JDK代理实现拦截器),实现了InvocationHandler接口
Object target//被代理的目标对象
Interceptor interceptor//拦截器
Map<Class<?>, Set<Method>> signatureMap//接口需要拦截的方法(一对多,每个接口对应多个方法)
//
wrap(Object target, Interceptor interceptor)//把拦截器对象封装成Plugin代理对象.
invoke(Object proxy, Method method, Object[] args)//

使用例子

1.写一个类,并且实现Interceptor接口
2.在上述类使用@Intercepts注解,配置拦截信息
3.在配置文件配置插件

@Intercepts({ @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class,
RowBounds.class, ResultHandler.class }) })
public class MyInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
// TODO Auto-generated method stub }
}

配置文件加入

<plugins>
<plugin interceptor="weber.mybatis.plugin.MyInterceptor" />
</plugins>
  1. public static void main(String[] args) throws IOException {
  2. String resource = "conf.xml";
  3. InputStream is = Test1.class.getClassLoader().getResourceAsStream(resource);
  4. SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
  5. SqlSession session = sessionFactory.openSession();
  6. // User user = session.selectOne("weber.mybatis.mapper.getUser", 1);
  7. User userObj = new User();
  8. userObj.setId(123);
  9. session.selectList("weber.mybatis.mapper.searchByUser", userObj);
  10. // UserMapper mapper = session.getMapper(UserMapper.class);
  11. // mapper.selectAll();
  12. // System.out.println(user);
  13. }

开启debug模式,我们将看到Plugin是如何实现代理的.

当代码执行到下图红色部分的时候

将直接跳到下图!所以,我们此时的executor不是CachingExecutor对象,而是Plugin代理对象.

此时的method,就是被调用的目标方法如下:

最后附上源码注释

  1. /**
  2. * @author Clinton Begin
  3. */
  4. //Plugin是JDK动态代理类
  5. public class Plugin implements InvocationHandler {
  6. private Object target;//目标对象(ParameterHandler,ResultSetHandler,StatementHandler,Executor)
  7. private Interceptor interceptor;//被代理的拦截器
  8. //目标类需要拦截的方法缓存.因为一个拦截器可以拦截多个类,一个类可以拦截多个方法.
  9. //所以用Map + Set的数据结构存储
  10. private Map<Class<?>, Set<Method>> signatureMap;//保存每个拦截器的@signature的配置信息
  11. private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
  12. this.target = target;
  13. this.interceptor = interceptor;
  14. this.signatureMap = signatureMap;
  15. }
  16. //把目标对象和拦截器封装成Plugin代理类实例.
  17. public static Object wrap(Object target, Interceptor interceptor) {
  18. Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);//获取拦截器的拦截信息(需要拦截的类和方法)
  19. Class<?> type = target.getClass();
  20. Class<?>[] interfaces = getAllInterfaces(type, signatureMap);//Proxy代理只能代理接口
  21. if (interfaces.length > 0) {
  22. return Proxy.newProxyInstance(
  23. type.getClassLoader(),
  24. interfaces,
  25. new Plugin(target, interceptor, signatureMap));//Plugin作为代理类,但是实际业务是由Interceptor拦截器完成的.
  26. }
  27. return target;
  28. }
  29. @Override
  30. //proxy,类代理的对象,例如CachingExecutor对象
  31. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  32. try {//从这里代码看到,会拦截所有的Executor方法,动态的去判断拦截器要不要去拦截.所以要小心使用拦截器,会影响性能.
  33. Set<Method> methods = signatureMap.get(method.getDeclaringClass());
  34. if (methods != null && methods.contains(method)) {
  35. //Invocation是目标对象,目标对象需要拦截的方法,我拦截方法的参数的封装.
  36. return interceptor.intercept(new Invocation(target, method, args));//调用拦截器实现拦截
  37. }
  38. return method.invoke(target, args);//不需要拦截的方法直接放行
  39. } catch (Exception e) {
  40. throw ExceptionUtil.unwrapThrowable(e);
  41. }
  42. }
  43. private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
  44. Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);//获取拦截器注解@Signature
  45. // issue #251
  46. if (interceptsAnnotation == null) {
  47. throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
  48. }
  49. Signature[] sigs = interceptsAnnotation.value();//一个Signature表示一个拦截类型
  50. //保存需要拦截类的信息,class作为key, 需要拦截类的方法作为value集合Set保存.一个拦截器可以拦截一个类中多个方法
  51. Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
  52. for (Signature sig : sigs) {
  53. Set<Method> methods = signatureMap.get(sig.type());
  54. if (methods == null) {
  55. methods = new HashSet<Method>();
  56. signatureMap.put(sig.type(), methods);
  57. }
  58. try {
  59. Method method = sig.type().getMethod(sig.method(), sig.args());//获取需要拦截的方法
  60. methods.add(method);
  61. } catch (NoSuchMethodException e) {
  62. throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
  63. }
  64. }
  65. return signatureMap;
  66. }
  67. private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
  68. Set<Class<?>> interfaces = new HashSet<Class<?>>();
  69. while (type != null) {
  70. for (Class<?> c : type.getInterfaces()) {
  71. if (signatureMap.containsKey(c)) {
  72. interfaces.add(c);
  73. }
  74. }
  75. type = type.getSuperclass();
  76. }
  77. return interfaces.toArray(new Class<?>[interfaces.size()]);
  78. }
  79. }

 

  1. /**
  2. * @author Clinton Begin
  3. */
  4. //InterceptorChain里保存了所有的拦截器,它在mybatis初始化的时候创建。存在Configuration中
  5. public class InterceptorChain {
  6. private final List<Interceptor> interceptors = new ArrayList<Interceptor>();
  7. //每一个拦截器对目标类都进行一次代理(也就是会出现代理的代理的代理.....有点拗口)
  8. public Object pluginAll(Object target) {
  9. for (Interceptor interceptor : interceptors) {
  10. target = interceptor.plugin(target);
  11. }
  12. return target;
  13. }
  14. public void addInterceptor(Interceptor interceptor) {
  15. interceptors.add(interceptor);
  16. }
  17. public List<Interceptor> getInterceptors() {
  18. return Collections.unmodifiableList(interceptors);
  19. }
  20. }

 

    1. /**
    2. * @author Clinton Begin
    3. */
    4. public interface Interceptor {
    5. Object intercept(Invocation invocation) throws Throwable;//拦截方法,在这里处理拦截器的业务逻辑
    6. Object plugin(Object target);//把目标对象封装成Plugin对象
    7. void setProperties(Properties properties);
    8. }

Mybatis那些事-拦截器(Plugin+Interceptor)的更多相关文章

  1. MyBatis 插件之拦截器(Interceptor)

    参考 https://blog.csdn.net/weixin_39494923/article/details/91534658 //项目实际使用  就是在你进行数据库操作时,进行数据的第二次封装 ...

  2. MyBatis功能点二:MyBatis提供的拦截器平台

    前面关于MyBatis功能点二plugin已经介绍了一些应用及其实现的底层代码,本文总结MyBatis提供的拦截器平台框架体系. 通过MyBatis功能点二:从责任链设计模式的角度理解插件实现技术 - ...

  3. Java开发学习(二十八)----拦截器(Interceptor)详细解析

    一.拦截器概念 讲解拦截器的概念之前,我们先看一张图: (1)浏览器发送一个请求会先到Tomcat的web服务器 (2)Tomcat服务器接收到请求以后,会去判断请求的是静态资源还是动态资源 (3)如 ...

  4. Struts之 拦截器配置 ( Interceptor )

    struts2体系结构的核心就是拦截器. 以链式执行,对真正要执行的方法(execute())进行拦截.首先执行Action配置的拦截器,在Action和Result执行之后,拦截器再一次执行(与先前 ...

  5. 过滤器(Filter)与拦截器(Interceptor )区别

    目录 过滤器(Filter) 拦截器(Interceptor) 拦截器(Interceptor)和过滤器(Filter)的区别 拦截器(Interceptor)和过滤器(Filter)的执行顺序 拦截 ...

  6. springboot(十七):过滤器(Filter)和拦截器(Interceptor)

    概述 在做web开发的时候,过滤器(Filter)和拦截器(Interceptor)很常见,通俗的讲,过滤器可以简单理解为“取你所想取”,忽视掉那些你不想要的东西:拦截器可以简单理解为“拒你所想拒”, ...

  7. SpringMVC的拦截器(Interceptor)和过滤器(Filter)的区别与联系

    摘自: http://blog.csdn.net/xiaoyaotan_111/article/details/53817918 一 简介 (1)过滤器: 依赖于servlet容器.在实现上基于函数回 ...

  8. 过滤器(Filter)与拦截器(Interceptor)区别

    过滤器(Filter)与拦截器(Interceptor)区别 过滤器(Filter) Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序,主要的用途 ...

  9. java拦截器(Interceptor)学习笔记

    1,拦截器的概念    java里的拦截器是动态拦截Action调用的对象,它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码,也可以在一个Action执行前阻止其执行,同时也提供了 ...

随机推荐

  1. 使用Navicat为数据库表建立触发器

    打开Navicat   打开数据表所在的数据库,右击需要新增字段的数据库表,然后点击[设计表]   此时进入表设计界面   点击[触发器]标签页,输入触发器名称,如trigger1   选择触发条件, ...

  2. Own MusicPlayer隐私策略

    本地音乐播放器 此为Own MusicPlayer本地音乐播放器的隐私策略,本隐私策略内容会不定期更新,以最新内容为主. 若您已经阅读并了解以下内容后,并继续使用该软件,即表示您已同意该协议. 访问权 ...

  3. Collection集合常用的功能

    package demo06; import java.util.ArrayList;import java.util.Collection; /** java.util接口 Collection&l ...

  4. [AT2062] ~K Perm Counting

    AT2602 , Luogu 求对于 \(n\) 个数的排列 , 有多少种方案满足对于所有的 \(i\) , \(|P_i - i| != K\) , 答案对 \(924844033\) 取模 . \ ...

  5. [转帖]ECC公钥格式详解

    ECC公钥格式详解 https://www.cnblogs.com/xinzhao/p/8963724.html 本文首先介绍公钥格式相关的若干概念/技术,随后以示例的方式剖析DER格式的ECC公钥, ...

  6. 将mysql中一行中的几个字段 转换成一列并从其他数据库中查对应的邮件信息

    --将项目中的总监,经理,等的邮箱合并为一行 SELECT GROUP_CONCAT(t.USER_EMAIL SEPARATOR ' ') mail_address FROM portal.t_ac ...

  7. MySQL 聚合函数(一)聚合(组合)函数概述

    MySQL版本:5.7+ 本节介绍对值的集合进行操作的组合(聚合)函数.翻译自:Aggregate (GROUP BY) Function Descriptions 一.MySQL 5.7中的聚合函数 ...

  8. C语言存30位数字长的十进制方法

    题目:将一个长度最多为30位数字的十进制非负整数转换为二进制数输出. 首先: 1,30位数字的十进制,并没有一个数据类型可以存下30位的整数类型数字,所以考虑用字符串存储这个数据,遍历这个字符串,每个 ...

  9. IoC框架介绍

    转载自:http://blog.csdn.net/wanghao72214/article/details/3969594 1 IoC理论的背景    我们都知道,在采用面向对象方法设计的软件系统中, ...

  10. ajax 请求二进制流 图片

    <html xmlns="http://www.w3.org/1999/xhtml"><head runat="server">    ...