文章目录[隐藏]
在 SpringBoot 体系中,MyBatis 对 Mapper 的注入常见的方式我知道的有 2 种:
1、@MapperScan
MapperScan 类是 mybatis-spring 包里面的。
通过在启动类上使用 @MapperScan,然后通过 basePackages 属性指定 Mapper 文件所在的目录来进行扫描装载,默认情况下指定目录下的所有.java文件都会被当做 Mapper 来加载处理。
@MapperScan(basePackages = "com.test.springboot.mapper") @ServletComponentScan(basePackages = "com.test.springboot.filters") @SpringBootApplication public class Application { public static void <b style="color:transparent">本文来源gao@!dai!ma.com搞$$代^@码网*</b>main(String[] args) { SpringApplication.run(Application.class, args); } }
可以看到,在 MapperScan 注解上有使用了 @Import(MapperScannerRegistrar.class) ,也就是把MapperScannerRegistrar 当做配置类注入 Spring 容器。
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Documented @Import(MapperScannerRegistrar.class) @Repeatable(MapperScans.class) public @interface MapperScan {}
MapperScannerRegistrar 类是一个 ImportBeanDefinitionRegistrar 的实现,会在创建注入 Spring 容器后,被 Spring 主动触发。其重载的方法主要是创建并注册了一个 MapperScannerConfigurer 类型的 registry,这个 registry 主要就是去指定的 basePackages目录扫描指定的文件,并将其装载成 BeanDefinition 注入 Spring 容器。
public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {}
@Override public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { AnnotationAttributes mapperScanAttrs = AnnotationAttributes .fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName())); if (mapperScanAttrs != null) { registerBeanDefinitions(importingClassMetadata, mapperScanAttrs, registry, generateBaseBeanName(importingClassMetadata, 0)); } } void registerBeanDefinitions(AnnotationMetadata annoMeta, AnnotationAttributes annoAttrs, BeanDefinitionRegistry registry, String beanName) { BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class); builder.addPropertyValue("processPropertyPlaceHolders", true); Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass"); if (!Annotation.class.equals(annotationClass)) { builder.addPropertyValue("annotationClass", annotationClass); } // ... }
下面是MapperScannerConfigurer 的主要实现,其主要依赖于 ClassPathMapperScanner 来实现扫面,在 MapperScan 指定了 basePackages 的情况下,它只会扫描这个指定目录,否则可能就是扫描整个 classpath 了(就类似 SpringBoot 的完整扫描)。
@Override public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) { if (this.processPropertyPlaceHolders) { processPropertyPlaceHolders(); } ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry); scanner.setAddToConfig(this.addToConfig); scanner.setAnnotationClass(this.annotationClass); scanner.setMarkerInterface(this.markerInterface); scanner.setSqlSessionFactory(this.sqlSessionFactory); scanner.setSqlSessionTemplate(this.sqlSessionTemplate); scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName); scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName); scanner.setResourceLoader(this.applicationContext); scanner.setBeanNameGenerator(this.nameGenerator); scanner.setMapperFactoryBeanClass(this.mapperFactoryBeanClass); if (StringUtils.hasText(lazyInitialization)) { scanner.setLazyInitialization(Boolean.valueOf(lazyInitialization)); } if (StringUtils.hasText(defaultScope)) { scanner.setDefaultScope(defaultScope); } scanner.registerFilters(); scanner.scan( StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS)); }