Mybatis # 和 $ 的区别及参数如何对应

调试 ParamNameResolver.

final Annotation[][] paramAnnotations = method.getParameterAnnotations();

二维数组，第一维是参数长度，第二维是注解个数.

1.看参数上是否有 @Param 注解，有就读取该注解中的值.
2.如果第1步不成立，则看能否获取实际参数名.
3.如果还不行，则是第几个参数(排除特殊参数，例如 RowBound 等).
// 解析方法参数.
public ParamNameResolver(Configuration config, Method method) {
// 获取方法的所有类型
final Class[] paramTypes = method.getParameterTypes();
// 获取参数中的注解.
final Annotation[][] paramAnnotations = method.getParameterAnnotations();
final SortedMap map = new TreeMap<>();
int paramCount = paramAnnotations.length;
// get names from @Param annotations
for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
// 忽略掉 RowBounds 和 ResultHandler 这两类参数.
if (isSpecialParameter(paramTypes[paramIndex])) {
// skip special parameters
continue;
}
String name = null;
// 解析 @Param 注解.
for (Annotation annotation : paramAnnotations[paramIndex]) {
if (annotation instanceof Param) {
hasParamAnnotation = true;
name = ((Param) annotation).value();
break;
}
}
if (name == null) {
// @Param was not specified.
if (config.isUseActualParamName()) {
name = getActualParamName(method, paramIndex);
}
if (name == null) {
// use the parameter index as the name (“0”, “1”, …)
// gcode issue #71
name = String.valueOf(map.size());
}
}
map.put(paramIndex, name);
}
names = Collections.unmodifiableSortedMap(map);
}

如果参数中没有 @Param 注解，且只有一个参数，则返回 arg[0] 即可.
如果有多个参数或有 @Param 注解，则：
等 +

好需要注意一点，我们知道，Mybatis 对于单参数的处理，是直接返回的 args[0]. 这样的话，args[0] 可以是任意类型，例如 Collection 或者 Array.
Mybatis 对单参数的情况进行了包装. 会将参数封装成 map.
map.put(“collection, arg[0]) or map.put(“list”, arg[0])
map.put(“array”, arg[0])

接下来看下 # 和 $ 的区别.

单参数. 压根就不需要管 #{id} 还是 #{name}(和参数名无关)，它会使用占位符，统一替换成 ?，最后通过 PreparedStatement 设置参数即可.

因为它是通过下标设置的.

$ 单参数，必须通过 ${value} 获取参数.
为啥是通过 ${value} 来获取了？可以看下 TextSqlNode 类.
public String handleToken(String content) {
Object parameter = context.getBindings().get("_parameter");
if (parameter == null) {
context.getBindings().put(“value”, null);
} else if (SimpleTypeRegistry.isSimpleType(parameter.getClass())) {
context.getBindings().put(“value”, parameter);
}
Object value = OgnlCache.getValue(content, context.getBindings());
String srtValue = (value == null ? “” : String.valueOf(value)); // issue #274 return “” instead of “null”
checkInjection(srtValue);
return srtValue;
}

或者通过 @Param 注解的话，则使用 ${id} 可以获取. 还是同一段代码，但是这时候 _parameter 就是一个 map 了，所以可以获得值.
public String handleToken(String content) {
Object parameter = context.getBindings().get("_parameter");
if (parameter == null) {
context.getBindings().put(“value”, null);
} else if (SimpleTypeRegistry.isSimpleType(parameter.getClass())) {
context.getBindings().put(“value”, parameter);
}
Object value = OgnlCache.getValue(content, context.getBindings());
String srtValue = (value == null ? “” : String.valueOf(value)); // issue #274 return “” instead of “null”
checkInjection(srtValue);
return srtValue;
}

多参数时，# 或 $ 都是通过 ${param1} ${param2} 或 #{param1} #{param2} 来获取的.