SqlSessionFactoryBean的构建流程

目的

此文的主旨在于梳理SqlSessionFactoryBean的初始流程，不拘泥于实现细节。

使用

SqlSessionFactoryBean的主要作用便是用来创建SqlSessionFactory，在它的构建过程中会解析MyBatis所需要的配置文件，将所有配置都封装到Configuration类中，最后返回SqlSessionFactory实例。SqlSessionFactoryBean实现了Spring中两个用于初始化Bean的接口FactoryBean、InitializingBean.

InitializingBean定义如下

public interface InitializingBean {
	/**
	 * 此方法在BeanFactory设置了Bean配置里的所有属性后执行。
	 */
	void afterPropertiesSet() throws Exception;
}

我们一般在XML中都会有这么一段配置，如下:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <!-- 注入连接池 -->
  <property name="dataSource" ref="dataSource"/>
  <!--主配置 -->
  <property name="configuration">
    <bean class="org.apache.ibatis.session.Configuration">
      <property name="mapUnderscoreToCamelCase" value="true"/>
    </bean>
  </property>
  <!-- 加载mybatis映射文件 -->
  <property name="mapperLocations" value="classpath:mappers/*.xml"/>
</bean>

上述配置的作用就是让容器创建一个ID为sqlSessionFactory的SqlSessionFactoryBean实例，并且为实例指定了datasource属性，手动指定了主配置对象，开启MyBatis下划线转驼峰的属性配置，并且指定映射文件所在的位置。

注:

虽然指定的是SqlSessionFactoryBean实例，但是因为继承了FactoryBean接口，因此我们从容器拿到的对象实际上是getObject方法返回的对象，即SqlSessionFactory实例。

创建流程

首先自不用说，Spring会创建SqlSessionFactoryBean实例，设置配置的所有属性，这是第一步，接下来便会走afterPropertiesSet()方法。

@Override
public void afterPropertiesSet() throws Exception {
    // 检查数据源
    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。这属于MyBatis本身的内容，不再展开说明。
    this.sqlSessionFactory = buildSqlSessionFactory();
}

创建SqlSessionFactory的过程与MyBatis不同的点主要在与transactionFactory，在创建事务工厂时不再使用MyBatis自带的JdbcTransaction类，而是使用SpringManagedTransactionFactory这个新的事务工厂类，这个事务获取到的连接全部来自于Spring管理，这样把事务全权交给Spring管理，而MyBatis本身不再涉及事务管理。如果在使用Spring时没有配置(使用)事务，那么获取到的连接取决于DataSource，无论拿到的连接是自动提交还是手动提交，MyBatis每一次方法调用都会视情况提交或回滚。当然对于自动提交而言，MyBatis的commit或者rollbakc是不会调用conn.commit()或conn.rollback。

在经过afterPropertiesSet方法后，SqlSessionFactory实例便创建完毕。需要使用SqlSessionFactory实例便会调用getObject方法。

@Override
public SqlSessionFactory getObject() throws Exception {
    if (this.sqlSessionFactory == null) {
        afterPropertiesSet();
    }
    return this.sqlSessionFactory;
}