如何解析Mybatis的實現(xiàn)原理
我覺得最簡單的方式看他如何初始化跛锌，這里官方文檔中入門一章已經(jīng)介紹了
SqlSessionFactory實例是Mybatis的核心，而SqlSessionFactory實例又是通過SqlSessionFactoryBuilder獲得柏靶，SqlSesionFactoryBuilder必須從Configuration實例中構(gòu)建出SqlSesionFactory的實例。Configuration實例怎么獲取您炉？從XML配置文件解析完成后各種配置就統(tǒng)一存放在Configuration實例中原在。所以探究Mybatis的工作原理可以順著XML配置文件 —> Configuration實例 —> SqlSesionFactoryBuilder —> SqlSessionFactory實例友扰。
這里有兩種方式：
從 XML 中構(gòu)建 SqlSessionFactory
不使用 XML 構(gòu)建 SqlSessionFactory
- 如果按照官方文檔中構(gòu)建SqlSessionFactory實例的兩種方式，直接看SqlSessionFactoryBuilder
- 如果使用Mybatis-spring 配置Mybatis庶柿，那就從SqlSessionFactoryBean為入口村怪，這也是最常用的方式，其實里面也是使用官方文檔中的方式浮庐，只是為了便于集成到Spring中甚负，把它包裝成bean的形式
看兩種方式的源碼
//實現(xiàn)了FactoryBean<SqlSessionFactory>，說明該實例返回的實例及類型是SqlSessionFactory，而不是SqlSessionFactoryBean
//實現(xiàn)了InitializingBean梭域，說明屬性值set完后會調(diào)用afterPropertiesSet方法初始化
//實現(xiàn)了ApplicationListener<ApplicationEvent>斑举，說明會將ApplicationEvent注入到該bean中
public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {
//省略set方法
@Override
public void afterPropertiesSet() throws Exception {
//必須配置dataSource
notNull(dataSource, "Property 'dataSource' is required");
//默認已經(jīng)創(chuàng)建SqlSessionFactoryBuilder實例，一般不用配置
notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");
//configuration實例和configLocation不能同時配置
state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null),
"Property 'configuration' and 'configLocation' can not specified with together");
//構(gòu)建sqlSessionFactory 實例
this.sqlSessionFactory = buildSqlSessionFactory();
}
protected SqlSessionFactory buildSqlSessionFactory() throws IOException {
if (this.configuration != null) {
//設(shè)置Variable病涨，Variable的作用后面再講
configuration = this.configuration;
if (configuration.getVariables() == null) {
configuration.setVariables(this.configurationProperties);
} else if (this.configurationProperties != null) {
configuration.getVariables().putAll(this.configurationProperties);
}
} else if (this.configLocation != null){
//解析mybatis-config.xml
xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
configuration = xmlConfigBuilder.getConfiguration();
}else {
configuration = new Configuration();
configuration.setVariables(this.configurationProperties);
}
//設(shè)置objectFactory
if (this.objectFactory != null) {
configuration.setObjectFactory(this.objectFactory);
}
//設(shè)置objectWrapperFactory
if (this.objectWrapperFactory != null) {
configuration.setObjectWrapperFactory(this.objectWrapperFactory);
}
//設(shè)置vfs
if (this.vfs != null) {
configuration.setVfsImpl(this.vfs);
}
//設(shè)置typeAliasesPackage富玷，類型別名包
if (hasLength(this.typeAliasesPackage)) {
//多個包名可以用，或既穆；或制表符或換行符分隔
String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage,
ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
//注冊別名包
for (String packageToScan : typeAliasPackageArray) {
configuration.getTypeAliasRegistry().registerAliases(packageToScan,
typeAliasesSuperType == null ? Object.class : typeAliasesSuperType);
}
}
//注冊類型別名赎懦，這里的類型如果與上面的重復(fù)會拋TypeException異常
if (!isEmpty(this.typeAliases)) {
for (Class<?> typeAlias : this.typeAliases) {
configuration.getTypeAliasRegistry().registerAlias(typeAlias);
}
}
//注冊插件
if (!isEmpty(this.plugins)) {
for (Interceptor plugin : this.plugins) {
configuration.addInterceptor(plugin);
}
}
//注冊類型處理器包名
if (hasLength(this.typeHandlersPackage)) {
String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage,
ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
for (String packageToScan : typeHandlersPackageArray) {
configuration.getTypeHandlerRegistry().register(packageToScan);
}
}
//注冊類型處理器類，不能與上面有重復(fù)
if (!isEmpty(this.typeHandlers)) {
for (TypeHandler<?> typeHandler : this.typeHandlers) {
configuration.getTypeHandlerRegistry().register(typeHandler);
}
}
//注冊數(shù)據(jù)庫產(chǎn)品名稱Provider循衰，針對不同數(shù)據(jù)庫產(chǎn)品的靈活配置
if (this.databaseIdProvider != null) {
try {
configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
} catch (SQLException e) {
throw new NestedIOException("Failed getting a databaseId", e);
}
}
//設(shè)置cache
if (this.cache != null) {
configuration.addCache(this.cache);
}
//解析mybatis-config.xml文件
if (xmlConfigBuilder != null) {
try {
xmlConfigBuilder.parse();
} catch (Exception ex) {
throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex);
} finally {
ErrorContext.instance().reset();
}
}
//事務(wù)工廠,默認使用Spring的SpringManagedTransactionFactory
if (this.transactionFactory == null) {
this.transactionFactory = new SpringManagedTransactionFactory();
}
//設(shè)置Environment
configuration.setEnvironment(new Environment(this.environment, this.transactionFactory, this.dataSource));
if (!isEmpty(this.mapperLocations)) {
for (Resource mapperLocation : this.mapperLocations) {
if (mapperLocation == null) {
continue;
}
try {
//解析Mapper文件
XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
configuration, mapperLocation.toString(), configuration.getSqlFragments());
xmlMapperBuilder.parse();
} catch (Exception e) {
throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
} finally {
ErrorContext.instance().reset();
}
}
}
return this.sqlSessionFactoryBuilder.build(configuration);
}
到這里sqlSessionFactory算是創(chuàng)建成功了铲敛，那下面就分析下上面配置中那些注意點和說明點
- Variables作用
它的作用就相當于一個全局常量表，在解析config和mapper文件中会钝，遇到${}這種表達式的都會伐蒋，在常量表中查找，找到就替換迁酸，沒有就保持原樣先鱼。
它的來源主要在config文件的<properties />節(jié)點中聲明和SqlSessionFactoryBean中configurationProperties屬性值。 - objectFactory作用
用戶創(chuàng)建對象奸鬓，比如傳入List.class焙畔，利用反射返回ArrayList的實例，默認實現(xiàn)類DefaultObjectFactory - objectWrapperFactory作用
默認實現(xiàn)類DefaultObjectWrapperFactory串远，包裝Object實例宏多，很少使用 - vfs作用
默認實現(xiàn)類DefaultVFS，比如遞歸出給定URL標識的所有資源的全部路徑澡罚，如VFS.getInstance().list(".")伸但，傳入相對路徑。 - typeAliasesPackage和typeAliases
類型別名留搔，前者只需指定包更胖，后者需類全名，指定別名后隔显，在mapper文件和config文件中就可以使用該別名代表類全名了却妨，建議兩者只用一種，如果都用括眠，類名不要重復(fù)彪标。Mybatis默認注冊了很多別名,具體見org.apache.ibatis.session.Configuration - plugins
插件，用于在執(zhí)行相關(guān)操作時掷豺，在執(zhí)行前后插入自定義行為捞烟，如緩存账锹，分頁等，可指定多個插件坷襟，每個插件可攔截指定方法。 - typeHandlersPackage和typeHandlers
類型處理器生年，Java類型與數(shù)據(jù)庫字段類型之間的轉(zhuǎn)換類婴程，如varchar —> String，Mybatis已經(jīng)注冊了大部分類型處理器抱婉，具體見org.apache.ibatis.type.TypeHandlerRegistry - databaseIdProvider
MyBatis 可以根據(jù)不同的數(shù)據(jù)庫廠商執(zhí)行不同的語句档叔，這種多廠商的支持是基于映射語句中的 databaseId 屬性，具體見官方文檔說明蒸绩。 - cache
二級緩存衙四，Mybatis默認開啟二級緩存，在一次session中緩存查詢的語句和結(jié)果患亿，默認PerpetualCache實現(xiàn)传蹈，采用LRU方式(LruCache)，在mapper文件中可通過<cache />進行設(shè)置 - XMLConfigBuilder解析過程中注意點
<settings /> 元素中的默認值見settingsElement方法
<properties />元素resource和url不能同時設(shè)置步藕，否則拋異常惦界，該元素中的配置項全局有效
<typeAliases />package 和typeAlias只能一個有效，package優(yōu)先
<plugins /> 可以配置多個咙冗，每個屬性值會調(diào)用setProperties方法傳入
<environments /> 如果配置了默認使用default中定義的environment沾歪，這里建議采用表達式定義，值放在properties文件中雾消，生產(chǎn)灾搏，測試各一份，自動根據(jù)properties文件切換立润。
<typeHandlers />package和typeHandler同時配置只有一個有效狂窑，默認package
<mappers/> package和mapper同時配置只有一個生效，默認package - mapperLocations與Mapper文件解析
mapperLocations 中可定義classpath:mapper/*.xml這樣的值范删，spring會找到每個xml文件并進行解析蕾域。Mapper文件中select|insert|update|delete以XMLStatementBuilder類的形式保存在configuration的incompleteStatements變量中，cacheRef 保存在configuration的cacheRef中到旦，namespace|cache|parameterMap|resultMap|sql 保存在builderAssistant(XMLMapperBuilder類)中旨巷，Mapper接口保存在mapperRegistry變量中，實際調(diào)用中mybatis會采用動態(tài)代理方式生成代理實例(詳見MapperProxyFactory)添忘，代理實例和方法調(diào)用過一次就會被緩存起來不會重復(fù)生成采呐，由SqlSession調(diào)用相關(guān)method(詳見MapperProxy和MapperMethod)進行具體數(shù)據(jù)庫操作
