Mybatis的处理参数源码分析和方法传参取参分析

一、Mybatis中解析参数传递的源码分析

首先，当查询数据库语句mapper.getEmpByIdAndLastName(1, "tom");执行时，会调用Mybatis包中MapperProxy.invoke()方法，然后按照顺序执行；

流程：

注：先进入Mybatis包中MapperProxy.invoke()方法，然后按顺序执行，以下1和2两步是其中的主要代码片段讲解

1、准备names

Mybatis包中的ParamNameResolver类的构造方法时用来解析参数封装map的；
//1、names：{0=id, 1=lastName}；构造器的时候就确定好了

   确定流程：
   1.获取每个标了param注解的参数的@Param的值：id，lastName；赋值给name;
   2.每次解析一个参数给map中保存信息：（key：参数索引，value：name的值）
       name的值：
           标注了param注解：注解的值
           没有标注：
               1.全局配置：useActualParamName（jdk1.8）：name=参数名
               2.name=map.size()；相当于当前元素的索引
   {0=id, 1=lastName,2=2}

args【1，"Tom",'hello'】:

2、Mybatis包中的ParamNameResolver类的getNamedParams（）方法（）的执行

public Object getNamedParams(Object[] args) {
final int paramCount = names.size();
//1、参数为null直接返回
if (args == null || paramCount == 0) {
return null;

//2、如果只有一个元素，并且没有Param注解；args[0]：单个参数直接返回
} else if (!hasParamAnnotation && paramCount == 1) {
return args[names.firstKey()];

//3、多个元素或者有Param标注
} else {
final Map<String, Object> param = new ParamMap<Object>();
int i = 0;

//4、遍历names集合；{0=id, 1=lastName,2=2}
for (Map.Entry<Integer, String> entry : names.entrySet()) {

   //names集合的value作为key; names集合的key又作为取值的参考args[0]:args【1，"Tom"】:
   //eg:{id=args[0]:1,lastName=args[1]:Tom,2=args[2]}
param.put(entry.getValue(), args[entry.getKey()]);


// add generic param names (param1, param2, ...)param
//额外的将每一个参数也保存到map中，使用新的key：param1...paramN
//效果：有Param注解可以#{指定的key}，或者#{param1}
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;
}
}
}

二、单个参数与多个参数的处理

单个参数：mybatis不会做特殊处理，#{参数名/任意名}：取出参数值。

当传入一个参数时，不会封装为map，mapper.xml中可以任意取值，即#{key}，key任意写都可以取到值

多个参数：mybatis会做特殊处理。多个参数会被封装成一个map，
key：param1...paramN,或者参数的索引也可以
value：传入的参数值
取值：#{}就是从map中获取指定的key的值；如#{param1}或#{0}来取值

当查询参数较多时可以封装为map，为了不混乱，我们可以使用@Param来指定封装时使用的key；此时，mybatis会自动封装为map;

如： (@Param("idParam")Integer id,@Param("lastName")String lastName); #{idParam}就可以取出map中的值；

如：

public Employee getEmp(@Param("id")Integer id,String lastName);
取值：id==>#{id/param1} lastName==>#{param2}

public Employee getEmp(Integer id,@Param("e")Employee emp);
取值：id==>#{param1} lastName===>#{param2.lastName/e.lastName}

##特别注意：如果是Collection（List、Set）类型或者是数组，也会特殊处理。也是把传入的list或者数组封装在map中。
key：Collection（collection）,如果是List还可以使用这个key(list)，数组(array)来接收值；如#{list},#{array}

这里是使用的mybatis中的别名机制，如List默认的别名是list, 数组Array默认的别名是array;可百度查看mybatis中默认的其他别名
public Employee getEmpById(List<Integer> ids);
取值：取出第一个id的值： #{list[0]}

public Long getEmp(@Param("id")Integer id,@Param("stringlist")List<String> list);

取值： #{id}

<foreach collection="stringlist" index="index" item="item" open="(" separator="," close=")">
#{item.lastName}
</foreach>

更为详细的例子可参考：http://www.cnblogs.com/mingyue1818/p/3714162.html

三、对于封装传入参数的建议

POJO：
如果多个参数正好是我们业务逻辑的数据模型，我们就可以直接传入pojo；
#{属性名}：取出传入的pojo的属性值

Map：
如果多个参数不是业务模型中的数据，没有对应的pojo，不经常使用，为了方便，我们也可以传入map
#{key}：取出map中对应的值

TO：
如果多个参数不是业务模型中的数据，但是经常要使用，推荐来编写一个TO（Transfer Object）数据传输对象
Page{
int index;
int size;
}

四、异常处理

操作：
方法：public Employee getEmpByIdAndLastName(Integer id,String lastName);
取值：#{id},#{lastName}

可能会出现以下异常：
   org.apache.ibatis.binding.BindingException:
   Parameter 'id' not found.
   Available parameters are [1, 0, param1, param2]

解决办法：

明确指定封装参数时map的key；@Param("id")
   多个参数时mybatis会自动封装成一个map，
       key：使用@Param注解指定的值
       value：参数值
   #{指定的key}取出对应的参数值