MyBatis 与 Spring 的集成配置：`SqlSessionFactoryBean` 与 `MapperScannerConfigurer`

MyBatis 与 Spring 的美妙邂逅：`SqlSessionFactoryBean` 和 `MapperScannerConfigurer` 的爱情故事

各位代码界的绅士淑女们，今天我们要聊聊 MyBatis 和 Spring 这两位重量级选手之间的“爱情故事”。他们结合之后，产生的化学反应简直令人惊叹，能让我们的数据访问层代码变得更加简洁、高效、优雅。而促成这段美好姻缘的关键人物，就是我们今天要重点介绍的两位“媒婆”：SqlSessionFactoryBean 和 MapperScannerConfigurer。

在没有这两位媒婆之前，我们使用 MyBatis，那可真是“累觉不爱”。配置文件一大堆，Mapper 接口还得手动去 XML 中配置，简直让人怀疑人生。但有了他们，世界都变得美好了起来。

废话不多说，让我们先来认识一下这两位神奇的“媒婆”吧！

第一位媒婆：`SqlSessionFactoryBean` – 负责生产“爱情结晶”

SqlSessionFactoryBean，顾名思义，它是一个 Bean，主要负责创建 SqlSessionFactory 对象。SqlSessionFactory 是 MyBatis 的核心，它负责创建 SqlSession，而 SqlSession 才是我们真正用来执行 SQL 语句，操作数据库的家伙。你可以把 SqlSessionFactory 想象成一个“工厂”，专门生产 SqlSession 这种“产品”。

简单来说，SqlSessionFactoryBean 的作用就是：

读取 MyBatis 的配置文件（比如 mybatis-config.xml）。
根据配置文件创建 SqlSessionFactory 对象。
将 SqlSessionFactory 对象交给 Spring 管理。

没有它，我们就得自己手动创建 SqlSessionFactory，那可就太麻烦了！

下面我们来看一个 SqlSessionFactoryBean 的配置示例：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatis-config.xml"/>
    <property name="mapperLocations" value="classpath:com/example/mapper/*.xml"/>
</bean>

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
    <property name="driverClassName" value="${jdbc.driver}"/>
    <property name="url" value="${jdbc.url}"/>
    <property name="username" value="${jdbc.username}"/>
    <property name="password" value="${jdbc.password}"/>
</bean>

在这个配置中，我们可以看到：

class="org.mybatis.spring.SqlSessionFactoryBean"：指定了 Bean 的类型为 SqlSessionFactoryBean。
dataSource：指定了数据源，这里引用了另外一个 Bean，也就是 dataSource。
configLocation：指定了 MyBatis 的配置文件路径。
mapperLocations：指定了 Mapper XML 文件的路径。

configLocation 和 mapperLocations 的区别：

configLocation：指向的是 MyBatis 的全局配置文件，比如 mybatis-config.xml，它包含了 MyBatis 的全局配置，比如 typeAliases、settings 等。
mapperLocations：指向的是 Mapper XML 文件，它包含了 SQL 语句的定义。

使用代码示例：

@Autowired
private SqlSessionFactory sqlSessionFactory;

public void doSomething() {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        // 使用 session 执行 SQL 语句
        UserMapper userMapper = session.getMapper(UserMapper.class);
        User user = userMapper.selectById(1);
        System.out.println(user);
    }
}

这段代码展示了如何在 Spring 管理的 Bean 中使用 SqlSessionFactory。通过 @Autowired 注解，我们可以将 SqlSessionFactory 注入到我们的 Bean 中，然后就可以使用它来创建 SqlSession，并执行 SQL 语句了。

SqlSessionFactoryBean 的常用属性：

