如何解析Mybatis的实现原理
我觉得最简单的方式看他如何初始化，这里官方文档中入门一章已经介绍了
SqlSessionFactory实例是Mybatis的核心，而SqlSessionFactory实例又是通过SqlSessionFactoryBuilder获得，SqlSesionFactoryBuilder必须从Configuration实例中构建出SqlSesionFactory的实例。Configuration实例怎么获取？从XML配置文件解析完成后各种配置就统一存放在Configuration实例中。所以探究Mybatis的工作原理可以顺着XML配置文件 —> Configuration实例 —> SqlSesionFactoryBuilder —> SqlSessionFactory实例。
这里有两种方式：
从 XML 中构建 SqlSessionFactory
不使用 XML 构建 SqlSessionFactory
- 如果按照官方文档中构建SqlSessionFactory实例的两种方式，直接看SqlSessionFactoryBuilder
- 如果使用Mybatis-spring 配置Mybatis，那就从SqlSessionFactoryBean为入口，这也是最常用的方式，其实里面也是使用官方文档中的方式，只是为了便于集成到Spring中，把它包装成bean的形式
看两种方式的源码
//实现了FactoryBean<SqlSessionFactory>，说明该实例返回的实例及类型是SqlSessionFactory，而不是SqlSessionFactoryBean
//实现了InitializingBean，说明属性值set完后会调用afterPropertiesSet方法初始化
//实现了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");
//默认已经创建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");
//构建sqlSessionFactory 实例
this.sqlSessionFactory = buildSqlSessionFactory();
}
protected SqlSessionFactory buildSqlSessionFactory() throws IOException {
if (this.configuration != null) {
//设置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);
}
//设置objectFactory
if (this.objectFactory != null) {
configuration.setObjectFactory(this.objectFactory);
}
//设置objectWrapperFactory
if (this.objectWrapperFactory != null) {
configuration.setObjectWrapperFactory(this.objectWrapperFactory);
}
//设置vfs
if (this.vfs != null) {
configuration.setVfsImpl(this.vfs);
}
//设置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);
}
}
//注册类型别名，这里的类型如果与上面的重复会抛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);
}
}
//注册类型处理器类，不能与上面有重复
if (!isEmpty(this.typeHandlers)) {
for (TypeHandler<?> typeHandler : this.typeHandlers) {
configuration.getTypeHandlerRegistry().register(typeHandler);
}
}
//注册数据库产品名称Provider，针对不同数据库产品的灵活配置
if (this.databaseIdProvider != null) {
try {
configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
} catch (SQLException e) {
throw new NestedIOException("Failed getting a databaseId", e);
}
}
//设置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();
}
}
//事务工厂,默认使用Spring的SpringManagedTransactionFactory
if (this.transactionFactory == null) {
this.transactionFactory = new SpringManagedTransactionFactory();
}
//设置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算是创建成功了，那下面就分析下上面配置中那些注意点和说明点
- Variables作用
它的作用就相当于一个全局常量表，在解析config和mapper文件中，遇到${}这种表达式的都会，在常量表中查找，找到就替换，没有就保持原样。
它的来源主要在config文件的<properties />节点中声明和SqlSessionFactoryBean中configurationProperties属性值。 - objectFactory作用
用户创建对象，比如传入List.class，利用反射返回ArrayList的实例，默认实现类DefaultObjectFactory - objectWrapperFactory作用
默认实现类DefaultObjectWrapperFactory，包装Object实例，很少使用 - vfs作用
默认实现类DefaultVFS，比如递归出给定URL标识的所有资源的全部路径，如VFS.getInstance().list(".")，传入相对路径。 - typeAliasesPackage和typeAliases
类型别名，前者只需指定包，后者需类全名，指定别名后，在mapper文件和config文件中就可以使用该别名代表类全名了，建议两者只用一种，如果都用，类名不要重复。Mybatis默认注册了很多别名,具体见org.apache.ibatis.session.Configuration - plugins
插件，用于在执行相关操作时，在执行前后插入自定义行为，如缓存，分页等，可指定多个插件，每个插件可拦截指定方法。 - typeHandlersPackage和typeHandlers
类型处理器，Java类型与数据库字段类型之间的转换类，如varchar —> String，Mybatis已经注册了大部分类型处理器，具体见org.apache.ibatis.type.TypeHandlerRegistry - databaseIdProvider
MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性，具体见官方文档说明。 - cache
二级缓存，Mybatis默认开启二级缓存，在一次session中缓存查询的语句和结果，默认PerpetualCache实现，采用LRU方式(LruCache)，在mapper文件中可通过<cache />进行设置 - XMLConfigBuilder解析过程中注意点
<settings /> 元素中的默认值见settingsElement方法
<properties />元素resource和url不能同时设置，否则抛异常，该元素中的配置项全局有效
<typeAliases />package 和typeAlias只能一个有效，package优先
<plugins /> 可以配置多个，每个属性值会调用setProperties方法传入
<environments /> 如果配置了默认使用default中定义的environment，这里建议采用表达式定义，值放在properties文件中，生产，测试各一份，自动根据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变量中，实际调用中mybatis会采用动态代理方式生成代理实例(详见MapperProxyFactory)，代理实例和方法调用过一次就会被缓存起来不会重复生成，由SqlSession调用相关method(详见MapperProxy和MapperMethod)进行具体数据库操作
