Mybatis源码分析: MapperMethod功能讲解(1)

Mybatis源码分析: MapperMethod功能讲解(1)

      MapperMethod主要的功能是执行SQL的相关操作,在初始化时会实例化两个组件Sql命令(SqlCommand)和方法签名(MethodSignature)这两个组件会在后续进行详解,同时MapperMethod必须提供Mapper的接口路径,待执行的方法,配置Configuration作为入参。通过获取SqlCommand中的执行类型,MapperMethod才知道该Mapper接口将要执行什么样的操作。构造方法如下所示:

public MapperMethod(Class<?> mapperInterface, Method method, Configuration config) {
//初始化SqlCommand
this.command = new SqlCommand(config, mapperInterface, method);
//初始化方法签名
this.method = new MethodSignature(config, mapperInterface, method);
}

Mybatis中定义了5种操作：SELECT,INSERT，UPDATE，DELETE，FLUSH。其中SELECT中包含了5中查询,结果类型处理器，返回NULL值,多条记录查询,单记录查询,游标查询,和map查询。相关操作和方法如下表对应。从表中可以看到,Sql执行方式本质上时通过sqlSession调用的,在SELECT操作中,虽然调用了MapperMethod中的方法,但本质上仍是通过Sqlsession下的select(),selectList(),selectCursor(),selectMap()等方法实现的。

操作	方法名
INSERT	sqlSession.insert()
UPDATE	sqlSession.update()
DELETE	sqlSession.delete()
FLUSH	sqlSession.flushStatements()
SELECT	executeWithResultHandler(sqlSession, args) executeForMany(sqlSession, args) method.returnsMap() executeForCursor() sqlSession.selectOne(command.getName(), param)

---

public Object execute(SqlSession sqlSession, Object[] args) {
Object result;
//判断命令类型
switch (command.getType()) {
case INSERT: {
//将参数转为Sql参数
Object param = method.convertArgsToSqlCommandParam(args);
//获取插入结果
result = rowCountResult(sqlSession.insert(command.getName(), param));
break;
}
case UPDATE: {
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.update(command.getName(), param));
break;
}
case DELETE: {
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.delete(command.getName(), param));
break;
}
case SELECT:
if (method.returnsVoid() && method.hasResultHandler()) {
//带有结果处理器的
executeWithResultHandler(sqlSession, args);
result = null;
} else if (method.returnsMany()) {
//多条查询
result = executeForMany(sqlSession, args);
} else if (method.returnsMap()) {
//返回map
result = executeForMap(sqlSession, args);
} else if (method.returnsCursor()) {
//游标查询
result = executeForCursor(sqlSession, args);
} else {
//单条查询
Object param = method.convertArgsToSqlCommandParam(args);
result = sqlSession.selectOne(command.getName(), param);
}
break;
case FLUSH:
//清除操作
result = sqlSession.flushStatements();
break;
default:
throw new BindingException("Unknown execution method for: " + command.getName());
}
if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
throw new BindingException("Mapper method '" + command.getName() 
+ " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
}
return result;
}

参数解析器

     在上述代码中经常能看见这样一句代码 method.convertArgsToSqlCommandParam(args);，该方法主要的功能是获取@Param注解上的参数值,而实现方式便是通过参数解析器(ParamNameResolver),convertArgsToSqlCommandParam(args)方法实际上调用的是ParamNameResolver下的getNamedParams(args)方法。在分析该方法之前,先看看构造器都做了些什么操作。

public ParamNameResolver(Configuration config, Method method) {
final Class<?>[] paramTypes = method.getParameterTypes(); //获取所有参数类型
final Annotation[][] paramAnnotations = method.getParameterAnnotations();//获取方法中的所有注解
final SortedMap<Integer, String> map = new TreeMap<Integer, String>();
//判断注解数组长度
int paramCount = paramAnnotations.length;
// get names from @Param annotations
for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
if (isSpecialParameter(paramTypes[paramIndex])) {
// skip special parameters
continue;
}
String name = null;
for (Annotation annotation : paramAnnotations[paramIndex]) {
//判断是否是Param标签的子类,也就是说@param中是否存在value值
if (annotation instanceof Param) {
hasParamAnnotation = true;
//获取标签中的value值
name = ((Param) annotation).value();
break;
}
}
if (name == null) {
// @Param was not specified.
//是否使用了真实值,也就是说没有设置value值
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);
}

      构造器同样需要两个入参,配置类和方法名,ParamNameResolver下包含了两个属性字段GENERIC_NAME_PREFIX属性前缀和参数集合names,构造器会将Method中所有参数级别的注解全部解析出来方法有序参数集中,names中存储形式为<参数下标，参数名>,如果在注解上设置了参数名,则会直接获取注解的value值,如果没有使用@Param注解,则使用真实的参数名,注意，真实参数名其实是arg0，arg1....的形式展现的,在判断真实参数名时,Mybatis会检查JDK版本是否包含java.lang.reflect.Parameter类,不存在该类的化会抛出ClassNotFoundException异常。 完成初始化后,就可以调用getNamedParams(args)方法了,如下代码所示,该方法使用了类中的names属性,从有序集合中取出所有的<参数索引,参数名>键值对>,随后填充到另外一个集合中,以<参数名,参数下标索引,>形式呈现,同时会保留一份<param+下标索引,参数下标>的键值对。

public Object getNamedParams(Object[] args) {
//判断参数个数
final int paramCount = names.size();
if (args == null || paramCount == 0) {
return null;
}
//返回首个参数 
else if (!hasParamAnnotation && paramCount == 1) {
return args[names.firstKey()];
} else {
final Map<String, Object> param = new ParamMap<Object>();
int i = 0;
for (Map.Entry<Integer, String> entry : names.entrySet()) {
//设置参数的值和键名
param.put(entry.getValue(), args[entry.getKey()]);
// add generic param names (param1, param2, ...)
//增加参数名
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;
}
}

需掌握的知识点

• Method类的使用,常用的方法

方法名	作用
getName()	获取方法名
isVarArgs()	如果该方法声明为采用可变数量的参数，则返回true; 否则返回false
getModifiers()	获取权限修饰符
getReturnType()	获取返回类型
getExceptionTypes()	获取所有抛出的异常类型
getGenericReturnType ()	返回Type类型
getParameterTypes()	获取所有参数的类型
getParameterCount()	获取所有参数的个数
getAnnotations()	获取方法级别的注解

---

• 集合的使用

Collections.unmodifiableSortedMap(map);可修饰为一个不可变的集合

如何实现自定义注解,并对注解进行解析

见实现自定义注解,并对注解进行解析 文章