ParamNameResolver 参数名称解析器

本版本3.5.2 

* <li>aMethod(@Param("M") int a, @Param("N") int b) -&gt; {{0, "M"}, {1, "N"}}</li>
* <li>aMethod(int a, int b) -&gt; {{0, "0"}, {1, "1"}}</li>
* <li>aMethod(int a, RowBounds rb, int b) -&gt; {{0, "0"}, {2, "1"}}</li>

ParamNameResolver 

• 如果指定了@Param，则返回@Param的value
• 如果没有指定@Param，返回具体的变量名  (为了使用该特性，设置useActualParamName=true（默认的），你的项目必须采用 Java 8 编译，并且加上 <code>-parameters</code> 选项。（新增于 3.4.1）)
• 未指定-parameters，可以通过arg0、arg1、arg2这种方式来访问

 public ParamNameResolver(Configuration config, Method method) {
    final Class<?>[] paramTypes = method.getParameterTypes();
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    final SortedMap<Integer, String> 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) { // 使用@Param注解
          hasParamAnnotation = true;
          name = ((Param) annotation).value();
          break;
        }
      }
      if (name == null) { // @Param没指定
        // @Param was not specified.
        if (config.isUseActualParamName()) { // useActualParamName=true  默认true
          name = getActualParamName(method, paramIndex); // 使用实际的变量名
        }
        if (name == null) { // useActualParamName = false
          // 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);
  }

 

 @Param

# aMethod(@Param("M") int a, @Param("N") int b) 
# 结果 {{0, "M"}, {1, "N"}}
# a.和param1.是相等的
# username.和param2.是相等的
void addAccountNoId1(@Param("a") Account account,@Param("username")String username);

 

ParamNameResolver 

自动添加param1、param2、param{n}等变量

/** 会自动添加param1、param2，...访问变量
   * <p>
   * A single non-special parameter is returned without a name.
   * Multiple parameters are named using the naming rule.
   * In addition to the default names, this method also adds the generic names (param1, param2,
   * ...).
   * </p>
   */
  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<>();
      int i = 0; //初始化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); //也就是从param1开始
        // ensure not to overwrite parameter named with @Param
        if (!names.containsValue(genericParamName)) { // 不存在，则添加
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      return param;
    }
  }

 

parameterMappings

MetaObject

 

 

 

不指定@Param，使用-parameters新特性

# 这里使用#{account.id} #{username}
void addAccountNoId3(Account account, String username);

         允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 <code>-parameters</code> 选项。（新增于 3.4.1）
 

默认useActualParamName=true

 

不指定@Param 并且 不指定-parameters

就得不到上面的account和username，得到具体的方法参数名是arg0、arg1、arg{n}

 

总结

指定@Param情况下

通过@Param("username")的value访问  比如#{username}

 

不指定@Param情况下

Java 8 编译，并且指定-parameters，并且mybatis版本3.4.1及之后版本

@Insert("insert into account(username,phone,createTime) values(#{username},#{phone},#{createTime})")
void addAccountNoId22(String username, String phone, Date createTime);

可以通过具体的参数变量名来访问，比如#{username}

不指定指定-parameters

@Insert("insert into account(username,phone,createTime) values(#{arg0},#{arg1},#{arg2})")
void addAccountNoId1(String username,String phone,Date createTime);

可以通过第1个参数 #{arg0}  、第2个参数#{arg1}，以此类推来访问

 

只有1个参数情况下

未指定@Param，可以通过任何变量来访问

@Insert("insert into account(username) values(#{abc})")
void addAccountOne(String username);

指定了@Param，就不能访问了

# 注意，本条语句会报错
@Insert("insert into account(username) values(#{abc})")
void addAccountOne1(@Param("username") String username);

 args[names.firstKey()] = 具体的值

 

通用

不管哪种模式下，在有多个参数情况下，都可以通过第1个参数#{param1}、第2个参数#{param2}，以此类推来访问