Mybatis源码第2天 -- 加载配置。
上篇说到,SqlSession,SqlSession怎么来的?是SqlSessionFactoryBuilder构建出来的。在构建的时候,加载了Mybatis的配置文件。
public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
try {
XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
return build(parser.parse());
} catch (Exception e) {
throw ExceptionFactory.wrapException("Error building SqlSession.", e);
} finally {
ErrorContext.instance().reset();
try {
reader.close();
} catch (IOException e) {
// Intentionally ignore. Prefer previous error.
}
}
}build(parser.parse());
} catch (Exception e) {
throw ExceptionFactory.wrapException("Error building SqlSession.", e);
} finally {
ErrorContext.instance().reset();
try {
reader.close();
} catch (IOException e) {
// Intentionally ignore. Prefer previous error.
}
}
}
还有一处相似的地方,见SqlSessionFactoryBuilder.java.
看build(parse.parse())处。这个parser.parser();就是在加载mybatis-config.xml,和Mapper配置文件。
今天来说一说,加载配置文件。
Mybatis的主要配置文件有两个,mybatis-config.xml和Mapper配置文件。当然还有注解配置的方式。
对于两个xml配置文件。Mybatis提供了两个类来加载。分别是XmlConfigBuilder(加载Mybatis-config.xml)和XmlMapperBuilder(加载Mapper配置文件).
首先看一下parse()这个方法吧。
/**
* 解析mybatis-config.xml
* @return
*/
public Configuration parse() {
// 如果已经解析过就抛出异常。
if (parsed) {
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
parsed = true;
// 正式解析mybatis-config.xml,从configuration根节点开始。
parseConfiguration(parser.evalNode("/configuration"));
return configuration;
}
接下来就是具体的加载各项配置
// 具体加配置
private void parseConfiguration(XNode root) {
try {
// 加载properties节点
propertiesElement(root.evalNode("properties"));
// 加载settings节点。
Properties settings = settingsAsProperties(root.evalNode("settings"));
loadCustomVfs(settings);
// 加载别名。
typeAliasesElement(root.evalNode("typeAliases"));
// 加载插件
pluginElement(root.evalNode("plugins"));
// 加载objectFactory
objectFactoryElement(root.evalNode("objectFactory"));
// 加载ObjectWrapperFactoryElement
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
// 加载reflectorFactory
reflectorFactoryElement(root.evalNode("reflectorFactory"));
settingsElement(settings);
// read it after objectFactory and objectWrapperFactory issue #631
environmentsElement(root.evalNode("environments"));
// 加载databaseIdProvider
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
// 加载typeHandlers
typeHandlerElement(root.evalNode("typeHandlers"));
//加载mapper配置文件。
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
这么看起来有些空洞,,,,为什么药解析这些元素啊?
我还是从网上百度一个比较完成mybatis-config.xml文件吧。
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!--properties-->
<properties resource="org/mybatis/example/config.properties">
<property name="username" value="dev_user"/>
<property name="password" value="F2Fa3!33TYyg"/>
</properties>
<!--settings-->
<settings>
<setting name="cacheEnabled" value="true"/>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="multipleResultSetsEnabled" value="true"/>
<setting name="useColumnLabel" value="true"/>
<setting name="useGeneratedKeys" value="false"/>
<setting name="autoMappingBehavior" value="PARTIAL"/>
<setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
<setting name="defaultExecutorType" value="SIMPLE"/>
<setting name="defaultStatementTimeout" value="25"/>
<setting name="defaultFetchSize" value="100"/>
<setting name="safeRowBoundsEnabled" value="false"/>
<setting name="mapUnderscoreToCamelCase" value="false"/>
<setting name="localCacheScope" value="SESSION"/>
<setting name="jdbcTypeForNull" value="OTHER"/>
<setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>
<!--typeAliases-->
<typeAliases>
<typeAlias alias="Author" type="domain.blog.Author"/>
<typeAlias alias="Blog" type="domain.blog.Blog"/>
<typeAlias alias="Comment" type="domain.blog.Comment"/>
<typeAlias alias="Post" type="domain.blog.Post"/>
<typeAlias alias="Section" type="domain.blog.Section"/>
<typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>
<typeAliases>
<package name="domain.blog"/>
</typeAliases>
<!--typeHandlers-->
<typeHandlers>
<typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>
<typeHandlers>
<package name="org.mybatis.example"/>
</typeHandlers>
<typeHandlers>
<typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="java.math.RoundingMode"/>
</typeHandlers>
<!--objectFactory-->
<objectFactory type="org.mybatis.example.ExampleObjectFactory">
<property name="someProperty" value="100"/>
</objectFactory>
<!--objectWrapperFactory-->
<!--reflectorFactory-->
<!--plugins-->
<plugins>
<plugin interceptor="org.mybatis.example.ExamplePlugin">
<property name="someProperty" value="100"/>
</plugin>
</plugins>
<!--environments-->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC">
<property name="..." value="..."/>
</transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!--databaseIdProvider-->
<databaseIdProvider type="DB_VENDOR" />
<databaseIdProvider type="DB_VENDOR">
<property name="SQL Server" value="sqlserver"/>
<property name="DB2" value="db2"/>
<property name="Oracle" value="oracle" />
</databaseIdProvider>
<!--mappers-->
<mappers>
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
<mapper resource="org/mybatis/builder/BlogMapper.xml"/>
<mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>
<mappers>
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
<mapper url="file:///var/mappers/BlogMapper.xml"/>
<mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<mapper class="org.mybatis.builder.PostMapper"/>
</mappers>
<mappers>
<package name="org.mybatis.builder"/>
</mappers>
</configuration>
重复的节点是不同的配置方式。每个节点只写一次就好。
这样就可以对应这个看了。按照类中方法的顺序。
1.加载properties属性。
/**
* 加载properties节点
* 注意这里并没有加载,properties节点的子节点信息,而是在settingsElement进行加载。
* @param context
* @throws Exception
*/
private void propertiesElement(XNode context) throws Exception {
if (context != null) {
// 获取所有子节点
Properties defaults = context.getChildrenAsProperties();
// 获取resource元素
String resource = context.getStringAttribute("resource");
// 获取url元素
String url = context.getStringAttribute("url");
if (resource != null && url != null) {
throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference. Please specify one or the other.");
}
// 如果resource和url同时配置了的话,不可以同时配置(上面)。
if (resource != null) {
// 将resource对应的文件中的所有属性加载到defaults(Properties)中。
defaults.putAll(Resources.getResourceAsProperties(resource));
} else if (url != null) {
//将url对应的文件中的所有属性加载到defaults(Properties)中。
defaults.putAll(Resources.getUrlAsProperties(url));
}
// 将configuration中的配置和读取的配置合并。
Properties vars = configuration.getVariables();
if (vars != null) {
defaults.putAll(vars);
}
parser.setVariables(defaults);
configuration.setVariables(defaults);
}
}
- 加载Setting节点的配置信息
// 加载settings配置信息。
private Properties settingsAsProperties(XNode context) {
if (context == null) {
return new Properties();
}
// 获取子节点。
Properties props = context.getChildrenAsProperties();
// 检测所有的配置对Configuration类都是已知的。
MetaClass metaConfig = MetaClass.forClass(Configuration.class, localReflectorFactory);
for (Object key : props.keySet()) {
if (!metaConfig.hasSetter(String.valueOf(key))) {
throw new BuilderException("The setting " + key + " is not known. Make sure you spelled it correctly (case sensitive).");
}
}
return props;
}
// 将设置的放到configuration中。
private void loadCustomVfs(Properties props) throws ClassNotFoundException {
String value = props.getProperty("vfsImpl");
if (value != null) {
String[] clazzes = value.split(",");
for (String clazz : clazzes) {
if (!clazz.isEmpty()) {
@SuppressWarnings("unchecked")
Class<? extends VFS> vfsImpl = (Class<? extends VFS>) Resources.classForName(clazz);
configuration.setVfsImpl(vfsImpl);
}
}
}
}
这里有点疑问。loadCustomVfs,这里的Vfs指的是什么??
但是可以看出,这里并没有加载我们在配置文件里面书写的setting,而是以后进行的加载。
3.加载别名
/**
* 解析别名
* 详见:TypeAliasRegistry.java
* @param parent
*/
private void typeAliasesElement(XNode parent) {
if (parent != null) {
// 遍历typeAliases下的所有子节点。
for (XNode child : parent.getChildren()) {
// 如果是子节点的名字是package.
if ("package".equals(child.getName())) {
// 获取子节点中package节点的name元素属性。
String typeAliasPackage = child.getStringAttribute("name");
// 把该包中的所有类设置别名。把类名装换成小写。设置到typeAliasRegistry实体中。
configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
} else {
// 如果不是package,那就是:typeAlias,获取typeAlias的alias属性和type属性值。
String alias = child.getStringAttribute("alias");
String type = child.getStringAttribute("type");
try {
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);
}
}
}
}
}
- 解析插件配置
// 加载插件的配置
private void pluginElement(XNode parent) throws Exception {
if (parent != null) {
for (XNode child : parent.getChildren()) {
// 获取interceptor属性值。
String interceptor = child.getStringAttribute("interceptor");
Properties properties = child.getChildrenAsProperties();
// 利用反射,获取执行拦截器的实例。
Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();
interceptorInstance.setProperties(properties);
// 将拦截添加到configuration中。
// 可想而知,它将拦截器添加到拦截器链中。
configuration.addInterceptor(interceptorInstance);
}
}
}
一下这个几个节点,不知道有什么作用,就暂时一笔带过。
// 加载对象工厂,同plugins逻辑
private void objectFactoryElement(XNode context) throws Exception {
if (context != null) {
String type = context.getStringAttribute("type");
Properties properties = context.getChildrenAsProperties();
ObjectFactory factory = (ObjectFactory) resolveClass(type).newInstance();
factory.setProperties(properties);
configuration.setObjectFactory(factory);
}
}
// 加载对象包装器工厂,同plugins逻辑
private void objectWrapperFactoryElement(XNode context) throws Exception {
if (context != null) {
String type = context.getStringAttribute("type");
ObjectWrapperFactory factory = (ObjectWrapperFactory) resolveClass(type).newInstance();
configuration.setObjectWrapperFactory(factory);
}
}
//加载反射工厂,同plugins逻辑
private void reflectorFactoryElement(XNode context) throws Exception {
if (context != null) {
String type = context.getStringAttribute("type");
ReflectorFactory factory = (ReflectorFactory) resolveClass(type).newInstance();
configuration.setReflectorFactory(factory);
}
}
- 正式加载setting配置文件。
private void settingsElement(Properties props) throws Exception {
// 是否自动映射column和field。默认为只自动映射简单字段,不会映射关联对象。见:AutoMappingBehavior
configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));
//指定检测自动映射目标的未知列(或未知属性类型)时的行为。 就是当column和类字段不一致的时候,mybatis会做些什么?
// 默认为:什么都不做。见:AutoMappingUnknownColumnBehavior
configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));
// 是否启用缓存。默认启用。
configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));
// 反射工厂。
configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));
// 是否延迟加载。
configuration.setLazyLoadingEnabled(booleanValueOf(props.getProperty("lazyLoadingEnabled"), false));
// 是否使用积极的懒加载
configuration.setAggressiveLazyLoading(booleanValueOf(props.getProperty("aggressiveLazyLoading"), false));
// 是否使用多个结果集
configuration.setMultipleResultSetsEnabled(booleanValueOf(props.getProperty("multipleResultSetsEnabled"), true));
// 是否使用列标签
configuration.setUseColumnLabel(booleanValueOf(props.getProperty("useColumnLabel"), true));
// 是否使用主键生成策略
configuration.setUseGeneratedKeys(booleanValueOf(props.getProperty("useGeneratedKeys"), false));
// 使用执行器的类型。
configuration.setDefaultExecutorType(ExecutorType.valueOf(props.getProperty("defaultExecutorType", "SIMPLE")));
// Sql语句执行超时间,默认不超时。
configuration.setDefaultStatementTimeout(integerValueOf(props.getProperty("defaultStatementTimeout"), null));
// 不知道干什么用的。
configuration.setDefaultFetchSize(integerValueOf(props.getProperty("defaultFetchSize"), null));
// 是否自动匹配下划线转换成驼峰命名法。很重要,经常用。
configuration.setMapUnderscoreToCamelCase(booleanValueOf(props.getProperty("mapUnderscoreToCamelCase"), false));
// 是否启动安全的行界。
configuration.setSafeRowBoundsEnabled(booleanValueOf(props.getProperty("safeRowBoundsEnabled"), false));
// 本地缓存范围。默认为Session
configuration.setLocalCacheScope(LocalCacheScope.valueOf(props.getProperty("localCacheScope", "SESSION")));
// 干甚用??
configuration.setJdbcTypeForNull(JdbcType.valueOf(props.getProperty("jdbcTypeForNull", "OTHER")));
// 延迟加载触发器的方法;默认有equals,clone,hashCode,toString
configuration.setLazyLoadTriggerMethods(stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString"));
// 安全结果处理程序已启用 干甚用??
configuration.setSafeResultHandlerEnabled(booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true));
// 默认的脚本语言,干甚用??
configuration.setDefaultScriptingLanguage(resolveClass(props.getProperty("defaultScriptingLanguage")));
// 设置类型处理器。
@SuppressWarnings("unchecked")
Class<? extends TypeHandler> typeHandler = (Class<? extends TypeHandler>) resolveClass(props.getProperty("defaultEnumTypeHandler"));
configuration.setDefaultEnumTypeHandler(typeHandler);
// 在属性值为null的是否调用call。难道是为null是就不会调用set方法。。
configuration.setCallSettersOnNulls(booleanValueOf(props.getProperty("callSettersOnNulls"), false));
// 使用实际参数。
configuration.setUseActualParamName(booleanValueOf(props.getProperty("useActualParamName"), true));
// 是否返回空行实例。默认为false。
configuration.setReturnInstanceForEmptyRow(booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false));
// log前缀。
configuration.setLogPrefix(props.getProperty("logPrefix"));
// 设置答应log。
@SuppressWarnings("unchecked")
Class<? extends Log> logImpl = (Class<? extends Log>) resolveClass(props.getProperty("logImpl"));
configuration.setLogImpl(logImpl);
// 设置配置工厂。
configuration.setConfigurationFactory(resolveClass(props.getProperty("configurationFactory")));
}
/**
* 读取环境元素
* @param context
* @throws Exception
*/
private void environmentsElement(XNode context) throws Exception {
// 对应着xml文件来看:
if (context != null) {
if (environment == null) {
environment = context.getStringAttribute("default");
}
// 读取所有的<environments>子节点
for (XNode child : context.getChildren()) {
String id = child.getStringAttribute("id");
// 只读取设置好的default,或者初始化时设置好的环境
if (isSpecifiedEnvironment(id)) {
TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
DataSource dataSource = dsFactory.getDataSource();
Environment.Builder environmentBuilder = new Environment.Builder(id)
.transactionFactory(txFactory)
.dataSource(dataSource);
configuration.setEnvironment(environmentBuilder.build());
}
}
}
}
- 加载DB类别提供者,,可以根据不同的db类型,打印不同的query语句。
/**
* 加载 DB id Provider 元素
* DB-id-Provider: 不同数据库支持者。
* @param context
* @throws Exception
*/
private void databaseIdProviderElement(XNode context) throws Exception {
DatabaseIdProvider databaseIdProvider = null;
if (context != null) {
String type = context.getStringAttribute("type");
// awful patch to keep backward compatibility
if ("VENDOR".equals(type)) {
type = "DB_VENDOR";
}
Properties properties = context.getChildrenAsProperties();
databaseIdProvider = (DatabaseIdProvider) resolveClass(type).newInstance();
databaseIdProvider.setProperties(properties);
}
Environment environment = configuration.getEnvironment();
if (environment != null && databaseIdProvider != null) {
String databaseId = databaseIdProvider.getDatabaseId(environment.getDataSource());
configuration.setDatabaseId(databaseId);
}
}
8.加载类型处理器
/**
* 加载类型处理器
* @param parent
* @throws Exception
*/
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);
}
}
}
}
}
加载mapper映射文件:
/**
* 加载mapper映射文件。
* @param parent
* @throws Exception
*/
private void mapperElement(XNode parent) throws Exception {
if (parent != null) {
for (XNode child : parent.getChildren()) {
if ("package".equals(child.getName())) {
String mapperPackage = child.getStringAttribute("name");
configuration.addMappers(mapperPackage);
} else {
String resource = child.getStringAttribute("resource");
String url = child.getStringAttribute("url");
String mapperClass = child.getStringAttribute("class");
if (resource != null && url == null && mapperClass == null) {
ErrorContext.instance().resource(resource);
InputStream inputStream = Resources.getResourceAsStream(resource);
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
mapperParser.parse();
} else if (resource == null && url != null && mapperClass == null) {
ErrorContext.instance().resource(url);
InputStream inputStream = Resources.getUrlAsStream(url);
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
mapperParser.parse();
} else if (resource == null && url == null && mapperClass != null) {
Class<?> mapperInterface = Resources.classForName(mapperClass);
configuration.addMapper(mapperInterface);
} else {
throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
}
}
}
}
}
好了,这样这个加载mybatis-config.xml的类就看完了。
### 最后
如果你觉得写的还不错,就关注下公众号呗,关注后,有点小礼物回赠给你。
你可以获得5000+电子书,java,springCloud,adroid,python等各种视频教程,IT类经典书籍,各种软件的安装及破解教程。
希望一块学习,一块进步!
还没有评论,来说两句吧...