MyBatis-Spring整合核心：SqlSessionFactoryBean深度解析

MyBatis-Spring整合核心：SqlSessionFactoryBean深度解析

概述

在MyBatis与Spring框架的整合中，SqlSessionFactoryBean扮演着至关重要的角色。它是连接两个框架的桥梁，负责在Spring容器中创建和管理MyBatis的核心组件。本文将深入分析这个关键类的作用、重要性以及其配置方式。

核心地位与作用

1. Spring整合的入口点

SqlSessionFactoryBean是MyBatis-Spring整合的核心工厂Bean，它实现了Spring的FactoryBean接口，负责创建和管理MyBatis的SqlSessionFactory实例。

public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ContextRefreshedEvent> {// 核心实现
}

2. 三大接口职责

• FactoryBean: 作为工厂Bean，创建并返回SqlSessionFactory实例
• InitializingBean: 在属性设置完成后执行初始化逻辑
• ApplicationListener: 监听Spring容器刷新事件，执行完整性检查

核心初始化流程

初始化时序图

sequenceDiagramparticipant SC as Spring Containerparticipant SFB as SqlSessionFactoryBeanparticipant Config as Configurationparticipant Builder as SqlSessionFactoryBuilderSC->>SFB: 设置所有属性(Setter注入)SC->>SFB: afterPropertiesSet()SFB->>SFB: buildSqlSessionFactory()SFB->>Config: 创建Configuration对象SFB->>Config: 注册类型别名/处理器/插件SFB->>Config: 解析Mapper XML文件SFB->>Builder: build(targetConfiguration)Builder->>SFB: 返回SqlSessionFactorySFB->>SC: 返回SqlSessionFactory实例SC->>SFB: onApplicationEvent() [failFast检查]

关键初始化方法

@Override
public void afterPropertiesSet() throws Exception {// 1. 验证必要属性notNull(dataSource, "Property 'dataSource' is required");notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");// 2. 构建SqlSessionFactorythis.sqlSessionFactory = buildSqlSessionFactory();
}

依赖注入机制

传统Setter注入模式

与基于注解的现代Spring应用不同，SqlSessionFactoryBean采用传统的Setter注入方式，这体现了其作为框架基础组件的设计理念。

必须注入的依赖

1. 数据源（DataSource）- 必须

private DataSource dataSource;public void setDataSource(DataSource dataSource) {if (dataSource instanceof TransactionAwareDataSourceProxy) {this.dataSource = ((TransactionAwareDataSourceProxy) dataSource).getTargetDataSource();} else {this.dataSource = dataSource;}
}

2. Mapper文件位置（强烈推荐）

private Resource[] mapperLocations;public void setMapperLocations(Resource... mapperLocations) {this.mapperLocations = mapperLocations;
}

重要可选依赖

1. 类型别名配置

// 扫描包路径
public void setTypeAliasesPackage(String typeAliasesPackage) {this.typeAliasesPackage = typeAliasesPackage;
}// 直接指定类
public void setTypeAliases(Class<?>... typeAliases) {this.typeAliases = typeAliases;
}

2. 插件系统（拦截器）

private Interceptor[] plugins;public void setPlugins(Interceptor... plugins) {this.plugins = plugins;
}

3. 类型处理器

public void setTypeHandlers(TypeHandler<?>... typeHandlers) {this.typeHandlers = typeHandlers;
}public void setTypeHandlersPackage(String typeHandlersPackage) {this.typeHandlersPackage = typeHandlersPackage;
}

配置示例

1. 传统XML配置方式

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="mapperLocations" value="classpath*:mapper/**/*.xml"/><property name="typeAliasesPackage" value="com.example.entity"/><property name="typeHandlersPackage" value="com.example.handler"/><property name="plugins"><array><bean class="com.github.pagehelper.PageInterceptor"><property name="properties"><value>helperDialect=mysqlreasonable=true</value></property></bean></array></property>
</bean>

2. 现代Java配置方式

@Configuration
public class MyBatisConfig {@Bean@ConfigurationProperties(prefix = "mybatis")public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();sessionFactory.setDataSource(dataSource);// 自定义配置sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/**/*.xml"));return sessionFactory.getObject();}
}

