最近在*Mybatis*的學習中對于映射語句中的參數注釋設定有點犯迷糊，于是在*debug*下跟蹤了下源代碼，發現*Mybatis*在接口方法映射語句中會做如下處理：
1. 接口方法隻有一個參數
1.1 不使用`@Param`注解
1.1.1 參數為基本類型或為基本包裝類型(int,Integer,String...)
參數注釋為: #{任意字元}
1.1.2 參數為自定義對象
參數注釋為: #{對象屬性}
示例：
User getUserById(int id);
// 注：該中情況下'任意字元'不能為空，否則報錯
// select * from where id = #{任意字元}
select * from
User getUser(User user); // user.getName user.getAge
select * from
1.2 使用`@Param`注解
1.2.1 參數為基本類型或為基本包裝類型(int,Integer,String...)
參數注釋為: #{注解名稱} | #{param1}
1.2.2 參數為自定義對象
參數注釋為: #{注解名稱.對象屬性} | #{param1.對象屬性}
示例：
User getUserById(@Param(value="keyId") int id);
select * from where id = #{keyId}
// or
select * from
User getUser(@Param(value="usr") User user); // user.getName user.getAge
select * from
// or
select * from
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].對象屬性}
示例：
User getUser(String name, int age);
select * from
// or
select * from
User getUser(User usr, int flag);
select * from
// or
select * from
2.2 使用`@Param`注解
2.2.1 參數為基本類型或為基本包裝類型(int,Integer,String...)
參數注釋為: #{注解名稱} | #{param[1..n]}
2.2.2 參數為自定義對象
參數注釋為: #{注解名稱.對象屬性} | #{param[1..n].對象屬性}
示例：
User getUser(@Param(value="xm") String name, @Param(value="nl") int age);
select * from
// or
select * from
// or
select * from
User getUser(@Param(value="usr") User user, @Param(value="tag") int flag);
select * from
// or
select * from
// or
select * from
2.2.3 部分參數使用`@Param`注解
當采用部分參數使用`@Param`注解時，參數注釋為将以上兩種情況結合起來即可。
示例：
User getUser(String name, @Param(value="nl") age, int gendar);
// 對于age的通路不能是 #{1} 隻能是 #{param2} | #{nl}
select * from
總結下
`@Param`的作用是設定參數别名。設定後的參數隻能通過`#{param[1..n]`或者`#{注解别名}`來通路
多個參數情況下，均可使用 `#{參數位置[0..n-1]}` |`#{param[1..n]}`來通路參數
最後給出幾個源代碼中關于參數設定的源代碼供大家參考：
參數擷取操作：org.apache.ibatis.binding.MapperMethod.getParam(Object[] args)
private Object getParam(Object[] args) {
final int paramCount = paramPositions.size();
// 無參數
if (args == null || paramCount == 0) {
return null;
// 無注解并參數個數為1
} else if (!hasNamedParameters && paramCount == 1) {
return args[paramPositions.get(0)];
} else {
Map param = new MapperParamMap();
for (int i = 0; i < paramCount; i++) {
param.put(paramNames.get(i), args[paramPositions.get(i)]);
}
// issue #71, add param names as param1, param2...but ensure backward compatibility
// 這就是 #{param[1..n]} 的來源
for (int i = 0; i < paramCount; i++) {
String genericParamName = "param" + String.valueOf(i + 1);
if (!param.containsKey(genericParamName)) {
param.put(genericParamName, args[paramPositions.get(i)]);
}
}
return param;
}
}
SQL預編譯參數設定：org.apache.ibatis.executor.parameter.DefaultParameterHandler.setParameters(PreparedStatement ps) throws SQLException
org.apache.ibatis.executor.parameter.DefaultParameterHandler.setParameters(PreparedStatement ps) throws SQLException
public void setParameters(PreparedStatement ps)
throws SQLException {
ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
List parameterMappings = boundSql.getParameterMappings();
if (parameterMappings != null) {
MetaObject metaObject = parameterObject == null ? null : configuration.newMetaObject(parameterObject);
for (int i = 0; i < parameterMappings.size(); i++) {
ParameterMapping parameterMapping = parameterMappings.get(i);
if (parameterMapping.getMode() != ParameterMode.OUT) {
Object value;
String propertyName = parameterMapping.getProperty();
PropertyTokenizer prop = new PropertyTokenizer(propertyName);
if (parameterObject == null) {
value = null;
} else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
value = parameterObject;
} else if (boundSql.hasAdditionalParameter(propertyName)) {
value = boundSql.getAdditionalParameter(propertyName);
} else if (propertyName.startsWith(ForEachSqlNode.ITEM_PREFIX)
&& boundSql.hasAdditionalParameter(prop.getName())) {
value = boundSql.getAdditionalParameter(prop.getName());
if (value != null) {
value = configuration.newMetaObject(value).getValue(propertyName.substring(prop.getName().length()));
}
} else {
value = metaObject == null ? null : metaObject.getValue(propertyName);
}
TypeHandler typeHandler = parameterMapping.getTypeHandler();
if (typeHandler == null) {
throw new ExecutorException("There was no TypeHandler found for parameter " + propertyName + " of statement " + mappedStatement.getId());
}
JdbcType jdbcType = parameterMapping.getJdbcType();
if (value == null && jdbcType == null) jdbcType = configuration.getJdbcTypeForNull();
typeHandler.setParameter(ps, i + 1, value, jdbcType);
}
}
}
}