Mybatis初始化
Mybatis初始化流程就是组装Configuration对象的过程,在这个过程中主要就是初始化环境变量和初始化Mapper.xml的映射。大致流程如下:
-
SqlSessionFactoryBuilder.build(Reader reader):根据mybatis-config.xml配置文件简历SqlSessionFactory的时候会去触发生成XMLConfigBuilder对象解析配置并生成SqlSessionFactory。
public class SqlSessionFactoryBuilder {
public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
//生成配置解析对象
XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
//根据配置,解析配置生成SqlSessionFactory对象
return build(parser.parse());
}//创建SqlSessionFactory对象 public SqlSessionFactory build(Configuration config) { return new DefaultSqlSessionFactory(config);
}
} -
XMLConfigBuilder.parse():开始了解析config配置文件并且初始化。
public Configuration parse() {
if (parsed) {
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
parsed = true;
//解析config配置文件
parseConfiguration(parser.evalNode("/configuration"));
return configuration;
}//解析config配置文件
private void parseConfiguration(XNode root) {
try {
//解析properties文件里面的参数,譬如数据库地址和用户密码这些
propertiesElement(root.evalNode("properties"));
//解析mybatis环境参数的配置
Properties settings = settingsAsProperties(root.evalNode("settings"));
loadCustomVfs(settings);
//解析类型别名的配置
typeAliasesElement(root.evalNode("typeAliases"));
//解析插件的配置
pluginElement(root.evalNode("plugins"));
objectFactoryElement(root.evalNode("objectFactory"));
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
reflectorFactoryElement(root.evalNode("reflectorFactory"));
settingsElement(settings);
//解析环境的配置,譬如多数据库名称
environmentsElement(root.evalNode("environments"));
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
//解析类型处理器的配置
typeHandlerElement(root.evalNode("typeHandlers"));
//mapper.xml文件的解析
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
下面挑几个关键的配置解析进行讲解:
- typeAliasesElement(root.evalNode("typeAliases")):类型别名的解析,在Mapper.xml里面的namespace中会去使用到。
private void typeAliasesElement(XNode parent) {
if (parent != null) {
for (XNode child : parent.getChildren()) {
//如果直接是个包的话就把该包的所有类都注册到typeAliasRegistry中
if ("package".equals(child.getName())) {
String typeAliasPackage = child.getStringAttribute("name");
configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
} else {
String alias = child.getStringAttribute("alias");
String type = child.getStringAttribute("type");
try {
//加载类的class文件到方法区生成Class对象
Class<?> clazz = Resources.classForName(type);
if (alias == null) {
typeAliasRegistry.registerAlias(clazz);
} else {
typeAliasRegistry.registerAlias(alias, clazz);
}
} catch (ClassNotFoundException e) {
throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
}
}
}
}
}typeHandlerElement(root.evalNode("typeHandlers")); - typeHandlerElement(root.evalNode("typeHandlers")):类型处理器解析,在设置参数和转换结果的时候会用到,在后面再仔细讲解下TypeHandler的使用。
private void typeHandlerElement(XNode parent) throws Exception {
if (parent != null) {
for (XNode child : parent.getChildren()) {
//如果元素是个包的话就把这个包里的所有类型处理器注册进去
if ("package".equals(child.getName())) {
String typeHandlerPackage = child.getStringAttribute("name");
typeHandlerRegistry.register(typeHandlerPackage);
} else {
String javaTypeName = child.getStringAttribute("javaType");
String jdbcTypeName = child.getStringAttribute("jdbcType");
String handlerTypeName = child.getStringAttribute("handler");
Class<?> javaTypeClass = resolveClass(javaTypeName);
JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
Class<?> typeHandlerClass = resolveClass(handlerTypeName);
if (javaTypeClass != null) {
if (jdbcType == null) {
typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
} else {
typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
}
} else {
typeHandlerRegistry.register(typeHandlerClass);
}
}
}
}
} - mapperElement((root.evalNode("mappers"))):mapper.xml文件解析
public void parse() {
if (!configuration.isResourceLoaded(resource)) {
configurationElement(parser.evalNode("/mapper"));
configuration.addLoadedResource(resource);
//这里是解析具体的每个Mapper.xml映射文件并生成MapperProxyFactory
bindMapperForNamespace();
}
//这里去最终处理resultMap标签,因为在解析的时候如果有依赖其他的标签的话会暂停
parsePendingResultMaps();
//这里去最终处理Cache标签,因为在解析的时候如果有依赖其他的标签的话会暂停
parsePendingCacheRefs();
//这里去最终处理select等标签,因为在解析的时候如果有依赖其他的标签的话会暂停
parsePendingStatements();
}
通过namespace定义的名称类型,生成对应的MapperProxyFactory并注册到Configuration的MapperRegistry内,最后的Mapper接口是通过MapperProxyFactory生成。Mapper.xml里面的很多元素是有依赖的,并且xml文件是按顺序进行解析的,所以在解析到有依赖的元素时便把当前的元素置为incomplete并且放到列表里面(incompleteStatements、incompleteCacheRefs、incompleteResultMaps和incompleteMethods),然后去解析后续元素,等后面再最终去处理这些元素。