Mybatis原始碼第2天 -- 載入配置。
阿新 • • 發佈：2019-02-18
上篇說到，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. } } }
還有一處相似的地方，見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); } }
2. 載入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); } } } } }
3. 解析外掛配置
// 載入外掛的配置 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); } }
5. 正式載入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()); } } } }
7. 載入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的類就看完了。