3. Spring Boot自动配置

# application.yml
mybatis:mapper-locations: classpath:mapper/**/*.xmltype-aliases-package: com.example.entitytype-handlers-package: com.example.handlerconfiguration:map-underscore-to-camel-case: truecache-enabled: true

核心功能解析

1. Configuration对象管理

SqlSessionFactoryBean负责创建和配置MyBatis的核心Configuration对象：

protected SqlSessionFactory buildSqlSessionFactory() throws Exception {final Configuration targetConfiguration;if (this.configuration != null) {targetConfiguration = this.configuration;} else if (this.configLocation != null) {// 从XML配置文件创建xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);targetConfiguration = xmlConfigBuilder.getConfiguration();xmlConfigBuilder.parse();} else {// 创建默认配置targetConfiguration = new Configuration();}// 应用各种配置...return this.sqlSessionFactoryBuilder.build(targetConfiguration);
}

2. Mapper XML解析

在初始化过程中，最重要的步骤之一是解析Mapper XML文件：

if (this.mapperLocations != null) {for (Resource mapperLocation : this.mapperLocations) {XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments());xmlMapperBuilder.parse(); // 解析XML中的SQL语句}
}

3. 插件系统集成

SqlSessionFactoryBean负责注册所有配置的插件（拦截器）：

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

设计模式与架构思想

1. 工厂模式（Factory Pattern）

作为FactoryBean，它封装了复杂对象的创建过程，客户端只需获取最终产品。

2. 模板方法模式（Template Method Pattern）

buildSqlSessionFactory()方法定义了创建过程的骨架，具体步骤可以通过配置定制。

3. 依赖注入（Dependency Injection）

通过Setter方法接受依赖，而不是在内部创建，符合依赖倒置原则。

4. 建造者模式（Builder Pattern）

与SqlSessionFactoryBuilder协作，完成复杂对象的逐步构建。

重要性体现

1. 性能优化关键

通过在应用启动时一次性完成所有XML解析和配置初始化，避免了运行时的重复解析，极大提升了性能。

2. 配置集中管理

作为统一的配置入口，集中管理所有MyBatis相关配置，提高了可维护性。

3. 扩展性基础

通过插件机制和丰富的配置选项，为框架扩展提供了坚实基础。

4. 事务集成核心

与Spring事务管理紧密集成，确保数据访问层的事务一致性。

最佳实践

1. 必要配置检查

// 始终配置数据源和Mapper位置
sessionFactory.setDataSource(dataSource);
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/**/*.xml"));

2. 合理使用类型别名

// 为实体类包配置类型别名，简化Mapper XML配置
sessionFactory.setTypeAliasesPackage("com.example.entity");

3. 插件配置优化

// 按需配置插件，避免不必要的性能开销
Interceptor[] plugins = new Interceptor[]{pageInterceptor(), sqlLogInterceptor()};
sessionFactory.setPlugins(plugins);

4. 启用failFast检查

// 在开发环境中启用failFast，及时发现问题
sessionFactory.setFailFast(true);

故障排查

常见问题及解决方案

1. DataSource未设置

   Error: Property 'dataSource' is required
   

   解决方案：确保正确注入DataSource Bean

2. Mapper XML文件未找到

   Warning: Property 'mapperLocations' was specified but matching resources are not found
   

   解决方案：检查Mapper文件路径和模式匹配

3. 类型别名/处理器扫描失败
   解决方案：确认包路径正确，类符合扫描条件

总结

SqlSessionFactoryBean是MyBatis-Spring整合的灵魂组件，它不仅是技术实现的桥梁，更是设计思想的体现。通过深入理解其工作原理和配置方式，我们能够：

• 更合理地配置和优化MyBatis集成
• 更好地排查和解决集成问题
• 更充分地利用框架提供的扩展能力
• 构建更稳定、高效的数据访问层

作为MyBatis在Spring生态系统中的基石，SqlSessionFactoryBean的稳定性和性能直接影响到整个应用的数据访问能力，值得每一个使用MyBatis的开发者深入理解和掌握。