ConfigurationClass

简介（What）

配置类(ConfigurationClass)是一种含有特殊标记的BeanDefiniton。这些配置类共同实现了诸如组件扫描、资源导入及自动装配等Spring的核心功能，极大地提高了Spring的可扩展性及开发人员的工作效率。如：

使用@Component标记组件类，配合@ComponentScan，减少<beans>.xml的声明；
使用@ImportResource标记声明需要导入的的资源；
使用@Import注解自定义需要导入的类；
使用@Bean注解标记Java方法声明的组件类，以替代<bean>标签；
……

定义（Definition）

在了解配置类之前，先看看其是如何定义的。ConfigrurationClass是Spring框架的一个‘内部类’（非public）。核心源码如下：

package org.springframework.context.annotation;

final class ConfigurationClass {

    // 注解元数据
    private final AnnotationMetadata metadata;

    private final Resource resource;

    @Nullable
    private String beanName;

    private final Set<ConfigurationClass> importedBy = new LinkedHashSet<>(1);

    // 被 @Bean 标记的方法
    private final Set<BeanMethod> beanMethods = new LinkedHashSet<>();

    // @ImportResource 声明的资源
    private final Map<String, Class<? extends BeanDefinitionReader>> importedResources =
            new LinkedHashMap<>();

    // @Import 声明的注册器
    private final Map<ImportBeanDefinitionRegistrar, AnnotationMetadata> importBeanDefinitionRegistrars =
            new LinkedHashMap<>();

    final Set<String> skippedBeanMethods = new HashSet<>();

}

各属性的含义如下：

属性	类型	备注
`metadata`	`AnnotationMetaData`	配置类元数据
`resource`	`Resource`
`beanName`	`String`	名称
`importdBy`	`Set`
`beanMethods`	`Map`	被`@Bean`标记的方法
`importedResources`	`Map`	`@ImportResource`声明的资源
`importBeanDefinitionRegistrars`	`Map`	`@Import`声明的注册器

这其中有几个比较重要的属性，如

用于描述配置类元数据的metadata；
描述被@Bean注解标记的方法的beanMethods；
描述@ImportResource注解标记的资源importedResources；
描述@Import注解声明的ImportBeanDefinitionRegistrar。

注解（Annotation）

@ComponentScan

@ComponentScan是Spring中最核心的元注解之一了，该注解可以减少大量的<beans>.xml的配置文件，让Spring可以自动扫描指定路径下的组件类。

可以通过属basePackages或value或basePackageClasses属性来指定的扫描的路径，默认情况下为被该注解标记的类所在的包。

但是，在Spring Boot的开发中，又几乎不会使用到该注释，但是仍然能实现组件自动扫描的功能，这是为什么呢？

当仔细查看@SpringBootApplication注解的时候，你会发现该注解是声明了@ComponentScan注解：
package org.springframework.boot.autoconfigure;

@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

}
看到这，相信使用Spring Boot在开发多模块应用时遇到明明在类上声明了@Component或其扩展注解，但就是没有被Spring容器自动加载的小伙伴们，已经知道这是什么原因了。

这是因为定义的XXXApplication应用的包为com.xxx.web，而被标记的组件，如Service的包为com.xxx.service，从包的层级关系看，web并未包含service，因而没有被Spring能扫描到，这时候只需要把XXXApplication移动到com.xxx包下，问题即可解决。

@Bean

@Bean注解是Spring提供的使用Java方法声明Bean定义的元注解，与<bean>标签功能相同，而且可以更高级的定制Bean的初始化流程。

如spring-webmvc模块中WebMvcConfigurationSupport，定义了Spring MVC中核心策略的默认实现：

package org.springframework.web.servlet.config.annotation;

public class WebMvcConfigurationSupport implements ApplicationContextAware, ServletContextAware {

	@Bean
	@SuppressWarnings("deprecation")
	public RequestMappingHandlerMapping requestMappingHandlerMapping(
			@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
			@Qualifier("mvcConversionService") FormattingConversionService conversionService,
			@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {

		//...
		return mapping;
	}
    
	@Bean
	public RequestMappingHandlerAdapter requestMappingHandlerAdapter(
			@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
			@Qualifier("mvcConversionService") FormattingConversionService conversionService,
			@Qualifier("mvcValidator") Validator validator) {

        // ...
		return adapter;
	}

	@Bean
	public HandlerExceptionResolver handlerExceptionResolver(
			@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager) {
		// ...
		return composite;
	}
    
	@Bean
	public ViewResolver mvcViewResolver(
			@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager) {
		//...
		return composite;
	}

	@Bean
	@Lazy
	public HandlerMappingIntrospector mvcHandlerMappingIntrospector() {
		return new HandlerMappingIntrospector();
	}

	@Bean
	public LocaleResolver localeResolver() {
		return new AcceptHeaderLocaleResolver();
	}

	@Bean
	public ThemeResolver themeResolver() {
		return new FixedThemeResolver();
	}

	@Bean
	public FlashMapManager flashMapManager() {
		return new SessionFlashMapManager();
	}

	@Bean
	public RequestToViewNameTranslator viewNameTranslator() {
		return new DefaultRequestToViewNameTranslator();
	}


}

@ImportResource

@ImportResource用于声明导入一个或多个BeanDefinition定义的资源，如<beans>.xml，支持通配符，如:

package org.ifinalframework;

@Slf4j
@ComponentScan
@ImportResource({
    FinalFramework.CLASS_PATH_SPRING_CONFIG_XML,
    FinalFramework.CLASS_PATH_CONFIG_SPRING_CONFIG_XML,
    FinalFramework.CLASS_PATH_SPRING_SPRING_CONFIG_XML
})
public class FinalFramework implements BeanNameAware {

