mybatis-spring 是 MyBatis 的一個子項目，用于幫助開發者將 MyBatis 無縫集成到 Spring 中。它允許 MyBatis 參與到 Spring 的事務管理中，創建映射器 mapper 和 SqlSession 并注入到 Spring bean 中。

SqlSessionFactoryBean

在 MyBatis 的基礎用法中，是通過 SqlSessionFactoryBuilder 來創建 SqlSessionFactory，最終獲得執行接口 SqlSession 的，而在 mybatis-spring 中，則使用 SqlSessionFactoryBean 來創建。其使用方式如下：

  @Bean
  public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
    // 設置配置文件路徑
    bean.setConfigLocation(new ClassPathResource("config/mybatis-config.xml"));
    // 別名轉化類所在的包
    bean.setTypeAliasesPackage("com.wch.domain");
    // 設置數據源
    bean.setDataSource(dataSource);
    // 設置 mapper 文件路徑
    bean.setMapperLocations(new ClassPathResource("mapper/*.xml"));
    // 獲取 SqlSessionFactory 對象
    return bean.getObject();
  }

SqlSessionFactoryBean 實現了 FactoryBean 接口，因此可以通過其 getObject 方法獲取 SqlSessionFactory 對象。

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

    return this.sqlSessionFactory;
  }

  @Override
  public void afterPropertiesSet() throws Exception {
    notNull(dataSource, "Property 'dataSource' is required");
    notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");
    state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null),
      "Property 'configuration' and 'configLocation' can not specified with together");

    this.sqlSessionFactory = buildSqlSessionFactory();
  }

  protected SqlSessionFactory buildSqlSessionFactory() throws Exception {

    final Configuration targetConfiguration;

    XMLConfigBuilder xmlConfigBuilder = null;
    if (this.configuration != null) {
      // 使用已配置的全局配置對象和附加屬性
      targetConfiguration = this.configuration;
      if (targetConfiguration.getVariables() == null) {
        targetConfiguration.setVariables(this.configurationProperties);
      } else if (this.configurationProperties != null) {
        targetConfiguration.getVariables().putAll(this.configurationProperties);
      }
    } else if (this.configLocation != null) {
      // 使用配置文件路徑加載全局配置
      xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
      targetConfiguration = xmlConfigBuilder.getConfiguration();
    } else {
      // 新建全局配置對象
      LOGGER.debug(
        () -> "Property 'configuration' or 'configLocation' not specified, using default MyBatis Configuration");
      targetConfiguration = new Configuration();
      Optional.ofNullable(this.configurationProperties).ifPresent(targetConfiguration::setVariables);
    }

    // 設置對象創建工廠、對象包裝工廠、虛擬文件系統實現
    Optional.ofNullable(this.objectFactory).ifPresent(targetConfiguration::setObjectFactory);
    Optional.ofNullable(this.objectWrapperFactory).ifPresent(targetConfiguration::setObjectWrapperFactory);
    Optional.ofNullable(this.vfs).ifPresent(targetConfiguration::setVfsImpl);

    // 以包的維度注冊別名轉換器
    if (hasLength(this.typeAliasesPackage)) {
      // 掃描之類包下的符合條件的類對象
      scanClasses(this.typeAliasesPackage, this.typeAliasesSuperType).stream()
        // 過濾匿名類
        .filter(clazz -> !clazz.isAnonymousClass())
        // 過濾接口
        .filter(clazz -> !clazz.isInterface())
        // 過濾成員類
        .filter(clazz -> !clazz.isMemberClass()).
        // 注冊別名轉換器
        forEach(targetConfiguration.getTypeAliasRegistry()::registerAlias);
    }

    // 以類的維度注冊別名轉換器
    if (!isEmpty(this.typeAliases)) {
      Stream.of(this.typeAliases).forEach(typeAlias -> {
        // 注冊類對象到別名轉換器
        targetConfiguration.getTypeAliasRegistry().registerAlias(typeAlias);
        LOGGER.debug(() -> "Registered type alias: '" + typeAlias + "'");
      });
    }

    // 設置插件
    if (!isEmpty(this.plugins)) {
      Stream.of(this.plugins).forEach(plugin -> {
        targetConfiguration.addInterceptor(plugin);
        LOGGER.debug(() -> "Registered plugin: '" + plugin + "'");
      });
    }

    // 以包的維度注冊類型轉換器
    if (hasLength(this.typeHandlersPackage)) {
      // 掃描指定包下 TypeHandler 的子類
      scanClasses(this.typeHandlersPackage, TypeHandler.class).stream().
        // 過濾匿名類
        filter(clazz -> !clazz.isAnonymousClass())
        // 過濾接口
        .filter(clazz -> !clazz.isInterface())
        // 過濾抽象類
        .filter(clazz -> !Modifier.isAbstract(clazz.getModifiers()))
        // 注冊類對象到類型轉換器
        .forEach(targetConfiguration.getTypeHandlerRegistry()::register);
    }

    // 以類的維度注冊類型轉換器
    if (!isEmpty(this.typeHandlers)) {
      Stream.of(this.typeHandlers).forEach(typeHandler -> {
        // 注冊類對象到類型轉換器
        targetConfiguration.getTypeHandlerRegistry().register(typeHandler);
        LOGGER.debug(() -> "Registered type handler: '" + typeHandler + "'");
      });
    }

    // 注冊腳本語言驅動
    if (!isEmpty(this.scriptingLanguageDrivers)) {
      Stream.of(this.scriptingLanguageDrivers).forEach(languageDriver -> {
        targetConfiguration.getLanguageRegistry().register(languageDriver);
        LOGGER.debug(() -> "Registered scripting language driver: '" + languageDriver + "'");
      });
    }
    Optional.ofNullable(this.defaultScriptingLanguageDriver)
      .ifPresent(targetConfiguration::setDefaultScriptingLanguage);

    // 配置數據庫產品識別轉換器
    if (this.databaseIdProvider != null) {// fix #64 set databaseId before parse mapper xmls
      try {
        targetConfiguration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
      } catch (SQLException e) {
        throw new NestedIOException("Failed getting a databaseId", e);
      }
    }

    // 設置緩存配置
    Optional.ofNullable(this.cache).ifPresent(targetConfiguration::addCache);

    // 如果設置了配置文件路徑，則解析并加載到全局配置中
    if (xmlConfigBuilder != null) {
      try {
        xmlConfigBuilder.parse();
        LOGGER.debug(() -> "Parsed configuration file: '" + this.configLocation + "'");
      } catch (Exception ex) {
        throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex);
      } finally {
        ErrorContext.instance().reset();
      }
    }

    // 設置數據源環境
    targetConfiguration.setEnvironment(new Environment(this.environment,
      this.transactionFactory == null ? new SpringManagedTransactionFactory() : this.transactionFactory,
      this.dataSource));

    // 解析 xml statement 文件
    if (this.mapperLocations != null) {
      if (this.mapperLocations.length == 0) {
        LOGGER.warn(() -> "Property 'mapperLocations' was specified but matching resources are not found.");
      } else {
        for (Resource mapperLocation : this.mapperLocations) {
          if (mapperLocation == null) {
            continue;
          }
          try {
            XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
              targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments());
            xmlMapperBuilder.parse();
          } catch (Exception e) {
            throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
          } finally {
            ErrorContext.instance().reset();
          }
          LOGGER.debug(() -> "Parsed mapper file: '" + mapperLocation + "'");
        }
      }
    } else {
      LOGGER.debug(() -> "Property 'mapperLocations' was not specified.");
    }

    // 創建 sql 會話工廠
    return this.sqlSessionFactoryBuilder.build(targetConfiguration);
  }

