Mybatis-参数处理

如果不清楚Mybatis处理传入的参数列表的过程，那么在给SQL语句设置参数时会频繁遇到问题，最后只能死记硬背来应对各种情况。

1. 该构造方法会获取参数列表中各个参数的参数名，具体获取到的参数名会根据参数前是否有@Param来决定

  public ParamNameResolver(Configuration config, Method method) {
    this.useActualParamName = config.isUseActualParamName();
    final Class<?>[] paramTypes = method.getParameterTypes();
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    //创建一个map来存储参数名信息，索引为键参数名为值
    final SortedMap<Integer, String> map = new TreeMap<>();
    int paramCount = paramAnnotations.length;
    // 遍历传来的参数列表
    for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
      if (isSpecialParameter(paramTypes[paramIndex])) {
        continue;
      }
      String name = null;
      //遍历该参数的所有注解信息
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        //如果该参数含有@Param注解
        if (annotation instanceof Param) {
          hasParamAnnotation = true; //该变量在只有一个参数时起作用，具体见下面分析
          //获取@Param注解中的值
          name = ((Param) annotation).value();
          break;
        }
      }
      //如果该参数不含@Param注解
      if (name == null) {
        // useActualParamName可在配置文件中设置，默认值为true
        /*官网介绍：允许使用方法签名中的名称作为语句参数名称。 
        为了使用该特性，你的项目必须采用Java 8 编译，
        并且加上 -parameters 选项。（新增于 3.4.1）*/
        //如果开启该设置，则参数名为arg0、arg1...
        if (useActualParamName) {
          name = getActualParamName(method, paramIndex);
        }
        //未开启useActualParamName，则参数名为0、1...
        if (name == null) {
          name = String.valueOf(map.size());
        }
      }
      //将参数名信息存入map
      map.put(paramIndex, name);
    }
    names = Collections.unmodifiableSortedMap(map);
  }

2. 该方法用于将1中获取到的参数名与参数列表中的值进行组装

public Object getNamedParams(Object[] args) {
    final int paramCount = names.size();
    //如果参数名列表为空，则返回null
    if (args == null || paramCount == 0) {
      return null;
    }
    //参数名列表长度为1且该参数没有使用@Param注解
    else if (!hasParamAnnotation && paramCount == 1) {
      Object value = args[names.firstKey()];
      //请读者看步骤3
      return wrapToMapIfCollection(value, useActualParamName ? names.get(0) : null);
    } else {
      final Map<String, Object> param = new ParamMap<>();
      int i = 0;
      //遍历参数名列表
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
        //向新创建的map添加以参数名列表中的值为键对应的参数值为值的键值对
        param.put(entry.getValue(), args[entry.getKey()]);
        // add generic param names (param1, param2, ...)
        //创建一个参数名字符串，值为param1、param2...
        final String genericParamName = GENERIC_NAME_PREFIX + (i + 1);
        // ensure not to overwrite parameter named with @Param
        //如果没有参数的@param的值等于上面创建的参数名字符串时，
        //则向新创建的map添加以genericParamName为键对应的参数值为值的键值对
        if (!names.containsValue(genericParamName)) {
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      //返回新的参数map
      return param;
    }
  }

3. 只有一个参数且该参数没有使用@Param注解

  public static Object wrapToMapIfCollection(Object object, String actualParamName) {
    //如果参数为Collection类型，则以collection为键对象为值存入map并返回
    if (object instanceof Collection) {
      ParamMap<Object> map = new ParamMap<>();
      map.put("collection", object);
      //如果参数为List类型，则以list为键对象为值存入map并返回
      if (object instanceof List) {
        map.put("list", object);
      }
      Optional.ofNullable(actualParamName).ifPresent(name -> map.put(name, object));
      return map;
    }
    //如果参数为数组类型，则以array为键对象为值存入map并返回 
    else if (object != null && object.getClass().isArray()) {
      ParamMap<Object> map = new ParamMap<>();
      map.put("array", object);
      Optional.ofNullable(actualParamName).ifPresent(name -> map.put(name, object));
      return map;
    }
    //其他情况就直接返回对象
    return object;
  }

4. 总结
   （1）当Mybatis返回的参数列表时map时，需要根据具体参数名才能获取具体数据。
   （2）尽量使用@Param注解避免出现错误。
   （3）当只有一个参数时，如果不是Collection、List、数组类型，则直接返回对象，如果是其中一个类型的话，Collection参数名为collection，List参数名为List，数组类型参数名为array。