第04篇：Mybatis代理对象生成

一、架构分析

Mybatis中Mapper一般只是一个接口, 那么为什么能执行数据操作的呢? 那肯定是基于代理没得说。在了解Mybatis如何实现代理 前, 我们先大概看下它的架构是什么样的, 对这些关键的类有个大概的认识, 知道它所处的位置在哪里。

本篇我们只深入研究下代理层, 学习下mybatis是如何进行代理操作的, 而关于sql的最终执行, 放到下一篇执行流程中来研究。

二、源码分析

首先不要慌, 看上面这个图, Mybatis的代理流程还是比较简单的。下面主要看下每个核心的类是做什么用的。

2.1 MapperProxyFactory

public class MapperProxyFactory<T> {  private final Class<T> mapperInterface;  private final Map<Method,   MapperMethodInvoker> methodCache = new ConcurrentHashMap<>();  // Jdk代理Proxy,  可以看到主要逻辑在MapperProxy中  protected T newInstance(MapperProxy<T> mapperProxy) {    return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(),   new Class[] { mapperInterface },   mapperProxy);  }  public T newInstance(SqlSession sqlSession) {    final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession,   mapperInterface,   methodCache);    return newInstance(mapperProxy);  }}

2.2 MapperProxy

MapperProxy 的代理逻辑也非常简单, 就以下三个能力, 看图理解。

下面将核心的处理代码给挑选了出来, 增加了注释。

public class MapperProxy<T> implements InvocationHandler,   Serializable {  @Override  public Object invoke(Object proxy,   Method method,   Object[] args) throws Throwable {    try {      // Object方法直接执行      if (Object.class.equals(method.getDeclaringClass())) {        return method.invoke(this,   args);      } else {        // 其他方法生成代理方法        return cachedInvoker(method).invoke(proxy,   method,   args,   sqlSession);      }    } catch (Throwable t) {      throw ExceptionUtil.unwrapThrowable(t);    }  }    private MapperMethodInvoker cachedInvoker(Method method) throws Throwable {    try {      return MapUtil.computeIfAbsent(methodCache,   method,   m -> {        // 如果是默认方法        if (m.isDefault()) {          try {            if (privateLookupInMethod == null) {              // 生成java8的语法解析生成代理方法              return new DefaultMethodInvoker(getMethodHandleJava8(method));            } else {              // // 生成java9的语法解析生成代理方法              return new DefaultMethodInvoker(getMethodHandleJava9(method));            }          } catch (IllegalAccessException | InstantiationException | InvocationTargetException              | NoSuchMethodException e) {            throw new RuntimeException(e);          }        } else {        // 不是默认方法,   生成代理方法 MapperMethod          return new PlainMethodInvoker(new MapperMethod(mapperInterface,   method,   sqlSession.getConfiguration()));        }      });    } catch (RuntimeException re) {      Throwable cause = re.getCause();      throw cause == null ? re : cause;    }  }}

2.3 PlainMethodInvoker

前面说了代理方法主要有三种场景。

1. Object方法直接method.invoker(this, args);
2. default关键字修饰的方法, 是DefaultMethodInvoker
3. 而更重要的要执行sql的代理Invoker是PlainMethodInvoker

PlainMethodInvoker 才是真正处理需要进行sql的具体实现类。真正的代理逻辑在 MapperMethod 中。

private static class PlainMethodInvoker implements MapperMethodInvoker {    private final MapperMethod mapperMethod;    public PlainMethodInvoker(MapperMethod mapperMethod) {      super();      this.mapperMethod = mapperMethod;    }    @Override    public Object invoke(Object proxy,   Method method,   Object[] args,   SqlSession sqlSession) throws Throwable {      return mapperMethod.execute(sqlSession,   args);    }  }

MapperMethod, 简单看下流程, 里面有2个重要的实现类, 分别用于判断sql类型, 处理方法参数(解析@Param参数)并最终交给SqlSession执行。到这里就把代理的 流程给搞清楚了。但是具体sql怎么组装参数, 如何调用数据库jdbc接口, 都还没有看到。这部分内容。我们放到下一篇 第05篇:Mybatis的SQL执行流程分析

public class MapperMethod {  private final SqlCommand command;  private final MethodSignature method;  public MapperMethod(Class<?> mapperInterface,   Method method,   Configuration config) {    this.command = new SqlCommand(config,   mapperInterface,   method);    this.method = new MethodSignature(config,   mapperInterface,   method);  }  public Object execute(SqlSession sqlSession,   Object[] args) {    Object result;    switch (command.getType()) {      case INSERT: {        Object param = method.convertArgsToSqlCommandParam(args);        result = rowCountResult(sqlSession.insert(command.getName(),   param));        break;      }      case UPDATE: {        Object param = method.convertArgsToSqlCommandParam(args);        result = rowCountResult(sqlSession.update(command.getName(),   param));        break;      }      case DELETE: {        Object param = method.convertArgsToSqlCommandParam(args);        result = rowCountResult(sqlSession.delete(command.getName(),   param));        break;      }      case SELECT:        if (method.returnsVoid() && method.hasResultHandler()) {          executeWithResultHandler(sqlSession,   args);          result = null;        } else if (method.returnsMany()) {          result = executeForMany(sqlSession,   args);        } else if (method.returnsMap()) {          result = executeForMap(sqlSession,   args);        } else if (method.returnsCursor()) {          result = executeForCursor(sqlSession,   args);        } else {          Object param = method.convertArgsToSqlCommandParam(args);          result = sqlSession.selectOne(command.getName(),   param);          if (method.returnsOptional()              && (result == null || !method.getReturnType().equals(result.getClass()))) {            result = Optional.ofNullable(result);          }        }        break;      case FLUSH:        result = sqlSession.flushStatements();        break;      default:        throw new BindingException("Unknown execution method for: " + command.getName());    }    if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {      throw new BindingException("Mapper method '" + command.getName()          + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");    }    return result;  }}