buildSqlSessionFactory 方法會分別對配置文件、別名轉換類、mapper 文件等進行解析，逐步配置全局配置對象，并最終調用 SqlSessionFactoryBuilder 創建 SqlSessionFactory 對象。

SqlSessionTemplate

在前章分析 MyBatis 接口層時說到 SqlSessionManager 通過 JDK 動態代理為每個線程創建不同的 SqlSession 來解決 DefaultSqlSession 的線程不安全問題。mybatis-spring 的實現與 SqlSessionManager 大致相同，但是其提供了更好的方式與 Spring 事務集成。

SqlSessionTemplate 實現了 SqlSession 接口，但是都是委托給成員對象 sqlSessionProxy 來實現的。sqlSessionProxy 在構造方法中使用 JDK 動態代理初始化為代理類。

  public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType,
      PersistenceExceptionTranslator exceptionTranslator) {

    notNull(sqlSessionFactory, "Property 'sqlSessionFactory' is required");
    notNull(executorType, "Property 'executorType' is required");

    this.sqlSessionFactory = sqlSessionFactory;
    this.executorType = executorType;
    this.exceptionTranslator = exceptionTranslator;
    this.sqlSessionProxy = (SqlSession) newProxyInstance(SqlSessionFactory.class.getClassLoader(),
        new Class[] { SqlSession.class }, new SqlSessionInterceptor());
  }

