(1) @Configuration注解的作用是什么,Spring是如何解析加了@Configuration注解的类?
(2) Spring在什么时候对@ComponentScan、@ComponentScans注解进行了解析?
(3) Spring什么时候解析了@Import注解,如何解析的?
(4) Spring什么时候解析了@Bean注解?
1. 作用
其实上面的四个问题,都可以一个类来解释,即本文的主角:
ConfigurationClassPostProcessor
。那么这个类究竟是如何来解决这些问题的呢?
ConfigurationClassPostProcessor是一个BeanFactory的后置处理器,因此它的主要功能是参与BeanFactory的建造,在这个类中,会解析加了@Configuration的配置类,还会解析@ComponentScan、@ComponentScans注解扫描的包,以及解析@Import等注解。
ConfigurationClassPostProcessor 实现了 BeanDefinitionRegistryPostProcessor 接口,而 BeanDefinitionRegistryPostProcessor 接口继承了 BeanFactoryPostProcessor 接口,所以 ConfigurationClassPostProcessor 中需要重写 postProcessBeanDefinitionRegistry() 方法和 postProcessBeanFactory()方法。而ConfigurationClassPostProcessor类的作用就是通过这两个方法去实现的。
ConfigurationClassPostProcessor这个类是Spring内置的一个BeanFactory后置处理器,是在this()方法中将其添加到BeanDefinitionMap中的(可以参考笔者的另一篇文章
mp.weixin.qq.com/s/q6zs7xRjp…
)。在执行过程中,会先执行postProcessBeanDefinitionRegistry(),然后执行postProcessBeanFactory()。
文章有点长,先用一张图简单描述一下执行流程。
2. postProcessBeanDefinitionRegistry()
postProcessBeanDefinitionRegistry()方法中调用了processConfigBeanDefinitions(),所以核心逻辑在processConfigBeanDefinition()方法中。
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry){
processConfigBeanDefinitions(registry);
processConfigBeanDefinitions()方法代码如下(省略了部分不重要的代码),源码中添加了许多注释,解释了部分重要方法的作用。
public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
List<BeanDefinitionHolder> configCandidates = new ArrayList<>();
String[] candidateNames = registry.getBeanDefinitionNames();
for (String beanName : candidateNames) {
BeanDefinition beanDef = registry.getBeanDefinition(beanName);
if (ConfigurationClassUtils.isFullConfigurationClass(beanDef) ||
ConfigurationClassUtils.isLiteConfigurationClass(beanDef)) {
else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {
configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
SingletonBeanRegistry sbr = null;
if (registry instanceof SingletonBeanRegistry) {
sbr = (SingletonBeanRegistry) registry;
if (!this.localBeanNameGeneratorSet) {
BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton(CONFIGURATION_BEAN_NAME_GENERATOR);
if (generator != null) {
this.componentScanBeanNameGenerator = generator;
this.importBeanNameGenerator = generator;
ConfigurationClassParser parser = new ConfigurationClassParser(
this.metadataReaderFactory, this.problemReporter, this.environment,
this.resourceLoader, this.componentScanBeanNameGenerator, registry);
Set<BeanDefinitionHolder> candidates = new LinkedHashSet<>(configCandidates);
Set<ConfigurationClass> alreadyParsed = new HashSet<>(configCandidates.size());
parser.parse(candidates);
parser.validate();
Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());
configClasses.removeAll(alreadyParsed);
if (this.reader == null) {
this.reader = new ConfigurationClassBeanDefinitionReader(
registry, this.sourceExtractor, this.resourceLoader, this.environment,
this.importBeanNameGenerator, parser.getImportRegistry());
this.reader.loadBeanDefinitions(configClasses);
alreadyParsed.addAll(configClasses);
candidates.clear();
if (registry.getBeanDefinitionCount() > candidateNames.length) {
String[] newCandidateNames = registry.getBeanDefinitionNames();
Set<String> oldCandidateNames = new HashSet<>(Arrays.asList(candidateNames));
Set<String> alreadyParsedClasses = new HashSet<>();
for (ConfigurationClass configurationClass : alreadyParsed) {
alreadyParsedClasses.add(configurationClass.getMetadata().getClassName());
for (String candidateName : newCandidateNames) {
if (!oldCandidateNames.contains(candidateName)) {
BeanDefinition bd = registry.getBeanDefinition(candidateName);
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bd, this.metadataReaderFactory) &&
!alreadyParsedClasses.contains(bd.getBeanClassName())) {
candidates.add(new BeanDefinitionHolder(bd, candidateName));
candidateNames = newCandidateNames;
while (!candidates.isEmpty());
if (sbr != null && !sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) {
sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry());
if (this.metadataReaderFactory instanceof CachingMetadataReaderFactory) {
((CachingMetadataReaderFactory) this.metadataReaderFactory).clearCache();
复制代码
2.1 ConfigurationClassUtils.checkConfigurationClassCandidate()
该方法是用来判断一个是否是一个配置类,并为BeanDefinition
设置属性为lite
或者full
。如果加了@Configuration
,那么对应的BeanDefinition
为full
,如果加了@Bean
,@Component
,@ComponentScan
,@Import
,@ImportResource
这些注解,则为lite
。lite
和full
均表示这个BeanDefinition
对应的类是一个配置类。
部分代码如下:
public static boolean checkConfigurationClassCandidate(BeanDefinition beanDef, MetadataReaderFactory metadataReaderFactory) {
// ... 省略部分不重要的代码
if (isFullConfigurationCandidate(metadata)) {
// 含有@Configuration注解,那么对应的BeanDefinition的configurationClass属性值设置为full
beanDef.setAttribute(CONFIGURATION_CLASS_ATTRIBUTE, CONFIGURATION_CLASS_FULL);
else if (isLiteConfigurationCandidate(metadata)) {
// 含有@Bean,@Component,@ComponentScan,@Import,@ImportResource注解
// configurationClass属性值设置为lite
beanDef.setAttribute(CONFIGURATION_CLASS_ATTRIBUTE, CONFIGURATION_CLASS_LITE);
else {
return false;
return true;
isFullConfigurationCandidate()
方法用来判断一个类是否加了@Configuration注解
public static boolean isFullConfigurationCandidate(AnnotationMetadata metadata) {
return metadata.isAnnotated(Configuration.class.getName());
isLiteConfigurationCandidate()
方法用来判断类是否加了@Bean,@Component,@ComponentScan,@Import,@ImportResource
注解
public static boolean isLiteConfigurationCandidate(AnnotationMetadata metadata) {
for (String indicator : candidateIndicators) {
if (metadata.isAnnotated(indicator)) {
return true;
try {
return metadata.hasAnnotatedMethods(Bean.class.getName());
catch (Throwable ex) {
return false;
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());
复制代码
2.2 parser.pase()
该方法调用的是ConfigurationClassParser.parse()
,ConfigurationClassParser
类,根据类名就能猜测出,这个类是用来解析配置类的。
parse()
方法会解析配置类上的注解(ComponentScan扫描出的类,@Import注册的类,以及@Bean方法定义的类),解析完以后(解析成ConfigurationClass类),会将解析出的结果放入到parser
的configurationClasses
这个属性中(这个属性是个Map)。parse会将@Import注解要注册的类解析为BeanDefinition,但是不会把解析出来的BeanDefinition放入到BeanDefinitionMap中,真正放入到map中是在这一行代码实现的:
this.reader.loadBeanDefinitions(configClasses)
下面先看下parse()
的具体代码parser.parse(candidates)
, parse()
方法需要一个参数,参数candidates是一个集合,集合中的元素个数由我们写的这一行代码决定:
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class)
在AnnotationConfigApplicationContext
的构造方法中,我们传入了一个AppConfig类,那么candidates的大小为1,里面的元素为AppConfig类所对应的BeanDefinitionHolder(或者说是BeanDefinition,BeanDefinitionHolder只是将BeanDefinition封装了一下,可以简单的认为两者等价)。AnnotationConfigApplicationContext构造方法可以传入多个类,对应的candidates的大小等于这里传入类的个数(这种说法其实不太严谨,因为AnnotationConfigApplicationContext.register()
方法也能像容器中注册配置类)
parse()具体代码
public void parse(Set<BeanDefinitionHolder> configCandidates) {
this.deferredImportSelectors = new LinkedList<>();
for (BeanDefinitionHolder holder : configCandidates) {
BeanDefinition bd = holder.getBeanDefinition();
try {
if (bd instanceof AnnotatedBeanDefinition) {
parse(((AnnotatedBeanDefinition) bd).getMetadata(), holder.getBeanName());
}else if (bd instanceof AbstractBeanDefinition && ((AbstractBeanDefinition) bd).hasBeanClass()) {
parse(((AbstractBeanDefinition) bd).getBeanClass(), holder.getBeanName());
}else {
parse(bd.getBeanClassName(), holder.getBeanName());
processDeferredImportSelectors();
复制代码
2.2.1 processConfigurationClass() 核心代码
该方法的核心方法为doProcessConfigurationClass
protected void processConfigurationClass(ConfigurationClass configClass) throws IOException {
SourceClass sourceClass = asSourceClass(configClass);
sourceClass = doProcessConfigurationClass(configClass, sourceClass);
while (sourceClass != null);
this.configurationClasses.put(configClass, configClass);
复制代码
2.2.2 doProcessConfigurationClass()代码
doProcessConfigurationClass()方法中,执行流程如下:
(1) 处理内部类,如果内部类也是一个配置类(判断一个类是否是一个配置类,通过ConfigurationClassUtils.checkConfigurationClassCandidate()
可以判断)。
(2) 处理属性资源文件,加了@PropertySource
注解。
(3) 首先解析出类上的@ComponentScan和@ComponentScans注解,然后根据配置的扫描包路径,利用ASM技术(ASM技术是一种操作字节码的技术,有兴趣的朋友可以去网上了解下)扫描出所有需要交给Spring管理的类,由于扫描出的类中可能也被加了@ComponentScan和@ComponentScans注解,因此需要进行递归解析,直到所有加了这两个注解的类被解析完成。
(4) 处理@Import注解。通过@Import注解,有三种方式可以将一个Bean注册到Spring容器中。
(5) 处理@ImportResource注解,解析配置文件。
(6) 处理加了@Bean注解的方法。
(7) 通过processInterfaces()
处理接口的默认方法,从JDK8开始,接口中的方法可以有自己的默认实现,因此,如果这个接口中的方法也加了@Bean注解,也需要被解析。(很少用)
(8) 解析父类,如果被解析的配置类继承了某个类,那么配置类的父类也会被进行解析doProcessConfigurationClass()
(父类是JDK内置的类例外,即全类名以java开头的)。
关于第(7)步,举个例子解释下。如下代码示例,AppConfig
类加了Configuration
注解,是一个配置类,且实现了AppConfigInterface
接口,这个接口中有一个默认的实现方法(JDK8开始,接口中的方法可以有默认实现),该方法上添加了@Bean
注解。这个时候,经过第(7)步的解析,会想spring容器中添加一个InterfaceMethodBean
类型的bean。
@Configuration
public class AppConfig implements AppConfigInterface{
public interface AppConfigInterface {
@Bean
default InterfaceMethodBean interfaceMethodBean() {
return new InterfaceMethodBean();
doProcessConfigurationClass()
的源码如下,源码中加了中文注释
protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
throws IOException {
processMemberClasses(configClass, sourceClass);
for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), PropertySources.class,
org.springframework.context.annotation.PropertySource.class)) {
if (this.environment instanceof ConfigurableEnvironment) {
processPropertySource(propertySource);
Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);
if (!componentScans.isEmpty() &&
!this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {
for (AnnotationAttributes componentScan : componentScans) {
Set<BeanDefinitionHolder> scannedBeanDefinitions =
this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
for (BeanDefinitionHolder holder : scannedBeanDefinitions) {
BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition();
if (bdCand == null) {
bdCand = holder.getBeanDefinition();
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) {
parse(bdCand.getBeanClassName(), holder.getBeanName());
processImports(configClass, sourceClass, getImports(sourceClass), true);
AnnotationAttributes importResource =
AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);
if (importResource != null) {
String[] resources = importResource.getStringArray("locations");
Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");
for (String resource : resources) {
String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);
configClass.addImportedResource(resolvedResource, readerClass);
Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
for (MethodMetadata methodMetadata : beanMethods) {
configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
return null;
复制代码
2.3 this.reader.loadBeanDefinitions()
该方法实际上是将通过@Import
、@Bean
等注解方式注册的类解析成BeanDefinition
,然后注册到BeanDefinitionMap
中。
public void loadBeanDefinitions(Set<ConfigurationClass> configurationModel) {
TrackedConditionEvaluator trackedConditionEvaluator = new TrackedConditionEvaluator();
for (ConfigurationClass configClass : configurationModel) {
loadBeanDefinitionsForConfigurationClass(configClass, trackedConditionEvaluator);
private void loadBeanDefinitionsForConfigurationClass(
ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) {
if (configClass.isImported()) {
registerBeanDefinitionForImportedConfigurationClass(configClass);
for (BeanMethod beanMethod : configClass.getBeanMethods()) {
loadBeanDefinitionsForBeanMethod(beanMethod);
loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());
loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars());
复制代码
3. postProcessBeanFactory()方法
该方法是对BeanFactory
进行处理,用来干预BeanFactory
的创建过程。主要干了两件事,(1)对加了@Configuration
注解的类进行CGLIB代理。(2)向Spring中添加一个后置处理器ImportAwareBeanPostProcessor
。
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
int factoryId = System.identityHashCode(beanFactory);
if (this.factoriesPostProcessed.contains(factoryId)) {
throw new IllegalStateException(
"postProcessBeanFactory already called on this post-processor against " + beanFactory);
this.factoriesPostProcessed.add(factoryId);
if (!this.registriesPostProcessed.contains(factoryId)) {
processConfigBeanDefinitions((BeanDefinitionRegistry) beanFactory);
enhanceConfigurationClasses(beanFactory);
beanFactory.addBeanPostProcessor(new ImportAwareBeanPostProcessor(beanFactory));
复制代码
3.1 CGLIB增强Configuration类
利用enhanceConfigurationClasses(beanFactory)方法对Configuration类进行增强,采用CGLIB来创建动态代理
public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFactory) {
ConfigurationClassEnhancer enhancer = new ConfigurationClassEnhancer();
for (Map.Entry<String, AbstractBeanDefinition> entry : configBeanDefs.entrySet()) {
Class<?> enhancedClass = enhancer.enhance(configClass, this.beanClassLoader);
ConfigurationClassEnhancer.enhance()方法
public Class<?> enhance(Class<?> configClass, @Nullable ClassLoader classLoader) {
Class<?> enhancedClass = createClass(newEnhancer(configClass, classLoader));
return enhancedClass;
ConfigurationClassEnhancer.newEnhancer()方法
private Enhancer newEnhancer(Class<?> configSuperClass, @Nullable ClassLoader classLoader) {
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(configSuperClass);
enhancer.setInterfaces(new Class<?>[] {EnhancedConfiguration.class});
enhancer.setUseFactory(false);
enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE);
enhancer.setStrategy(new BeanFactoryAwareGeneratorStrategy(classLoader));
enhancer.setCallbackFilter(CALLBACK_FILTER);
enhancer.setCallbackTypes(CALLBACK_FILTER.getCallbackTypes());
return enhancer;
CGLIB
创建动态代理是基于继承来是实现的(JDK的动态代理是基于接口实现),因此enhancer.setSupperclass(configSuperClass)
这一行代码,就是为即将产生的代理对象设置父类,同时为产生的代理对象实现EnhancedConfiguration.class
接口,实现该接口的目的,是为了该Configuration
类在实例化、初始化过程中,执行相关的BeanPostProcessor。
例如在执行ImportAwareBeanPostProcessor
后置处理器时,postProcessPropertyValues()
方法,会对EnhancedConfiguration
类进行属性设置,实际就是为EnhancedConfiguration
实现类的beanfactory
属性赋值
3.2 添加ImportAwareBeanPostProcessor后置处理器
ConfigurationClassPostProcessor
类的postProcessBeanFactory()
方法在最后会向spring容器中添加一个Bean后置处理器:ImportAwareBeanPostProcessor
,Bean后置处理器最终会在Bean实例化和初始化的过程中执行,参与Bean的创建过程。在上面已经通过源码分析了该后置处理器postProcessPropertyValues()
方法,其作用是为EnhanceConfiguration
类的beanFactory属性赋值。
ImportAwareBeanPostProcessor
代码
private static class ImportAwareBeanPostProcessor extends InstantiationAwareBeanPostProcessorAdapter {
private final BeanFactory beanFactory;
public ImportAwareBeanPostProcessor(BeanFactory beanFactory) {
this.beanFactory = beanFactory;
@Override
public PropertyValues postProcessPropertyValues(
PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) {
if (bean instanceof EnhancedConfiguration) {
((EnhancedConfiguration) bean).setBeanFactory(this.beanFactory);
return pvs;
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) {
if (bean instanceof ImportAware) {
ImportRegistry ir = this.beanFactory.getBean(IMPORT_REGISTRY_BEAN_NAME, ImportRegistry.class);
AnnotationMetadata importingClass = ir.getImportingClassFor(bean.getClass().getSuperclass().getName());
if (importingClass != null) {
((ImportAware) bean).setImportMetadata(importingClass);
return bean;
复制代码
4. 总结
本文主要分析了 ConfigurationClassPostProcessor 类的作用,由于该类实现了 BeanFactoryPostProcessor 接口和 BeanDefinitionRegistryPostProcessor 接口,所以会重写 postProcessBeanDefinitionRegistry() 方法和 postProcessBeanFactory() 方法。
在postProcessBeanDefinitionRegistry()
方法中解析了加了Configuration注解的类,同时解析出 @ComponentScan 和 @ComponentScans 扫描出的Bean,也会解析出加了 @Bean 注解的方法所注册的Bean,以及通过 @Import 注解注册的Bean和 @ImportResource 注解导入的配置文件中配置的Bean。在 postProcessBeanDefinitionRegistry() 方法中,通过源码分析了两个十分重要的方法:ConfigurationClassParser.parse()
和this.reader.loadBeanDefinitions()
在postProcessBeanFactory()
方法中,会利用CGLIB对加了@Configuration
注解的类创建动态代理,进行增强。最后还会向spring容器中添加一个Bean后置处理器:ImportAwareBeanPostProcessor
5. 本文的坑
事先说明,这些坑后面会单独写文章发布到该微信公众号中解释,有兴趣的朋友可以先自己研究下。
(1) 一个配置类必须加@Configuration
注解?不加就不能被Spring解析了吗?例如如下代码:
@ComponentScan("com.tiantang.study")
public class AppConfig {
public class MainApplication {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
(2) 为什么加了@Configuration注解的类需要被CGLIB进行增强?
(3) 结合(2),看下下面的代码,应该打印几次注入UserDao
?1次还是2次?去掉@Configuration呢?
下面的代码中,AppConfig类加了Configuration注解,然后通过@Bean注解注册了两个Bean,最后在orderDao()方法中调用了userDao()方法。
@Configuration
public class AppConfig {
@Bean
public UserDao userDao(){
System.out.println("注入UserDao");
return new UserDao();
@Bean
public OrderDao orderDao(){
userDao();
return new OrderDao();
public class MainApplication {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
扫描下方二维码或者微信搜索公众号菜鸟飞呀飞
,即可关注微信公众号,阅读更多Spring源码分析文章