來源：http://blog.csdn.net/oxcow/article/details/8024717/

最近在*Mybatis*的學習中對於對映語句中的引數註釋設定有點犯迷糊，於是在*debug*下跟蹤了下原始碼，發現*Mybatis*在介面方法對映語句中會做如下處理：

1. 介面方法只有一個引數

1.1 不使用`@Param`註解

1.1.1 引數為基本型別或為基本包裝型別(int,Integer,String...)

    引數註釋為: #{任意字元}
   
1.1.2 引數為自定義物件

    引數註釋為: #{物件屬性}

示例：

1. <span mce_style="font-size: medium;"
    style="font-size:14px; ">    User getUserById(int id);  
2.         // 注：該中情況下'任意字元'不能為空，否則報錯
3.         // select * from <TABEL> where id = #{任意字元}
4.         select * from <TABLE> where id = #{id}  
5.     User getUser(User user); // user.getName user.getAge
6.         select * from <TABLE> where name = #{name} and age = #{age}</span>  

1.2 使用`@Param`註解

1.2.1 引數為基本型別或為基本包裝型別(int,Integer,String...)

    引數註釋為: #{註解名稱} | #{param1}
   
1.2.2 引數為自定義物件

    引數註釋為: #{註解名稱.物件屬性} | #{param1.物件屬性}
   
示例：

1. <span mce_style="font-size: medium;" style="font-size:14px; ">    User getUserById(@Param(value="keyId") int id);  
2.         select * from <TABEL> where id = #{keyId}  
3.         // or
4.         select * from <TABLE> where id = #{param1}  
5.     User getUser(@Param(value="usr") User user); // user.getName user.getAge
6.         select * from <TABLE> where name = #{user.name} and age = #{user.age}  
7.         // or
8.         select * from <TABLE> where name = #{param1.name} and age = #{param1.age}</span>  

 
2. 介面方法有兩個及兩個以上引數

2.1 不使用`@Param`註解

2.1.1 引數為基本型別或為基本包裝型別(int,Integer,String...)

    引數註釋為: #{引數位置[0..n-1]} | #{param[1..n]}
   
2.1.2 引數為自定義物件

    引數註釋為: #{引數位置[0..n-1].物件屬性} | #{param[1..n].物件屬性}

示例：

1. <span mce_style="font-size: medium;" style="font-size:14px; ">    User getUser(String name, int age);  
2.         select * from <TABLE> where name = #{0} and age = #{1}  
3.         // or
4.         select * from <TABLE> where name = #{param1} and age = #{param2}  
5.     User getUser(User usr, int flag);  
6.         select * from <TABLE> where name = #{0.name} and age = {0.age} and flag = #{1}  
7.         // or
8.         select * from <TABLE> where name = #{param1.name} and age = {param1.age} and flag = #{param2}</span>  

2.2 使用`@Param`註解

2.2.1 引數為基本型別或為基本包裝型別(int,Integer,String...)

    引數註釋為: #{註解名稱} | #{param[1..n]}
   
2.2.2 引數為自定義物件

    引數註釋為: #{註解名稱.物件屬性} | #{param[1..n].物件屬性}

示例：

1. <span mce_style="font-size: medium;" style="font-size:14px; ">    User getUser(@Param(value="xm") String name, @Param(value="nl") int age);  
2.         select * from <TABLE> where name = #{xm} and age = #{nl}  
3.         // or
4.         select * from <TABLE> where name = #{param1} and age = #{param2}  
5.         // or
6.         select * from <TABLE> where name = #{xm} and age = #{param2}  
7.     User getUser(@Param(value="usr") User user, @Param(value="tag") int flag);  
8.         select * from <TABLE> where name = #{usr.name} and age = #{usr.age} and flag = #{tag}  
9.         // or
10.         select * from <TABLE> where name = #{param1.name} and age = #{param1.age} and flag = #{param2}  
11.         // or
12.         select * from <TABLE> where name = #{usr.name} and age = #{param1.age} and flag = #{param2}</span>  

 
2.2.3 部分引數使用`@Param`註解

當採用部分引數使用`@Param`註解時，引數註釋為將以上兩種情況結合起來即可。

示例：

