Mybatis插件原理分析

主页 > 新闻资讯 > 软件开发资讯 > 编程相关软件开发相关 >

Mybatis插件原理分析

更新时间：2016-09-20 15:39 发布者：周老师

我们首先介绍一下Mybatis插件相关的几个类，并对源码进行了简单的分析。

Mybatis插件相关的接口或类有：Intercept、InterceptChain、Plugin和Invocation，这几个接口或类实现了整个Mybatis插件流程。

Interceptor：一个接口，是实现自己功能需要实现的接口

源码如下：

[java] view plain copy
 
 print?在CODE上查看代码片派生到我的代码片
  1. /** 
  2.  * @author Clinton Begin 
  3.  */  
  4. public interface Interceptor {  
  5.   
  6.   //在此方法中实现自己需要的功能，最后执行invocation.proceed()方法，实际就是调用method.invoke(target, args)方法，调用代理类  
  7.   Object intercept(Invocation invocation) throws Throwable;  
  8.   
  9.   //这个方法是将target生成代理类  
  10.   Object plugin(Object target);  
  11.   //在xml中注册Intercept是配置一些属性  
  12.   void setProperties(Properties properties);  
  13.   
  14. }  

InterceptorChain：有一个List<Interceptor> interceptors变量，来保存所有Interceptor的实现类

源码如下：

[java] view plain copy
 
 print?在CODE上查看代码片派生到我的代码片
  1. /** 
  2.  * @author Clinton Begin 
  3.  */  
  4. public class InterceptorChain {  
  5.   
  6.   //插件拦截器链  
  7.   private final List<Interceptor> interceptors = new ArrayList<Interceptor>();  
  8.   
  9.   //把target变成代理类，这样在运行target方法之前需要运行Plugin的invoke方法  
  10.   public Object pluginAll(Object target) {  
  11.     for (Interceptor interceptor : interceptors) {  
  12.       target = interceptor.plugin(target);  
  13.     }  
  14.     return target;  
  15.   }  
  16.   
  17.   public void addInterceptor(Interceptor interceptor) {  
  18.     interceptors.add(interceptor);  
  19.   }  
  20.     
  21.   public List<Interceptor> getInterceptors() {  
  22.     return Collections.unmodifiableList(interceptors);  
  23.   }  
  24.   
  25. }  


Invocation：一个比较简单的类，主要的功能就是根据构造函数类执行代理类

源码如下：

[java] view plain copy
 
 print?在CODE上查看代码片派生到我的代码片
  1. /** 
  2.  * @author Clinton Begin 
  3.  */  
  4. public class Invocation {  
  5.   
  6.   private Object target;  
  7.   private Method method;  
  8.   private Object[] args;  
  9.   
  10.   public Invocation(Object target, Method method, Object[] args) {  
  11.     this.target = target;  
  12.     this.method = method;  
  13.     this.args = args;  
  14.   }  
  15.   
  16.   public Object getTarget() {  
  17.     return target;  
  18.   }  
  19.   
  20.   public Method getMethod() {  
  21.     return method;  
  22.   }  
  23.   
  24.   public Object[] getArgs() {  
  25.     return args;  
  26.   }  
  27.   //其实mybatis的Interceptor最终还是调用的method.invoke方法  
  28.   public Object proceed() throws InvocationTargetException, IllegalAccessException {  
  29.     return method.invoke(target, args);  
  30.   }  
  31.   
  32. }  


Plugin：Mybatis插件的核心类，它实现了代理接口InvocationHandler，是一个代理类

源码详解如下：