属性名	类型	描述
`dataSource`	`javax.sql.DataSource`	数据源，必须指定。
`configLocation`	`org.springframework.core.io.Resource`	MyBatis 的配置文件路径，可选。如果不指定，MyBatis 会尝试在 classpath 下寻找 `mybatis-config.xml` 文件。
`mapperLocations`	`org.springframework.core.io.Resource[]`	Mapper XML 文件的路径，可选。如果不指定，MyBatis 会尝试在 classpath 下寻找 Mapper XML 文件。通常建议指定，避免 MyBatis 扫描不必要的文件。
`typeAliasesPackage`	`java.lang.String`	指定类型别名的包名，可选。MyBatis 会扫描该包下的所有类，并为它们注册别名。
`typeHandlersPackage`	`java.lang.String`	指定类型处理器的包名，可选。MyBatis 会扫描该包下的所有类，并注册它们作为类型处理器。
`objectFactory`	`org.apache.ibatis.reflection.factory.ObjectFactory`	指定对象工厂，可选。如果你需要自定义对象的创建方式，可以指定自己的对象工厂。
`plugins`	`org.apache.ibatis.plugin.Interceptor[]`	指定插件，可选。你可以使用插件来拦截 MyBatis 的执行过程，实现自定义的功能。
`transactionFactory`	`org.apache.ibatis.transaction.TransactionFactory`	指定事务工厂，可选。如果你需要自定义事务的管理方式，可以指定自己的事务工厂。
`configurationProperties`	`java.util.Properties`	指定配置属性，可选。你可以使用配置属性来覆盖 MyBatis 配置文件中的属性。

第二位媒婆：`MapperScannerConfigurer` – 负责批量“牵线搭桥”

MapperScannerConfigurer，顾名思义，它是一个配置器，主要负责扫描指定的包，然后将包下的所有 Mapper 接口注册为 Spring 的 Bean。你可以把它想象成一个“红娘”，专门负责将 Mapper 接口和 MyBatis 关联起来。

没有它，我们就得手动配置每一个 Mapper 接口，那可就太痛苦了！

下面我们来看一个 MapperScannerConfigurer 的配置示例：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.example.mapper"/>
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
</bean>

在这个配置中，我们可以看到：

class="org.mybatis.spring.mapper.MapperScannerConfigurer"：指定了 Bean 的类型为 MapperScannerConfigurer。
basePackage：指定了需要扫描的包名。
sqlSessionFactoryBeanName：指定了 SqlSessionFactoryBean 的 Bean 名称。

basePackage 的作用：

basePackage 指定了需要扫描的包名，MapperScannerConfigurer 会扫描该包下的所有接口，如果接口上使用了 @Mapper 注解（或者符合 MyBatis 的 Mapper 接口规范），就会将该接口注册为 Spring 的 Bean。

sqlSessionFactoryBeanName 的作用：

sqlSessionFactoryBeanName 指定了 SqlSessionFactoryBean 的 Bean 名称，MapperScannerConfigurer 会根据该名称找到对应的 SqlSessionFactoryBean，然后使用它来创建 SqlSession。

使用代码示例：

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public User getUserById(Integer id) {
        return userMapper.selectById(id);
    }
}

这段代码展示了如何在 Spring 管理的 Bean 中使用 Mapper 接口。通过 @Autowired 注解，我们可以将 Mapper 接口注入到我们的 Bean 中，然后就可以直接使用它来执行 SQL 语句了。

MapperScannerConfigurer 的常用属性：

属性名	类型	描述
`basePackage`	`java.lang.String`	需要扫描的包名，必须指定。可以指定多个包名，用逗号分隔。
`sqlSessionFactoryBeanName`	`java.lang.String`	`SqlSessionFactoryBean` 的 Bean 名称，可选。如果不指定，MyBatis 会尝试寻找类型为 `SqlSessionFactory` 的 Bean。
`sqlSessionTemplateBeanName`	`java.lang.String`	`SqlSessionTemplate` 的 Bean 名称，可选。如果不指定，MyBatis 会尝试寻找类型为 `SqlSessionTemplate` 的 Bean。
`annotationClass`	`java.lang.Class<? extends java.lang.annotation.Annotation>`	指定需要扫描的注解类型，可选。只有使用了该注解的接口才会被注册为 Bean。
`markerInterface`	`java.lang.Class<?>`	指定需要扫描的接口类型，可选。只有实现了该接口的接口才会被注册为 Bean。
`nameGenerator`	`org.springframework.beans.factory.config.BeanNameGenerator`	指定 Bean 名称生成器，可选。如果你需要自定义 Bean 的名称，可以使用自己的 Bean 名称生成器。
`processPropertyPlaceHolders`	`boolean`	是否处理占位符，可选。如果设置为 true，MyBatis 会尝试解析 `basePackage` 中使用的占位符。

为什么我们需要 `SqlSessionFactoryBean` 和 `MapperScannerConfigurer`？

简单来说，是为了简化我们的开发工作，提高开发效率，让我们的代码更加简洁、优雅。

