mybatis进击七：mybatis如何纳入spring的管理

逃离我推掉我的手 2022-11-05 08:47 61阅读 0赞

**目录**

一、将普通类纳入spring的bean管理

1.1 ImportBeanDefinitionRegistrar

1.2 ClassPathBeanDefinitionScanner

二、mybatis的bean扫描

2.1 @MapperScan

2.1 MapperScannerRegistrar

2.3 ClassPathMapperScanner

三、源码解读

四、总结

> 为何我们可以使用@Autowire直接使用Mapper

# 一、将普通类纳入spring的bean管理 #

一般的我们都是使用@Service,@Component等注解将类纳入spring的管理中，但是如果我们想将特定的类纳入spring的管理中，又该如何去做呢？

我们肯定也希望跟@Service一样，定义一个注解，然后使用注解方便快捷的将其纳入spring的管理中。

## 1.1 ImportBeanDefinitionRegistrar ##

public interface ImportBeanDefinitionRegistrar {
    	void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);
    }

实现该接口，可以接收到被可以注册成bean的注解信息（importingClassMeta）和注册工厂（registry）

## 1.2 ClassPathBeanDefinitionScanner ##

public int scan(String... basePackages) {
    		int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
    
    		doScan(basePackages);
    
    		// Register annotation config processors, if necessary.
    		if (this.includeAnnotationConfig) {
    			AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
    		}
    
    		return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
    	}

可以将扫描到的类都注入为bean

# 二、mybatis的bean扫描 #

## 2.1 @MapperScan ##

@Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    @Import(MapperScannerRegistrar.class)
    public @interface MapperScan {
    
      String[] value() default {};
    
      String[] basePackages() default {};
    
      Class<?>[] basePackageClasses() default {};
    
      Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
    
      Class<? extends Annotation> annotationClass() default Annotation.class;
    
      Class<?> markerInterface() default Class.class;
    
      String sqlSessionTemplateRef() default "";
    
      String sqlSessionFactoryRef() default "";
    
      Class<? extends MapperFactoryBean> factoryBean() default MapperFactoryBean.class;
    }

该注解用来指定扫描包，扫描的注解类等配置信息

## 2.1 MapperScannerRegistrar ##

实现了ImportBeanDefinitionRegistrar，来进行自定义的bean扫描

## 2.3 ClassPathMapperScanner ##

继承自ClassPathBeanDefinitionScanner，对生成beanDefinition进行进一步加工

# 三、源码解读 #

通过上述讲解，我们大致知道了Mapper bean的注入过程，接下来我们通过源码详细了解一下。

首先来看看MapperScannerRegistrar

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70][]

接下来进入doScan方法， 这个就是来扫描bean的，如果没有特殊的情况，可以直接使用ClassPathBeanDefinitionScanner。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 2][]

**为什么要将bean的类型改成MapperFactoryBean呢？**

我们可以发现MapperFactoryBean实现了FactoryBean，实现了这个接口，意味着bean创建的时候，会调用getObject方法

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 3][]

其中getSqlSession获取到的SqlSessionTemplate实例,而getMapper最终调用的是Configuration的MapperRegistry中已经注册好的Mapper

![20210304231654131.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 4][]可以看到，又调用了MapperProxyFactory的newInstance

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 5][]

最终，我们发现，底层一个Proxy，拦截处理类是MapperProxy

至此，我们知道Mapper最终的类型就是Proxy，而处理器为MapperProxy，并且还注入了spring的bean管理中

# 四、总结 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 6][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70]: /images/20221023/818cdb8741bc49c0938be3e37eef6603.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 1]: /images/20221023/8f1b5344d2174fd4986bd3bb8d1c5840.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 2]: /images/20221023/03b68f2c5406473daaefed8cef63173f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 3]: /images/20221023/caacb475594442b79dbf040891363618.png
[20210304231654131.png]: /images/20221023/1284696133dc4a0199162d7c7658df15.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 4]: /images/20221023/8169689ff7804c8082a0e076a4b6a0ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 5]: /images/20221023/a63c99bcc7ea4e4c8ca094dc2696e281.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhdmVkcmVhbV9vbmU_size_16_color_FFFFFF_t_70 6]: /images/20221023/689412082be54c10a983fac99f6fe93d.png