MyBatis参数名称解析器-ParamNameResolver解析

ParamNameResolver

ParamNameResolver是一个参数名解析器，负责把方法的参数按顺序解析出来并进行标注

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

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

 

package org.apache.ibatis.reflection;
 
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.binding.MapperMethod.ParamMap;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
 
public class ParamNameResolver {
  // 通用参数名称前缀
  private static final String GENERIC_NAME_PREFIX = "param";
  // key是索引，value是参数的名称。
  // 如果指定了名称，则从@Param中获得。如果未指定@Param，则使用参数索引。
  // 注意，当方法具有特殊参数(如RowBounds或ResultHandler)时，该索引可能与实际索引不同。
  // Method(@Param("M") int a, @Param("N") int b)转化为map为{{0, "M"}, {1, "N"}}
  // Method(int a, int b)转化为map为{{0, "0"}, {1, "1"}}
  // Method(int a, RowBounds rb, int b)转化为map为{{0, "0"}, {2, "1"}}
  // 有序映射 存储参数名称
  private final SortedMap<Integer, String> names;
  // 是否使用@Param注解标志
  private boolean hasParamAnnotation;
  // 构造方法
  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])) {
        // 跳过特殊参数
        continue;
      }
      String name = null;
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        if (annotation instanceof Param) {
          hasParamAnnotation = true;
          name = ((Param) annotation).value();
          break;
        }
      }
      if (name == null) {
        // 没有指定@Param
        if (config.isUseActualParamName()) {
          name = getActualParamName(method, paramIndex);
        }
        if (name == null) {
          // 使用参数索引作为名称("0"，"1"，…)
          name = String.valueOf(map.size());
        }
      }
      map.put(paramIndex, name);
    }
    names = Collections.unmodifiableSortedMap(map);
  }
  // 获取实际参数名称
  private String getActualParamName(Method method, int paramIndex) {
    return ParamNameUtil.getParamNames(method).get(paramIndex);
  }
  // 是不是特殊参数()
  private static boolean isSpecialParameter(Class<?> clazz) {
    return RowBounds.class.isAssignableFrom(clazz) || ResultHandler.class.isAssignableFrom(clazz);
  }
 
  /**
   * 返回SQL引用的参数名。
   */
  public String[] getNames() {
    return names.values().toArray(new String[0]);
  }
 
  /**
   * 返回一个没有名称的非特殊参数。
   * 使用命名规则命名多个参数
   * 除了默认名称之外，该方法还添加通用名称(paraml、param2、...).
   */
  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;
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
        param.put(entry.getValue(), args[entry.getKey()]);
        // 添加通用参数名称（参数、参数 2...）
        final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
        // /确保没有覆盖以@Param命名的参数
        if (!names.containsValue(genericParamName)) {
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      return param;
    }
  }
}

 

 

 

 

总结

指定@Param情况下

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

 

不指定@Param情况下

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

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

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

 

不指定指定-parameters

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

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

 

 

只有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);
 

 

 

通用

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