Spring Boot 自動配置之@Enable* 與@Import註解

來醉一場發表於2019-02-27

SpringBoot 的自動配置如此強大,比如我們經常使用的@Enable* 註解來開啟對某方面的支援。那麼@Enable* 註解的原理是什麼呢?

一、@Enable* 註解與 @Import 註解之間的關係

@Enable* 舉例:

  • @EnableScheduling 開啟計劃任務的支援
  • @EnableAsync 開啟非同步方法的支援
  • @EnableAspectJAutoProxy 開啟對 AspectJ 代理的支援
  • @EnableTransactionManagement 開啟對事務的支援
  • @EnableCaching 開啟對註解式快取的支援

等等

我們觀察這些@Enable* 的原始碼可以看出,所有@Enable* 註解都是有@Import的組合註解,@Enable* 自動開啟的實現其實就是匯入了一些自動配置的Bean

看下 Spring Boot Reference Guide原文

You need not put all your @Configuration into a single class. The @Import annotation
can be used to import additional configuration classes.

您不需要把所有的 @Configuration 放到一個類中。@Import 註解可以匯入額外的配置類。
複製程式碼

@Import 註解的最主要功能就是匯入額外的配置資訊

二、 @Import 註解的用法

官方介紹:

* <p>Provides functionality equivalent to the {@code <import/>} element in Spring XML.
 * Allows for importing {@code @Configuration} classes, {@link ImportSelector} and
 * {@link ImportBeanDefinitionRegistrar} implementations, as well as regular component
 * classes (as of 4.2; analogous to {@link AnnotationConfigApplicationContext#register}).
複製程式碼

有以下三種使用方式

1、直接匯入配置類(@Configuration 類)

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(SchedulingConfiguration.class)
@Documented
public @interface EnableScheduling {

}
複製程式碼

可以看到EnableScheduling註解直接匯入配置類SchedulingConfiguration,這個類註解了@Configuration,且註冊了一個scheduledAnnotationProcessor的Bean,SchedulingConfiguration的原始碼如下:

@Configuration
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
public class SchedulingConfiguration {

	@Bean(name = TaskManagementConfigUtils.SCHEDULED_ANNOTATION_PROCESSOR_BEAN_NAME)
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() {
		return new ScheduledAnnotationBeanPostProcessor();
	}

}

複製程式碼

2、依據條件選擇配置類(實現 ImportSelector 介面)

如果並不確定引入哪個配置類,需要根據@Import註解所標識的類或者另一個註解(通常是註解)裡的定義資訊選擇配置類的話,用這種方式。

ImportSelector介面只有一個方法

String[] selectImports(AnnotationMetadata importingClassMetadata);
複製程式碼

AnnotationMetadata:用來獲得當前配置類上的註解

例:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(AsyncConfigurationSelector.class)
public @interface EnableAsync {

	Class<? extends Annotation> annotation() default Annotation.class;
	
	boolean proxyTargetClass() default false;

	AdviceMode mode() default AdviceMode.PROXY;

	int order() default Ordered.LOWEST_PRECEDENCE;

}

複製程式碼

AsyncConfigurationSelector繼承AdviceModeImportSelector,AdviceModeImportSelector類實現ImportSelector介面 根據AdviceMode的不同來選擇生明不同的Bean

public class AsyncConfigurationSelector extends AdviceModeImportSelector<EnableAsync> {

	private static final String ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME =
			"org.springframework.scheduling.aspectj.AspectJAsyncConfiguration";

	@Override
	@Nullable
	public String[] selectImports(AdviceMode adviceMode) {
		switch (adviceMode) {
			case PROXY:
				return new String[] {ProxyAsyncConfiguration.class.getName()};
			case ASPECTJ:
				return new String[] {ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME};
			default:
				return null;
		}
	}

}

複製程式碼

3、動態註冊Bean(實現 ImportBeanDefinitionRegistrar 介面)

一般只要使用者確切知道哪些Bean需要放入容器的話,自己可以通過spring 提供的註解來標識就可以了,比如@Component,@Service,@Repository,@Bean等。 如果是不確定的類,或者不是spring專用的,所以並不想用spring的註解進行侵入式標識,那麼就可以通過@Import註解,實現ImportBeanDefinitionRegistrar介面來動態註冊Bean。 比如:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(AspectJAutoProxyRegistrar.class)
public @interface EnableAspectJAutoProxy {

	boolean proxyTargetClass() default false;
	
	boolean exposeProxy() default false;

}
複製程式碼

AspectJAutoProxyRegistrar實現了ImportBeanDefinitionRegistrar介面,ImportBeanDefinitionRegistrar的作用是在執行時自動新增Bean到已有的配置類,通過重寫方法:

public void registerBeanDefinitions(
			AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);
複製程式碼
  • AnnotationMetadata 引數用來獲得當前配置類上的註解
  • BeanDefinitionRegistry 引數用來註冊Bean

原始碼:

@Override
public void registerBeanDefinitions(
		AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

	AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary(registry);

	AnnotationAttributes enableAspectJAutoProxy =
			AnnotationConfigUtils.attributesFor(importingClassMetadata, EnableAspectJAutoProxy.class);
	if (enableAspectJAutoProxy != null) {
		if (enableAspectJAutoProxy.getBoolean("proxyTargetClass")) {
			AopConfigUtils.forceAutoProxyCreatorToUseClassProxying(registry);
		}
		if (enableAspectJAutoProxy.getBoolean("exposeProxy")) {
			AopConfigUtils.forceAutoProxyCreatorToExposeProxy(registry);
		}
	}
}
複製程式碼

Mybatis 中大名鼎鼎的@MapperScan 也是如此

三、官方文件

官方文件

相關文章