摘要：我們在開發中，會經常用到@Enable***開頭的這種註解，來自動匯入一些框架配置的預設的bean，進入註解原始碼，會發現這些註解類上都會有一個@Import(****.class)註解，這些註解是怎麼實現的呢？

Import匯入，又分為三種方式，分別為：

1.直接匯入配置類

2.根據條件選擇配置類

3.動態註冊Bean

下面，通過示例，進入原始碼，分析一下這三種匯入方式：

1.直接匯入配置類

以@EnableScheduling為例，看原始碼：

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

}
 

發現有@Import匯入了一個SchedulingConfiguration類，我們追一下原始碼：

package org.springframework.scheduling.annotation;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Role;
import org.springframework.scheduling.config.TaskManagementConfigUtils;

/**
 * {@code @Configuration} class that registers a {@link ScheduledAnnotationBeanPostProcessor}
 * bean capable of processing Spring's @{@link Scheduled} annotation.
 *
 * <p>This configuration class is automatically imported when using the
 * {@link EnableScheduling @EnableScheduling} annotation. See
 * {@code @EnableScheduling}'s javadoc for complete usage details.
 *
 * @author Chris Beams
 * @since 3.1
 * @see EnableScheduling
 * @see ScheduledAnnotationBeanPostProcessor
 */
@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();
	}

}
 

解讀一下注釋，看看此類的作用：

為@Scheduled註解註冊一個能被spring管理的名為：ScheduledAnnotationBeanPostProcessor的bean，當使用@EnableScheduling註解時，這個註解類會自動被匯入。

2.根據條件選擇配置類

以@EnableAsync註解為例，看原始碼：

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

發現有@Import匯入了一個AsyncConfigurationSelector類，我們追一下原始碼：

package org.springframework.scheduling.annotation;

import org.springframework.context.annotation.AdviceMode;
import org.springframework.context.annotation.AdviceModeImportSelector;

/**
 * Selects which implementation of {@link AbstractAsyncConfiguration} should be used based
 * on the value of {@link EnableAsync#mode} on the importing {@code @Configuration} class.
 *
 * @author Chris Beams
 * @since 3.1
 * @see EnableAsync
 * @see ProxyAsyncConfiguration
 */
public class AsyncConfigurationSelector extends AdviceModeImportSelector<EnableAsync> {

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

	/**
	 * {@inheritDoc}
	 * @return {@link ProxyAsyncConfiguration} or {@code AspectJAsyncConfiguration} for
	 * {@code PROXY} and {@code ASPECTJ} values of {@link EnableAsync#mode()}, respectively
	 */
	@Override
	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;
		}
	}

}

這個類的父父類是ImportSelector，其實是一個選擇器，這個ImportSelector介面中只有一個方法

String[] selectImports(AnnotationMetadata importingClassMetadata);

AsyncConfigurationSelector類中重寫了這個選擇方法，根據不同的引數（adviceMode，我理解為框架建議的型別），會返回不同的配置類：

若adviceMode為PORXY，則返回ProxyAsyncConfiguration這個配置類。
若activeMode為ASPECTJ，則返回AspectJAsyncConfiguration配置類。

3.動態註冊Bean

以@EnableAspectJAutoProxy為例，檢視原始碼：

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

	/**
	 * Indicate whether subclass-based (CGLIB) proxies are to be created as opposed
	 * to standard Java interface-based proxies. The default is {@code false}.
	 */
	boolean proxyTargetClass() default false;

	/**
	 * Indicate that the proxy should be exposed by the AOP framework as a {@code ThreadLocal}
	 * for retrieval via the {@link org.springframework.aop.framework.AopContext} class.
	 * Off by default, i.e. no guarantees that {@code AopContext} access will work.
	 * @since 4.3.1
	 */
	boolean exposeProxy() default false;

}

此類匯入了AspectJAutoProxyRegistrar類，這個類實現了父類的registerBeanDefinitions（）方法，此方法根據給定的註解定義來動態註冊bean。

[email protected]原始碼分析

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {

	/**
	 * Explicitly specify the name of the Spring bean definition associated
	 * with this Configuration class. If left unspecified (the common case),
	 * a bean name will be automatically generated.
	 * <p>The custom name applies only if the Configuration class is picked up via
	 * component scanning or supplied directly to a {@link AnnotationConfigApplicationContext}.
	 * If the Configuration class is registered as a traditional XML bean definition,
	 * the name/id of the bean element will take precedence.
	 * @return the suggested component name, if any (or empty String otherwise)
	 * @see org.springframework.beans.factory.support.DefaultBeanNameGenerator
	 */
	String value() default "";

}

@Configuration註解的原始碼中其實是沒什麼內容的。我們看一下這段註解的意思：

顯示的指定配置檔案中定義的spring bean的名字，一般情況下，如果未顯示的指明，將會自動生成一個bean的名字；

自定義名稱，僅在配置類通過元件掃描或者由程式上下文直接給出時，才可以使用；

如果配置類是以xml的形式定義的，那xml中定義的bean名字將優先起作用；

此介面將會返回框架建議的元件名稱，如果有的話，否則返回空字串。

5.常用註解

@EnableAspectJAutoProxy
@EnableAspectJAutoProxy註解 啟用Aspect自動代理，開啟對AspectJ自動代理的支援。

@EnableAsync
@EnableAsync註解開啟非同步方法的支援。

@EnableScheduling
@EnableScheduling註解開啟計劃任務的支援。

@EnableWebMVC
@EnableWebMVC註解用來開啟Web MVC的配置支援，也就是寫Spring MVC時的時候會用到。

@EnableConfigurationProperties
@EnableConfigurationProperties註解是用來開啟對@ConfigurationProperties註解配置Bean的支援。

@EnableJpaRepositories
@EnableJpaRepositories註解開啟對Spring Data JPA Repostory的支援。

@EnableTransactionManagement
@EnableTransactionManagement註解開啟註解式事務的支援，註解@EnableTransactionManagement通知Spring，@Transactional註解的類被事務的切面包圍。這樣@Transactional就可以使用了。

@EnableCaching
@EnableCaching註解開啟註解式的快取支援