sqlSessionProxy 的代理邏輯如下。

  private class SqlSessionInterceptor implements InvocationHandler {
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
      // 獲取 sqlSession
      SqlSession sqlSession = getSqlSession(SqlSessionTemplate.this.sqlSessionFactory,
          SqlSessionTemplate.this.executorType, SqlSessionTemplate.this.exceptionTranslator);
      try {
        // 執行原始調用
        Object result = method.invoke(sqlSession, args);
        if (!isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
          // 如果事務沒有交給外部事務管理器管理，進行提交
          sqlSession.commit(true);
        }
        return result;
      } catch (Throwable t) {
        Throwable unwrapped = unwrapThrowable(t);
        if (SqlSessionTemplate.this.exceptionTranslator != null && unwrapped instanceof PersistenceException) {
          // 異常為 PersistenceException，使用配置的 exceptionTranslator 來包裝異常
          closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
          sqlSession = null;
          Throwable translated = SqlSessionTemplate.this.exceptionTranslator
              .translateExceptionIfPossible((PersistenceException) unwrapped);
          if (translated != null) {
            unwrapped = translated;
          }
        }
        throw unwrapped;
      } finally {
        if (sqlSession != null) {
          // 關閉 sql session
          closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
        }
      }
    }
  }

獲取 SqlSession

在執行原始調用前會先根據 SqlSessionUtils#getSqlSession 方法獲取 SqlSession，如果通過事務同步管理器 TransactionSynchronizationManager 獲取不到 SqlSession，就會使用 SqlSessionFactory 新建一個 SqlSession，并嘗試將獲取的 SqlSession 注冊到 TransactionSynchronizationManager 中。

  public static SqlSession getSqlSession(SqlSessionFactory sessionFactory, ExecutorType executorType,
      PersistenceExceptionTranslator exceptionTranslator) {

    // SqlSessionFactory 和 ExecutorType 參數不可為 null
    notNull(sessionFactory, NO_SQL_SESSION_FACTORY_SPECIFIED);
    notNull(executorType, NO_EXECUTOR_TYPE_SPECIFIED);

    // 嘗試從事務同步管理器中獲取 SqlSessionHolder
    SqlSessionHolder holder = (SqlSessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);

    // 獲取 SqlSession
    SqlSession session = sessionHolder(executorType, holder);
    if (session != null) {
      return session;
    }

    // 新建 SqlSession
    LOGGER.debug(() -> "Creating a new SqlSession");
    session = sessionFactory.openSession(executorType);

    // 將新建的 SqlSession 注冊到事務同步管理器中
    registerSessionHolder(sessionFactory, executorType, exceptionTranslator, session);

    return session;
  }

事務同步管理器

每次獲取 SqlSession 時是新建還是從事務同步管理器中獲取決于事務同步管理器是否開啟。事務同步管理器用于維護當前線程的同步資源，如判斷當前線程是否已經開啟了一個事務就需要查詢事務同步管理器，以便后續根據事務傳播方式決定是新開啟一個事務或加入當前事務。Spring 支持使用注解開啟事務或編程式事務。

注解開啟事務