[java] view plain copy
 
 print?在CODE上查看代码片派生到我的代码片
  1. /** 
  2.  * @author Clinton Begin 
  3.  */  
  4. //这个类是Mybatis拦截器的核心,大家可以看到该类继承了InvocationHandler  
  5. //又是JDK动态代理机制  
  6. public class Plugin implements InvocationHandler {  
  7.   
  8.   //目标对象  
  9.   private Object target;  
  10.   //拦截器  
  11.   private Interceptor interceptor;  
  12.   //记录需要被拦截的类与方法  
  13.   private Map<Class<?>, Set<Method>> signatureMap;  
  14.   
  15.   private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {  
  16.     this.target = target;  
  17.     this.interceptor = interceptor;  
  18.     this.signatureMap = signatureMap;  
  19.   }  
  20.   
  21.   //一个静态方法,对一个目标对象进行包装，生成代理类。  
  22.   public static Object wrap(Object target, Interceptor interceptor) {  
  23.     //首先根据interceptor上面定义的注解 获取需要拦截的信息  
  24.     Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);  
  25.     Class<?> type = target.getClass();  
  26.     Class<?>[] interfaces = getAllInterfaces(type, signatureMap);  
  27.     //如果长度为>0 则返回代理类 否则不做处理  
  28.     if (interfaces.length > 0) {  
  29.       //创建JDK动态代理对象  
  30.       return Proxy.newProxyInstance(  
  31.           type.getClassLoader(),  
  32.           interfaces,  
  33.           new Plugin(target, interceptor, signatureMap));  
  34.     }  
  35.     return target;  
  36.   }  
  37.   
  38.   //在执行Executor、ParameterHandler、ResultSetHandler和StatementHandler的实现类的方法时会调用这个方法  
  39.   @Override  
  40.   public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {  
  41.     try {  
  42.       //通过method参数定义的类 去signatureMap当中查询需要拦截的方法集合  
  43.       Set<Method> methods = signatureMap.get(method.getDeclaringClass());  
  44.       //判断是否是需要拦截的方法，如果需要拦截的话就执行实现的Interceptor的intercept方法，执行完之后还是会执行method.invoke方法，不过是放到interceptor实现类中去实现了  
  45.       if (methods != null && methods.contains(method)) {  
  46.         return interceptor.intercept(new Invocation(target, method, args));  
  47.       }  
  48.       //不拦截 直接通过目标对象调用方法  
  49.       return method.invoke(target, args);  
  50.     } catch (Exception e) {  
  51.       throw ExceptionUtil.unwrapThrowable(e);  
  52.     }  
  53.   }  
  54.   //根据拦截器接口（Interceptor）实现类上面的注解获取相关信息  
  55.   private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {  
  56.     //获取注解信息  
  57.     Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);  
  58.     // issue #251  
  59.     //为空则抛出异常  
  60.     if (interceptsAnnotation == null) {  
  61.       throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());        
  62.     }  
  63.     //获得Signature注解信息  
  64.     Signature[] sigs = interceptsAnnotation.value();  
  65.     Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();  
  66.     //循环注解信息  
  67.     for (Signature sig : sigs) {  
  68.       //根据Signature注解定义的type信息去signatureMap当中查询需要拦截方法的集合  
  69.       Set<Method> methods = signatureMap.get(sig.type());  
  70.       //第一次肯定为null 就创建一个并放入signatureMap  
  71.       if (methods == null) {  
  72.         methods = new HashSet<Method>();  
  73.         signatureMap.put(sig.type(), methods);  
  74.       }  
  75.       try {  
  76.         //找到sig.type当中定义的方法 并加入到集合  
  77.         Method method = sig.type().getMethod(sig.method(), sig.args());  
  78.         methods.add(method);  
  79.       } catch (NoSuchMethodException e) {  
  80.         throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);  
  81.       }  
  82.     }  
  83.     return signatureMap;  
  84.   }  
  85.   //根据对象类型与signatureMap获取接口信息  
  86.   private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {  
  87.     Set<Class<?>> interfaces = new HashSet<Class<?>>();  
  88.     //循环type类型的接口信息 如果该类型存在与signatureMap当中则加入到set当中去  
  89.     while (type != null) {  
  90.       for (Class<?> c : type.getInterfaces()) {  
  91.         if (signatureMap.containsKey(c)) {  
  92.           interfaces.add(c);  
  93.         }  
  94.       }  
  95.       type = type.getSuperclass();  
  96.     }  
  97.     //转换为数组返回  
  98.     return interfaces.toArray(new Class<?>[interfaces.size()]);  
  99.   }  
  100.   
  101. }  


对Mybatis插件有一定了解的人应该知道，插件拦截的类是Executor、ParameterHandler、ResultSetHandler和StatementHandler的实现类，为什么会这样呢？在Configuration类中看一下代码就明白了，可以看到在初始化Executor、ParameterHandler、ResultSetHandler和StatementHandler都会调用interceptorChain.pluginAll（）这个函数，其实这样之后各个接口的实现类就被代理类生成为目标类了。

[java] view plain copy
 
 print?在CODE上查看代码片派生到我的代码片
  1. public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {  
  2.    ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);  
  3.    parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);  
  4.    return parameterHandler;  
  5.  }  
  6.   
  7.  public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,  
  8.      ResultHandler resultHandler, BoundSql boundSql) {  
  9.    ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);  
  10.    resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);  
  11.    return resultSetHandler;  
  12.  }  
  13.   
  14.  public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {  
  15.    StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);  
  16.    statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);  
  17.    return statementHandler;  
  18.  }  
  19.   
  20.  public Executor newExecutor(Transaction transaction) {  
  21.    return newExecutor(transaction, defaultExecutorType);  
  22.  }  
  23.   
  24.  public Executor newExecutor(Transaction transaction, ExecutorType executorType) {  
  25.    executorType = executorType == null ? defaultExecutorType : executorType;  
  26.    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;  
  27.    Executor executor;  
  28.    if (ExecutorType.BATCH == executorType) {  
  29.      executor = new BatchExecutor(this, transaction);  
  30.    } else if (ExecutorType.REUSE == executorType) {  
  31.      executor = new ReuseExecutor(this, transaction);  
  32.    } else {  
  33.      executor = new SimpleExecutor(this, transaction);  
  34.    }  
  35.    if (cacheEnabled) {  
  36.      executor = new CachingExecutor(executor);  
  37.    }  
  38.    executor = (Executor) interceptorChain.pluginAll(executor);  
  39.    return executor;  
  40.  }  



上一篇： github如何pull最新代码   下一篇：10个值得推荐的免费设计模板网站