1. <span mce_style="font-size: medium;" style="font-size:14px; ">User getUser(String name, @Param(value="nl") age, int gendar);  
2. // 對於age的訪問不能是 #{1} 只能是 #{param2} | #{nl}
3. select * from <TABLE> where name = #{0} and age = #{nl} and gendar = #{param3)</span>  

總結下

• `@Param`的作用是設定引數別名。設定後的引數只能通過`#{param[1..n]`或者`#{註解別名}`來訪問

• 多個引數情況下，均可使用  `#{引數位置[0..n-1]}` |   `#{param[1..n]}`來訪問引數

最後給出幾個原始碼中關於引數設定的原始碼供大家參考：

引數獲取操作：org.apache.ibatis.binding.MapperMethod.getParam(Object[] args)

1. <span mce_style="font-size: medium;" style="font-size:14px; ">    private Object getParam(Object[] args) {  
2.         finalint paramCount = paramPositions.size();  
3.         // 無引數
4.         if (args == null || paramCount == 0) {  
5.             returnnull;  
6.         // 無註解並引數個數為1
7.         } elseif (!hasNamedParameters && paramCount == 1) {  
8.             return args[paramPositions.get(0)];  
9.         } else {  
10.             Map<String, Object> param = new MapperParamMap<Object>();  
11.             for (int i = 0; i < paramCount; i++) {  
12.                 param.put(paramNames.get(i), args[paramPositions.get(i)]);  
13.         }  
14.         // issue #71, add param names as param1, param2...but ensure backward compatibility
15.         // 這就是 #{param[1..n]} 的來源
16.         for (int i = 0; i < paramCount; i++) {  
17.             String genericParamName = "param" + String.valueOf(i + 1);  
18.             if (!param.containsKey(genericParamName)) {  
19.                 param.put(genericParamName, args[paramPositions.get(i)]);  
20.             }  
21.         }  
22.         return param;  
23.         }  
24.     }</span>  

SQL預編譯引數設定：org.apache.ibatis.executor.parameter.DefaultParameterHandler.setParameters(PreparedStatement ps) throws SQLException  

1. <span mce_style="font-size: medium;" style="font-size:14px; ">org.apache.ibatis.executor.parameter.DefaultParameterHandler.setParameters(PreparedStatement ps) throws SQLException  
2.     publicvoid setParameters(PreparedStatement ps)  
3.       throws SQLException {  
4.         ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());  
5.         List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();  
6.         if (parameterMappings != null) {  
7.             MetaObject metaObject = parameterObject == null ? null : configuration.newMetaObject(parameterObject);  
8.             for (int i = 0; i < parameterMappings.size(); i++) {  
9.                 ParameterMapping parameterMapping = parameterMappings.get(i);  
10.                 if (parameterMapping.getMode() != ParameterMode.OUT) {  
11.                     Object value;  
12.                     String propertyName = parameterMapping.getProperty();  
13.                     PropertyTokenizer prop = new PropertyTokenizer(propertyName);  
14.                     if (parameterObject == null) {  
15.                         value = null;  
16.                     } elseif (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {  
17.                         value = parameterObject;  
18.                     } elseif (boundSql.hasAdditionalParameter(propertyName)) {  
19.                         value = boundSql.getAdditionalParameter(propertyName);  
20.                     } elseif (propertyName.startsWith(ForEachSqlNode.ITEM_PREFIX)  
21.               && boundSql.hasAdditionalParameter(prop.getName())) {  
22.                         value = boundSql.getAdditionalParameter(prop.getName());  
23.                         if (value != null) {  
24.                             value = configuration.newMetaObject(value).getValue(propertyName.substring(prop.getName().length()));  
25.                         }  
26.                 } else {  
27.                     value = metaObject == null ? null : metaObject.getValue(propertyName);  
28.                 }  
29.                 TypeHandler typeHandler = parameterMapping.getTypeHandler();  
30.                 if (typeHandler == null) {  
31.                     thrownew ExecutorException("There was no TypeHandler found for parameter " + propertyName + " of statement " + mappedStatement.getId());  
32.                 }  
33.                 JdbcType jdbcType = parameterMapping.getJdbcType();  
34.                 if (value == null && jdbcType == null) jdbcType = configuration.getJdbcTypeForNull();  
35.                     typeHandler.setParameter(ps, i + 1, value, jdbcType);  
36.                 }  
37.             }  
38.         }  
39.     }</span>