    static final String CLASS_PATH_SPRING_CONFIG_XML = "classpath:spring-config-*.xml";

    static final String CLASS_PATH_CONFIG_SPRING_CONFIG_XML = "classpath*:config/spring-config-*.xml";

    static final String CLASS_PATH_SPRING_SPRING_CONFIG_XML = "classpath*:spring/spring-config-*.xml";

    @Getter
    @Setter
    private String beanName;

}

上述声明，可以让Spring自动加载声明在类路径config或spring目录下名称为spring-config-*.xml的资源配置文件，包含jar包中的；以及声明在应用类根目录下的spring-config-*.xml配置文件，不包含jar包中的。

面试点：classpath:和classpath*:有什么区别？

@Import

@Import与@ImportResource注解类型，都是用于导入外部配置资源的，不同的是@ImportResource是通过如beans.xml可beans.groovy的资源文件间隔导入Bean定义，而@Import是直接导入要导入的Bean的类的，更多是用来扩展Spring功能，如大家熟知的@EnableXXX都是通过@Import的方式实现的。

@Configuration

@Configuration注解主要是与其它注解搭配使用，如@Bean、@ComponentScan等。

被@Configuration标记的类可以被Spring通过Cglib库实现字节码增强，从而实现被@Bean标记的方法被调用多次时，返回的都是同一个对象（仅单例），可以通过proxyBeanMethods属性来指定是否增强被@Bean标记的方法，默认为true。

面试点：Spring是如何保证@Bean标记的方法返回的实例保证单例的？

How

了解了配置类的定义，那么如何判定一个BeanDefiniton是否是ConfigurationClass呢？

Spring提供了工具类ConfigurationClassUtils的checkConfigurationClassCandidate()方法来检测一个BeanDefinition是否是配置类。

checkConfigurationClassCandidate()

该方法中有几个核心的代码片段：

不含有工厂方法

if(className==null||beanDef.getFactoryMethodName()!=null){
    return false;
}

未实现特定接口

if(BeanFactoryPostProcessor.class.isAssignableFrom(beanClass)||
    BeanPostProcessor.class.isAssignableFrom(beanClass)||
    AopInfrastructureBean.class.isAssignableFrom(beanClass)||
    EventListenerFactory.class.isAssignableFrom(beanClass)){
    return false;
}

被@Configuration标记或是isConfigurationCandidate(metadata)

Map<String, Object> config=metadata.getAnnotationAttributes(Configuration.class.getName());
if(config!=null&&!Boolean.FALSE.equals(config.get("proxyBeanMethods"))){
    beanDef.setAttribute(CONFIGURATION_CLASS_ATTRIBUTE,CONFIGURATION_CLASS_FULL);
}else if(config!=null||isConfigurationCandidate(metadata)){
    beanDef.setAttribute(CONFIGURATION_CLASS_ATTRIBUTE,CONFIGURATION_CLASS_LITE);
}else{
    return false;
}

isConfigurationCandidate()

非接口

// Do not consider an interface or an annotation...
if (metadata.isInterface()) {
	return false;
}

含有特定标记

// Any of the typical annotations found?
for (String indicator : candidateIndicators) {
	if (metadata.isAnnotated(indicator)) {
		return true;
	}
}

// candidateIndicators 定义与初始化
private static final Set<String> candidateIndicators = new HashSet<>(8);

static {
	candidateIndicators.add(Component.class.getName());
	candidateIndicators.add(ComponentScan.class.getName());
	candidateIndicators.add(Import.class.getName());
	candidateIndicators.add(ImportResource.class.getName());
}

含有@Bean标记的方法

// Finally, let's look for @Bean methods...
try {
    return metadata.hasAnnotatedMethods(Bean.class.getName());
} catch (Throwable ex) {
    if (logger.isDebugEnabled()) {
        logger.debug("Failed to introspect @Bean methods on class [" + metadata.getClassName() + "]: " + ex);
    }
    return false;
}

至此，判定一个BeanDefinition是否是ConfigurationClass就结束了。

小结（End）

本文简述了什么是配置类，常用的配置类注解@ComponentScan、@Bean、@ImportSource等，以及判断配置类的方式。

在接下来的文章中，将和大家一起分析：

Spring 是如何进行组件扫描；
Spring 是如何实现从方法定义Bean；
Spring 是如何保证Bean方法定义的Bean只被实例化一次；
……