Mybatis获取参数的源码分析

用到的样例mapper接口

public interface UserMapper {
    /**
     * 返回所有的员工信息
     */
    List<User> getAllUser();
    /**
     * 通过用户名去查找一个用户
     */
    User getUserByName(@Param("username") String userName);
    /**
     * 判断用户是否登录成功
     */
    User login(String userName,String password);
//    使用自定义个map作为参数,但是需要提前沟通好具体使用哪一个键
    User login1(Map<String,Object> map);
    /**
     * 添加一个用户
     */
    int addUser(User user);
    /**
     * 使用@Param注解的值作为map中的键，判断用户是否登录成功
     */
    User loginByParam(@Param("userName") String userName,@Param("password") String password);
}

在测试方法中进行测试，并打断点

//测试内容:测试@Param的参数
    @Test
    public void myTest8() throws IOException {
        SqlSession sqlSession=SqlSessionUtils.getSqlSession("mybatis-config.xml", true);
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User hello = mapper.loginByParam("hello", "123456");
        System.out.println(hello);
    }

在调用loginByParam处打断点

 然后步入，

 继续步入之后可以看见

 继续步入

 上面这一步，是将参数的map返回

 

 names的初始化代码

//这里的names是一个集合，键为Int类型，值为String类型
private final SortedMap<Integer, String> names;

  private boolean hasParamAnnotation;

  public ParamNameResolver(Configuration config, Method method) {
    this.useActualParamName = config.isUseActualParamName();
//反射获取该方法的参数的数据类型，返回值是Class数组
    final Class<?>[] paramTypes = method.getParameterTypes();
//这里是获取每一个参数的注解，因为一个参数可能有多个注解，因此是二维数组
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    final SortedMap<Integer, String> map = new TreeMap<>();
    int paramCount = paramAnnotations.length;
    // 对每一个参数的注解进行循环，查看该参数是否存在@Param注解
    for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
      if (isSpecialParameter(paramTypes[paramIndex])) {
        // skip special parameters
        continue;
      }
      String name = null;//用于保存每一次获取的参数名称
//获取一个参数的所有注解，开始查看是否存在@Param注解
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        if (annotation instanceof Param) {
//如果存在，则将hasParamAnnotation置为true，便于后面将默认的键换成注解的值
          hasParamAnnotation = true;
//这里将注解中的value值保存到name中
          name = ((Param) annotation).value();
          break;
        }
      }
//如果不存在@Param，name将给name赋值默认的参数名，如arg0，arg1...
      if (name == null) {
        // @Param was not specified.
        if (useActualParamName) {
            //一般情况下，没有@Param注解的参数的name会在这里赋值成功，也就是arg+对应的参数索引
          name = getActualParamName(method, paramIndex);
        }
        if (name == null) {
            
          // use the parameter index as the name ("0", "1", ...)
          // gcode issue #71
        //这里很巧妙，直接用map中元素的个数的String类型来作为那么，那么name的值会是"0","1",..
          name = String.valueOf(map.size());
        }
      }
//将参数对应的索引作为键，name作为值存入map集合中
      map.put(paramIndex, name);
    }
//然后将map集合赋给names
    names = Collections.unmodifiableSortedMap(map);
  }

因此我们可以知道names中存放的是，[(参数索引,@Param值或者“arg0”，”arg1”...),]

所以我们可以继续分析下面的代码了

public Object getNamedParams(Object[] args) {
    final int paramCount = names.size();//获取参数个数
    //如果参数个数为0，直接返回null
    if (args == null || paramCount == 0) {
      return null;
    }
    //如果参数个数为1，并且没有@Param注解 
    else if (!hasParamAnnotation && paramCount == 1) {
      Object value = args[names.firstKey()];
      return wrapToMapIfCollection(value, useActualParamName ? names.get(0) : null);
    } 
    //这里才是我们要看的情况
    else {
       //这个数组，用来返回真正的参数名和参数值
      final Map<String, Object> param = new ParamMap<>();
      int i = 0;
        //遍历names中每一个entry
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
        //这里将对应的参数索引的参数名称作为键，参数值作为map的值写入集合中，注意，这里的键有可能是"arg0","arg1"，因为如果没有注解的话。但是这不重要，下面也会将param1，param2作为键，写入map集合中
        param.put(entry.getValue(), args[entry.getKey()]);
        // add generic param names (param1, param2, ...)
        //这里是生成param的标识
        final String genericParamName = GENERIC_NAME_PREFIX + (i + 1);
        // ensure not to overwrite parameter named with @Param
        //如果map中不存在该键，那么也插入一份，相当于，这个map中存在两份参数内容
        if (!names.containsValue(genericParamName)) {
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      return param;
    }
  }