mybatis 中接口注入spring源码分析

一、 springboot中使用mybatis

指定扫描mapper的包

这里只是简单的使用@MapperScan 注解，因为重点是分析Mapper对象注入到spring中，所以其他的配置，这里不介绍。

@MapperScan(value = { "com.card.mapper"})
@SpringBootApplication
public class TradeApplication {
    public static void main(String[] args) {
        System.setProperty("dubbo.application.logger","slf4j");
        SpringApplication.run(TradeApplication.class,args);
    }
}

按道理没有其他毛病的话，包com.card.mapper下的Mapper对象应该就会注入spring中。

image.png

二、注入源码分析

这里涉及到的类先声明下
MapperScannerRegistrar：主要作用将@MapperScan中信息，配置到ClassPathMapperScanner中。
ClassPathMapperScanner：担任扫描指定包下的Mapper，以及将Mapper注入到spring的功能。

MapperScannerRegistrar

a. 调用时机

这个类调用时机是启动SpringBoot的xxxApplication类。

原因

在xxxApplication中使用@MapperScan后，这个类（MapperScannerRegistrar）的registerBeanDefinitions方法会自动调用。这个机制的触发原因如下：

1. 使用@Import将MapperScannerRegistrar导入。

@Import(MapperScannerRegistrar.class)
public @interface MapperScan {

2. 实现ImportBeanDefinitionRegistrar 接口。

public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar

b. 源码

/***

**/
public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
  private ResourceLoader resourceLoader;
  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
  // 获取MapperScan 注解
    AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
  // 创建路径扫描器，下面的一大段都是将MapperScan 中的属性设置到ClassPathMapperScanner 
  // 做的就是一个set操作
    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
    // this check is needed in Spring 3.1
    if (resourceLoader != null) {
    // 设置资源加载器，作用：扫描指定包下的class文件。
      scanner.setResourceLoader(resourceLoader);
    }
    Class annotationClass = annoAttrs.getClass("annotationClass");
    if (!Annotation.class.equals(annotationClass)) {
      scanner.setAnnotationClass(annotationClass);
    }
    Class markerInterface = annoAttrs.getClass("markerInterface");
    if (!Class.class.equals(markerInterface)) {
      scanner.setMarkerInterface(markerInterface);
    }
    Class generatorClass = annoAttrs.getClass("nameGenerator");
    if (!BeanNameGenerator.class.equals(generatorClass)) {
      scanner.setBeanNameGenerator(BeanUtils.instantiateClass(generatorClass));
    }
    Class mapperFactoryBeanClass = annoAttrs.getClass("factoryBean");
    if (!MapperFactoryBean.class.equals(mapperFactoryBeanClass)) {
      scanner.setMapperFactoryBean(BeanUtils.instantiateClass(mapperFactoryBeanClass));
    }
    scanner.setSqlSessionTemplateBeanName(annoAttrs.getString("sqlSessionTemplateRef"));
    scanner.setSqlSessionFactoryBeanName(annoAttrs.getString("sqlSessionFactoryRef"));
    List basePackages = new ArrayList();
    for (String pkg : annoAttrs.getStringArray("value")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (String pkg : annoAttrs.getStringArray("basePackages")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (Class clazz : annoAttrs.getClassArray("basePackageClasses")) {
      basePackages.add(ClassUtils.getPackageName(clazz));
    }
    // 注册过滤器，作用：什么类型的Mapper将会留下来。
    scanner.registerFilters();
  // 扫描指定包
    scanner.doScan(StringUtils.toStringArray(basePackages));
  }
}

ClassPathMapperScanner

先来个这个类的继承代码

public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner

熟悉spring注入流程的同学应该对ClassPathBeanDefinitionScanner这个类有印象，其实这个类就是将bean注入spring中的核心入口。ClassPathBeanDefinitionScanner主要干了以下几件事。

1. 扫描指定包下的class文件。
2. 将包含@Component，@ManagedBean，@Named的类的元信息放入BeanDefinition对象中
3. 判断BeanDefinition中的类元信息，将有效的放入spring中

/**
**/
public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {
    private MapperFactoryBean mapperFactoryBean = new MapperFactoryBean