在使用 MyBatis Plus 进行持久层开发时，MapperScannerConfigurer 是一个重要的配置类，用于自动扫描指定包下的 Mapper 接口并注册到 Spring 容器中。本文将深入探讨 MapperScannerConfigurer 的使用方法、配置项以及其在 MyBatis Plus 中的作用，为开发者提供详实的指南。

了解 MapperScannerConfigurer

1. MapperScannerConfigurer是什么？

MapperScannerConfigurer 是 MyBatis 提供的一个用于自动扫描 Mapper 接口并注册到 Spring 容器的配置类。它能够简化 Mapper 接口的配置过程，使开发者无需手动一个一个地注册 Mapper Bean。

2. 使用MapperScannerConfigurer的目的

使用 MapperScannerConfigurer 的主要目的是将 MyBatis Mapper 接口纳入 Spring 的管理范围，方便进行注入和使用。通过自动扫描指定包下的 Mapper 接口，开发者能够更加便捷地配置持久层组件。

配置MapperScannerConfigurer

1. 添加依赖

在项目的 pom.xml 文件中添加 MyBatis Plus 和 MyBatis 的依赖：

<!-- MyBatis Plus --><dependency>    <groupId>com.baomidou</groupId>    <artifactId>mybatis-plus-boot-starter</artifactId>    <version>latest_version</version></dependency><!-- MyBatis --><dependency>    <groupId>org.mybatis.spring.boot</groupId>    <artifactId>mybatis-spring-boot-starter</artifactId>    <version>latest_version</version></dependency>

2. 配置MapperScannerConfigurer

在 Spring Boot 项目的配置文件中添加 MapperScannerConfigurer 的配置：

mybatis-plus:  mapper-locations: classpath*:mapper/*.xml  typeAliasesPackage: com.example.entity# MapperScannerConfigurer配置mybatis:  mapperScannerConfigurer:    basePackage: com.example.mapper

在上述配置中，mapper-locations 指定了 MyBatis XML Mapper 文件的位置，typeAliasesPackage指定了实体类的包名。而 mapperScannerConfigurer 则配置了 Mapper 接口的扫描包路径。

MapperScannerConfigurer的配置项详解

1、basePackage

basePackage 属性指定了 Mapper 接口的扫描路径，可以配置为一个包名字符串或包名的数组。例如：

mybatis:  mapperScannerConfigurer:    basePackage: com.example.mapper

或者配置多个包：

mybatis:  mapperScannerConfigurer:    basePackage:      - com.example.mapper1      - com.example.mapper2

2、annotationClass和markerInterface

annotationClass 和 markerInterface 分别用于指定 Mapper 接口上的注解类和标记接口，从而过滤扫描结果。例如：

mybatis:  mapperScannerConfigurer:    basePackage: com.example.mapper    annotationClass: org.springframework.stereotype.Repository

或者使用 markerInterface：

mybatis:  mapperScannerConfigurer:    basePackage: com.example.mapper    markerInterface: com.example.common.MyMarkerInterface

3、nameGenerator

nameGenerator 属性用于指定生成 Mapper Bean 名称的策略，默认为 DefaultBeanNameGenerator。开发者也可以自定义 Bean 名称生成器。

4、sqlSessionFactoryBeanName和 sqlSessionTemplateBeanName

sqlSessionFactoryBeanName 和 sqlSessionTemplateBeanName 分别指定 SqlSessionFactory 和 SqlSessionTemplate 的 Bean 名称，默认为 "sqlSessionFactory" 和 "sqlSessionTemplate"。

通过MapperScannerConfigurer实现多数据源配置

1、配置多个 MapperScannerConfigurer

如果项目中存在多个数据源，可以通过配置多个 MapperScannerConfigurer 实例来实现多数据源的 Mapper 扫描：

@Configurationpublic class DataSourceConfig {    @Bean(name = "datasource1MapperScannerConfigurer")    public MapperScannerConfigurer datasource1MapperScannerConfigurer() {        MapperScannerConfigurer configurer = new MapperScannerConfigurer();        configurer.setBasePackage("com.example.mapper.datasource1");        configurer.setSqlSessionFactoryBeanName("datasource1SqlSessionFactory");        return configurer;    }    @Bean(name = "datasource2MapperScannerConfigurer")    public MapperScannerConfigurer datasource2MapperScannerConfigurer() {        MapperScannerConfigurer configurer = new MapperScannerConfigurer();        configurer.setBasePackage("com.example.mapper.datasource2");        configurer.setSqlSessionFactoryBeanName("datasource2SqlSessionFactory");        return configurer;    }}

在上述例子中，通过创建两个 MapperScannerConfigurer Bean，分别指定了不同的 Mapper 包和对应的 SqlSessionFactoryBean。

2、多数据源配置的注意事项

在实现多数据源配置时，需要注意以下几点：

确保每个数据源的 Mapper 包路径不同，避免冲突。使用 setSqlSessionFactoryBeanName 指定不同数据源的 SqlSessionFactoryBean。确保每个数据源都有对应的 SqlSessionFactory 和 DataSource 配置。总 结

MapperScannerConfigurer 是 MyBatis Plus 中用于自动扫描 Mapper 接口并注册到 Spring 容器的重要配置类。通过了解其配置项，我们能够更加灵活地配置 Mapper 接口的扫描路径、过滤条件等。在实际项目中，结合多数据源配置，开发者能够更好地利用 MapperScannerConfigurer 简化持久层组件的管理，提高开发效率。通过本文的详细介绍，希望读者能够更加深入地理解并合理使用 MapperScannerConfigurer，为项目的持久层组件配置带来便捷。

微信公众号：九极客