29、ParamNameResolver参数解析

处理接口形式的入参

在使用MyBatis时，有两种使用方法。
- 一种是使用的接口形式，
- 另一种是通过SqlSession调用命名空间。

这两种方式在传递参数时是不一样的，命名空间的方式更直接

ParamNameResolver

主要用来处理接口形式的参数，最后会把参数处放在一个map中

map的key为参数的位置，value为参数的名字

字段

  private static final String GENERIC_NAME_PREFIX = "param";
 private final SortedMap<Integer, String> names;//存放参数的位置和对应的参数名
  private boolean hasParamAnnotation;//是否使用param注解

对names字段的解释
- Method(@Param("M") int a, @Param("N") int b)转化为map为{{0, "M"}, {1, "N"}}
- Method(int a, int b)转化为map为{{0, "0"}, {1, "1"}}
- aMethod(int a, RowBounds rb, int b)转化为map为{{0, "0"}, {2, "1"}}

构造方法

public ParamNameResolver(Configuration config, Method method) {
    final Class<?>[] paramTypes = method.getParameterTypes();
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    final SortedMap<Integer, String> map = new TreeMap<Integer, String>();
    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);
  }

构造方法的会经历如下的步骤
1. 通过反射得到方法的参数类型和方法的参数注解注解，method.getParameterAnnotations()方法返回的是注解的二维数组，每一个方法的参数包含一个注解数组。
2. 遍历所有的参数
- 首先判断这个参数的类型是否是特殊类型,RowBounds和ResultHandler，是的话跳过，咱不处理
- 判断这个参数是否是用来Param注解，如果使用的话name就是Param注解的值，并把name放到map中，键为参数在方法中的位置，value为Param的值
- 如果没有使用Param注解,判断是否开启了UseActualParamName，如果开启了，则使用java8的反射得到方法的名字，此处容易造成异常，
具体原因参考上一篇博文.
- 如果以上条件都不满足的话,则这个参数的名字为参数的下标

方法

此类有意非常重要的方法getNamedParams

 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<String, Object> param = new ParamMap<Object>();
      int i = 0;
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
        param.put(entry.getValue(), args[entry.getKey()]);
        // add generic param names (param1, param2, ...)
        final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
        // ensure not to overwrite parameter named with @Param
        if (!names.containsValue(genericParamName)) {
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      return param;
    }
  }

• 只有一个参数时，返回这一个参数
• 最后解析为{“paramName”，“paramValue”}的形式
  例如

  Author selectAuthForBlog(@Param("id") Integer id,@Param("name") String name );

传入的参数是[1,"张三"]
最后解析的map为{“id”:”1”,”“name”:”张三”}

Author selectAuthForBlog( Integer id,@Param("name") String name );

传入的参数是[1,"张三"]
最后解析的map为{“param1”:”1”,”“name”:”张三”}