Mybatis源码分析——参数处理

Mybatis源码分析——参数处理

前言

在查看mybatis源码的时候，只看了处理接口参数那一块，却没有查看后期处理完接口参数的过程（同时也是处理通过SqlSession调用命名空间，如下图所示），通过看了深入了解MyBatis参数这篇文章，我才知道自己的思维是多么局限，这篇文章作者也是《MyBatis从入门到精通》的作者，真正的一位大牛，我重新整理了一下我的这篇博文。代码来源：目前最新稳定版3.4.6

通过接口调用

1.构造方法

MapperMethod进行实例化，构造方法中调用静态内部类MethodSignature构造方法

  public MapperMethod(Class mapperInterface, Method method, Configuration config) {
    this.command = new SqlCommand(config, mapperInterface, method);
    this.method = new MethodSignature(config, mapperInterface, method);
  }

MethodSignature构造方法中调用ParamNameResolver构造方法。

public MethodSignature(Configuration configuration, Class mapperInterface, Method method) {
      Type resolvedReturnType = TypeParameterResolver.resolveReturnType(method, mapperInterface);
      if (resolvedReturnType instanceof Class) {
        this.returnType = (Class) resolvedReturnType;
      } else if (resolvedReturnType instanceof ParameterizedType) {
        this.returnType = (Class) ((ParameterizedType) resolvedReturnType).getRawType();
      } else {
        this.returnType = method.getReturnType();
      }
      //... 省略部分代码
      this.paramNameResolver = new ParamNameResolver(configuration, method);
    }

ParamNameResolver代码介绍：
1. 先遍历所有不是RowBounds或者ResultHandler子类的参数
2. 先判断参数中是否存在@Param注解，存在的话hasParamAnnotation设置true
3. 将有@Param注解的参数的值赋予name
4. 没有注解的将会判断isUseActualParamName是否为true[1]，如果不设置java编译保留参数的话，将默认为arg0，arg1..argn,设置的话为参数本身名称。
5. 如果是false，将得到当前names的大小，设为其值0,1,2,3,4…n。最后将参数位置和名字保存在SortedMap->names中。
举例：
public User getUserByNameAndDep(@Param(“name”)String name,String dep);
处理完之后names为：
如果是3.4.1以及之后版本，isUseActualParamName设置为true，且编译开关打开

0->name
1->dep

如果是3.4.1以及之后版本，isUseActualParamName设置为true，且编译开关未打开

0->name
1->arg1

如果是3.4.1以及之后版本，isUseActualParamName设置为false，或者是3.4.1之前版本

0->name
1->1

注意：索引位置为key，名字相同也不出错，后续的程序将会覆盖，比如：
public User getUserByNameAndDep(@Param(“dep”)String name,String dep);
如果是3.4.1以及之后版本，isUseActualParamName设置为true，且编译开关打开

0->dep
1->dep

  \\...
  private final SortedMap names;
  public ParamNameResolver(Configuration config, Method method) {
    final Class[] paramTypes = method.getParameterTypes();
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    final SortedMap map = new TreeMap();
    int paramCount = paramAnnotations.length;
    // get names from @Param annotations
    for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
      if (isSpecialParameter(paramTypes[paramIndex])) {
        // skip special parameters
        continue;
      }
      String name = null;
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        if (annotation instanceof Param) {
          hasParamAnnotation = true;
          name = ((Param) annotation).value();
          break;
        }
      }
      if (name == null) {
        // @Param was not specified.
        if (config.isUseActualParamName()) {
          name = getActualParamName(method, paramIndex);
        }
        if (name == null) {
          // use the parameter index as the name ("0", "1", ...)
          // gcode issue #71
          name = String.valueOf(map.size());
        }
      }
      map.put(paramIndex, name);
    }
    names = Collections.unmodifiableSortedMap(map);
  }
  \\...
  private static boolean isSpecialParameter(Class clazz) {
    return RowBounds.class.isAssignableFrom(clazz) || ResultHandler.class.isAssignableFrom(clazz);
  }

函数调用

MapperMethod.execute方法中执行Object param = method.convertArgsToSqlCommandParam(args);convertArgsToSqlCommandParam方法中调用ParamNameResolver中的getNamedParams方法：
1. 方法会判断参数是否为null，或者之前构造函数返回的位置和名称map大小是否为空，为空则返回null。
2. 然后判断参数是否存在注解以及参数个数是否为1，为1直接返回这个参数。
3. 之后param会将添加names中的所有key和value，不过位置互换，前面名称，后面参数，相同名称意味着后面的将覆盖前面的。
4. 最后param再判断param是否存在param**n**，不存在则加上GENERIC_NAME_PREFIX + String.valueOf(i + 1)，也就是param1, param2, …和参数。
例如：之前的

0->dep
1->dep

最后param为

dep=Tech
param1=yiibai
param2=Tech

后面的第二个参数覆盖了第一个，若sql语句中使用{dep}，将不是所加注解的第一个参数，而是第二个。

  \\... 省略代码
  private static final String GENERIC_NAME_PREFIX = "param";
  \\...
  public Object getNamedParams(Object[] args) {
    final int paramCount = names.size();
    if (args == null || paramCount == 0) {
      return null;
    } else if (!hasParamAnnotation && paramCount == 1) {
      return args[names.firstKey()];
    } else {
      final Map param = new ParamMap