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”:”張三”}

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章