在 Spring 工程中可以通過添加 EnableTransactionManagement 注解來開啟 Spring 事務管理。EnableTransactionManagement 注解的參數 mode = AdviceMode.PROXY 默認指定了加載代理事務管理器配置 ProxyTransactionManagementConfiguration，在此配置中其默認地對使用 Transactional 注解的方法進行 AOP 代理。在代理邏輯中，會調用 AbstractPlatformTransactionManager#getTransaction 方法獲取當前線程對應的事務，根據當前線程是否有活躍事務、事務傳播屬性等來配置事務。如果是新創建事務，就會調用 TransactionSynchronizationManager#initSynchronization 方法來初始化當前線程在事務同步管理器中的資源。

編程式事務

編程開啟事務的方式與注解式其實是一樣的，區別在于編程式需要手動開啟事務，其最終也會為當前線程在事務同步管理器中初始化資源。

  // 手動開啟事務
  TransactionStatus txStatus = transactionManager.getTransaction(new DefaultTransactionDefinition());
  try {
    // invoke...
  } catch (Exception e) {
    transactionManager.rollback(txStatus);
    throw e;
  }
  transactionManager.commit(txStatus);

SqlSession 注冊

如果當前方法開啟了事務，那么創建的 SqlSession 就會被注冊到事務同步管理器中。SqlSession 會首先被包裝為 SqlSessionHolder，其還包含了 SqlSession 對應的執行器類型、異常處理器。

    // ...
    holder = new SqlSessionHolder(session, executorType, exceptionTranslator);
    TransactionSynchronizationManager.bindResource(sessionFactory, holder);
    // ...

隨后 SqlSessionHolder 對象通過 TransactionSynchronizationManager#bindResource 方法綁定到事務同步管理器中，其實現為將 SqlSessionFactory 和 SqlSessionHolder 綁定到 ThreadLocal 中，從而完成了線程到 SqlSessionFactory 到 SqlSession 的映射。

事務提交與回滾

如果事務是交給 Spring 事務管理器管理的，那么Spring 會自動在執行成功或異常后對當前事務進行提交或回滾。如果沒有配置 Spring 事務管理，那么將會調用 SqlSession 的 commit 方法對事務進行提交。

  if (!isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
    // 未被事務管理器管理，設置提交
    sqlSession.commit(true);
  }

而 SqlSessionTemplate 是不允許用來顯式地提交或回滾的，其提交或回滾的方法實現為直接拋出 UnsupportedOperationException 異常。

關閉 SqlSession

在當前調用結束后 SqlSessionTemplate 會調動 closeSqlSession 方法來關閉 SqlSession，如果事務同步管理器中存在當前線程綁定的 SqlSessionHolder，即當前調用被事務管理器管理，則將 SqlSession 的持有釋放掉。如果沒被事務管理器管理，則會真實地關閉 SqlSession。

  public static void closeSqlSession(SqlSession session, SqlSessionFactory sessionFactory) {
    notNull(session, NO_SQL_SESSION_SPECIFIED);
    notNull(sessionFactory, NO_SQL_SESSION_FACTORY_SPECIFIED);

    SqlSessionHolder holder = (SqlSessionHolder) TransactionSynchronizationManager.getResource(sessionFactory);
    if ((holder != null) && (holder.getSqlSession() == session)) {
      // 被事務管理器管理，釋放 SqlSession
      LOGGER.debug(() -> "Releasing transactional SqlSession [" + session + "]");
      holder.released();
    } else {
      // 真實地關閉 SqlSesion
      LOGGER.debug(() -> "Closing non transactional SqlSession [" + session + "]");
      session.close();
    }
  }

映射器

單個映射器

在 MyBatis 的基礎用法中，MyBatis 配置文件支持使用 mappers 標簽的子元素 mapper 或 package 來指定需要掃描的 mapper 接口。被掃描到的接口類將被注冊到 MapperRegistry 中，通過 MapperRegistry#getMapper 方法可以獲得 Mapper 接口的代理類。

  public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
    if (mapperProxyFactory == null) {
      throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
    }
    try {
      // 生成 mapper 接口的代理類
      return mapperProxyFactory.newInstance(sqlSession);
    } catch (Exception e) {
      throw new BindingException("Error getting mapper instance. Cause: " + e, e);
    }
  }