简化配置： SqlSessionFactoryBean 负责创建 SqlSessionFactory，MapperScannerConfigurer 负责扫描 Mapper 接口，并将它们注册为 Spring 的 Bean。这大大简化了 MyBatis 的配置，避免了大量的 XML 配置。
提高开发效率： 我们只需要编写 Mapper 接口和 XML 文件，然后配置 SqlSessionFactoryBean 和 MapperScannerConfigurer，就可以直接在 Spring 管理的 Bean 中使用 Mapper 接口，无需手动创建 SqlSession，也无需手动配置 Mapper 接口。
代码更加简洁： 使用 SqlSessionFactoryBean 和 MapperScannerConfigurer 可以让我们的代码更加简洁、优雅，可读性更高，也更容易维护。
更好的集成： SqlSessionFactoryBean 和 MapperScannerConfigurer 是 MyBatis 官方提供的 Spring 集成工具，它们与 Spring 框架无缝集成，可以充分利用 Spring 的特性，比如依赖注入、事务管理等。

常见问题和注意事项

SqlSessionFactoryBean 和 MapperScannerConfigurer 的顺序： 通常情况下，我们需要先配置 SqlSessionFactoryBean，然后再配置 MapperScannerConfigurer。因为 MapperScannerConfigurer 需要使用 SqlSessionFactoryBean 创建的 SqlSessionFactory。
basePackage 的配置： basePackage 的配置非常重要，一定要确保它包含了所有的 Mapper 接口。否则，MapperScannerConfigurer 无法扫描到这些接口，也就无法将它们注册为 Spring 的 Bean。
Mapper 接口的命名规范： 为了让 MapperScannerConfigurer 能够正确扫描到 Mapper 接口，我们需要遵循一定的命名规范。通常情况下，Mapper 接口的名称应该以 "Mapper" 结尾，比如 UserMapper、OrderMapper 等。
XML 文件的位置： Mapper XML 文件应该放在与 Mapper 接口相同的包下，并且名称应该与 Mapper 接口的名称相同，只是后缀名为 ".xml"。比如，如果 Mapper 接口的名称是 UserMapper，那么 XML 文件的名称应该是 UserMapper.xml。
使用 @Mapper 注解： 除了遵循命名规范之外，我们还可以使用 @Mapper 注解来标记 Mapper 接口。使用了 @Mapper 注解的接口，即使不符合命名规范，也会被 MapperScannerConfigurer 扫描到。
事务管理： MyBatis 与 Spring 集成之后，我们可以使用 Spring 的事务管理功能来管理 MyBatis 的事务。只需要在 Spring 的配置文件中配置事务管理器，然后在需要进行事务管理的方法上添加 @Transactional 注解即可。
动态 SQL： MyBatis 的动态 SQL 功能非常强大，可以根据不同的条件生成不同的 SQL 语句。在 Spring 集成环境下，我们可以充分利用动态 SQL 的功能，编写更加灵活、高效的 SQL 语句。

总结

SqlSessionFactoryBean 和 MapperScannerConfigurer 是 MyBatis 与 Spring 集成的两位重要“媒婆”，它们简化了 MyBatis 的配置，提高了开发效率，让我们的代码更加简洁、优雅。掌握了这两位“媒婆”的使用方法，你就可以轻松地将 MyBatis 集成到 Spring 项目中，享受 MyBatis 和 Spring 带来的便利。

希望这篇文章能帮助你更好地理解 SqlSessionFactoryBean 和 MapperScannerConfigurer 的作用和用法。记住，代码的世界充满了乐趣，只要我们不断学习，不断探索，就能发现更多的惊喜！

MyBatis 与 Spring 的美妙邂逅：SqlSessionFactoryBean 和 MapperScannerConfigurer 的爱情故事

第一位媒婆：SqlSessionFactoryBean – 负责生产“爱情结晶”

第二位媒婆：MapperScannerConfigurer – 负责批量“牵线搭桥”

为什么我们需要 SqlSessionFactoryBean 和 MapperScannerConfigurer？

常见问题和注意事项

总结

发表回复 取消回复

MyBatis 与 Spring 的美妙邂逅：`SqlSessionFactoryBean` 和 `MapperScannerConfigurer` 的爱情故事

第一位媒婆：`SqlSessionFactoryBean` – 负责生产“爱情结晶”

第二位媒婆：`MapperScannerConfigurer` – 负责批量“牵线搭桥”

为什么我们需要 `SqlSessionFactoryBean` 和 `MapperScannerConfigurer`？

发表回复取消回复