mybatis拦截器源码分析

Posted 2021-04-05 程序员MOC

mybatis基础环境搭建和相关基础直接略过（基础还是很重要的哦）。mybatis的拦截器主要使用了JDK的动态代理和反射，核心接口是Interceptor，

public interface Interceptor {
    //代理对象的执行
  Object intercept(Invocation invocation) throws Throwable;
    //获取代理对象
  Object plugin(Object target);
    //代理对象属性配置
  void setProperties(Properties properties);

}

mybatis拦截器使用插件方式，在mybatis配置文件格式

<plugins>
   <plugin interceptor="com.leijain.ExamplePlugin"></plugin>
</plugins>

DEBUG跟踪，我们可以清楚的了解拦截器的原理。在mybatis环境初始化类XMLConfigBuilder将拦截器加入到代理链InterceptorChain中。

private void parseConfiguration(XNode root) {

  try {
    propertiesElement(root.evalNode("properties")); //issue #117 read properties first
    typeAliasesElement(root.evalNode("typeAliases"));
    pluginElement(root.evalNode("plugins"));
    objectFactoryElement(root.evalNode("objectFactory"));
    objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
    settingsElement(root.evalNode("settings"));
    environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
    databaseIdProviderElement(root.evalNode("databaseIdProvider"));
    typeHandlerElement(root.evalNode("typeHandlers"));
    mapperElement(root.evalNode("mappers"));
  } catch (Exception e) {
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
  }

mybatis可以对ParameterHandler、ResultSetHandler、StatementHandler、Executor四个对象进行代理。为什么呢？分析以上四对象，分别存在如下流程

parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);

resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);

statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);

executor = (Executor) interceptorChain.pluginAll(executor);

public Object pluginAll(Object target) {
  for (Interceptor interceptor : interceptors) {
    target = interceptor.plugin(target);
  }
  return target;
}

生成代理对象。

public Object plugin(Object target) {
   System.out.println(target.getClass().getName());
   return Plugin.wrap(target, this);
}

代理对象的生成过程，使用了反射原理和JDK的动态代理。如果以上四个对象存在被代理（即方法存在被代理）的情形，则代理类会执行

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  try {
    Set<Method> methods = signatureMap.get(method.getDeclaringClass());
    if (methods != null && methods.contains(method)) {
      return interceptor.intercept(new Invocation(target, method, args));
    }
    return method.invoke(target, args);
  } catch (Exception e) {
    throw ExceptionUtil.unwrapThrowable(e);
  }
}

mybatis的拦截器实现原理很简洁，主要用在分页插件上，但是用起来需要对mybatis有个全面的了解最好。