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}取出對應的引數值