通過代理類的方式可以使得 statement 的 id 直接與接口方法的全限定名關聯，消除了 mapper 接口實現類的樣板代碼。但是此種方式在每次獲取 mapper 代理類的時候都需要指定 sqlSession 對象，而 mybatis-spring 中的 sqlSession 對象是 SqlSessionTemplate 代理創建的，為了適配代理邏輯，mybatis-spring 提供了 MapperFactoryBean 來創建代理類。

  @Bean
  public UserMapper userMapper(SqlSessionFactory sqlSessionFactory) throws Exception {
    MapperFactoryBean<UserMapper> factoryBean = new MapperFactoryBean<>(UserMapper.class);
    factoryBean.setSqlSessionFactory(sqlSessionFactory);
    return factoryBean.getObject();
  }

MapperFactoryBean 繼承了 SqlSessionDaoSupport，其會根據傳入的 SqlSessionFactory 來創建 SqlSessionTemplate，并使用 SqlSessionTemplate 來生成代理類。

  @Override
  public T getObject() throws Exception {
    // 使用 SqlSessionTemplate 來創建代理類
    return getSqlSession().getMapper(this.mapperInterface);
  }

  public SqlSession getSqlSession() {
    return this.sqlSessionTemplate;
  }

批量映射器

每次手動獲取單個映射器的效率是低下的，MyBatis 還提供了 MapperScan 注解用于批量掃描 mapper 接口并通過 MapperFactoryBean 創建代理類，注冊為 Spring bean。

@Configuration
@MapperScan("org.mybatis.spring.sample.mapper")
public class AppConfig {
  // ...
}

MapperScan 注解解析后注冊 Spring bean 的邏輯是由 MapperScannerConfigurer 實現的，其實現 了 BeanDefinitionRegistryPostProcessor 接口的 postProcessBeanDefinitionRegistry 方法。

  @Override
  public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
    // ...

    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
    // ...
    scanner.scan(
        StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
  }

掃描邏輯由 ClassPathMapperScanner 提供，其繼承了 ClassPathBeanDefinitionScanner 掃描指定包下的類并注冊為 BeanDefinitionHolder 的能力。

    public int scan(String... basePackages) {
        int beanCountAtScanStart = this.registry.getBeanDefinitionCount();

    // 掃描指定包并注冊 bean definion
        doScan(basePackages);

        // Register annotation config processors, if necessary.
        if (this.includeAnnotationConfig) {
            AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
        }

        return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
    }

  @Override
  public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    // 掃描指定包已經獲取的 bean 定義
    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);

    if (beanDefinitions.isEmpty()) {
      LOGGER.warn(() -> "No MyBatis mapper was found in '" + Arrays.toString(basePackages)
          + "' package. Please check your configuration.");
    } else {
      // 增強 bean 配置
      processBeanDefinitions(beanDefinitions);
    }

    return beanDefinitions;
  }

  private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
    GenericBeanDefinition definition;
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (GenericBeanDefinition) holder.getBeanDefinition();
      // ...
      // 設置 bean class 類型為 MapperFactoryBean
      definition.setBeanClass(this.mapperFactoryBeanClass);
            // ...
    }
  }

獲取到指定 bean 的定義后，重新設置 beanClass 為 MapperFactoryBean，因此在隨后的 bean 初始化中，這些被掃描的 mapper 接口可以創建代理類并被注冊到 Spring 容器中。

映射器注冊完成后，就可以使用引用 Spring bean 的配置來使用 mapper 接口。

小結

mybatis-spring 提供了與 Spring 集成的更高層次的封裝。

• SqlSessionFactoryBean 遵循 Spring FactoryBean 的定義，使得 SqlSessionFactory 注冊在 Spring 容器中。
• SqlSessionTemplate 是 SqlSession 另一種線程安全版本的實現，并且能夠更好地與 Spring 事務管理集成。
• MapperFactoryBean 是生成 mapper 接口代理類的 SqlSessionTemplate 版本實現。
• MapperScannerConfigurer 簡化了生成 mapper 接口代理的邏輯，指定掃描的包即可將生成 mapper 接口代理類并注冊為 Spring bean。