声明:本文如有任何纰漏、错误,还请不吝指出!java
@Configuration
注解在SpringBoot
中做用很大,且不说SpringBoot
中的外部化配置,一些第三方组件也是经过这个注解完成整合的,经常使用的好比说mybatis
,就是利用了@Configuration
这个注解来实现的。spring
在注解类中,还可使用@Bean
的方式向Spring
容器中,注入一些咱们自定义的组件。数组
在SpringBoot
中各类Enable
又是如何实现的?和@Configuration
又有什么联系呢?mybatis
这就要了解Spring
是怎么对待被@Configuration
所注解的类。框架
SpringBoot 2.2.6RELEASE
post
Spring 5.2.5.RELEASE
ui
注解依附于具体的Java
类,因此若是想获取注解的信息,必须先将类加载进来,才能从Class
对象获取到其注解元信息。this
好在Spring
容器启动以前,已经把全部须要加载的Bean,封装成一个BeanDefinition
对象,最终注册到BeanDefinitionRegistry
中。lua
BeanDefinition
包含了一个Bean
全部的信息,天然也包含了它的元注解信息。spa
有了这个就能垂手可得的获取到标注有@Configuration
注解的BeanDefinition
,从而去处理这个配置类拥有的各类配置信息。
有了BeanDefinition
以后,下面一步就是要进行Bean的实例化了。若是一个Bean
被实例化后,就没有可操做的机会了,所以Spring
在Bean
的实例化前预留了一些自定义的处理时机。
BeanFactoryPostProcessor
就是这样的一个功能,用于在Bean
实例化以前,作一些其余的处理操做。
对配置类的处理,也正是利用了这一预留点。
处理配置类,第一步就要从茫茫的BeanDefinition
中,找出哪些是配置类。
容器开始启动以前的一些准备动做,这里不说明,主要是扫描classpath
,而后将生成BeanDefinition
。
直接从容器的启动开始简单下调用栈
Spring容器真正开始启动的是从这里开始的org.springframework.context.support.AbstractApplicationContext#refresh
,在这个方法中,会去执行全部的BeanFactoryPostProcessor
。
经过一个委托类org.springframework.context.support.PostProcessorRegistrationDelegate
,执行全部的BeanFactoryPostProcessor
后置处理逻辑。
BeanFactoryPostProcessor
有一个子接口是BeanDefinitionRegistryPostProcessor
,这个接口的主要做用就是在其余后置处理执行以前,额外注册一些BeanDefinition
进来。
想一想在配置类中使用的@Import
和@Bean
,就能够猜到,这些注解的处理就是由这个处理器进行处理的。
BeanDefinitionRegistryPostProcessor
和BeanFactoryPostProcessor
是放到一块儿处理的,只不过BeanDefinitionRegistryPostProcessor
的执行时机,早于BeanFactoryPostProcessor
的执行时机。
// org.springframework.context.support.PostProcessorRegistrationDelegate public static void invokeBeanFactoryPostProcessors( ConfigurableListableBeanFactory beanFactory, List<BeanFactoryPostProcessor> beanFactoryPostProcessors) { Set<String> processedBeans = new HashSet<>(); // 若是BeanFactory同时又是一个BeanDefinitionRegistry的话 // 例如 DefaultListaleBeanFactory if (beanFactory instanceof BeanDefinitionRegistry) { BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory; List<BeanFactoryPostProcessor> regularPostProcessors = new ArrayList<>(); List<BeanDefinitionRegistryPostProcessor> registryProcessors = new ArrayList<>(); // 若是有直接注册到Context的后置处理器, // 先执行直接添加到ApplicationContext的BeanDefinitionRegistryPostProcessor处理器 for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) { if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) { BeanDefinitionRegistryPostProcessor registryProcessor = (BeanDefinitionRegistryPostProcessor) postProcessor; // 执行BeanDefinitionRegistryPostProcessor处理器 registryProcessor.postProcessBeanDefinitionRegistry(registry); // BeanDefinitionRegistryPostProcessor同时又是一个BeanFactoryPostProcessor // 待全部的BeanDefinitionRegistryPostProcessor执行完后,再来执行它 registryProcessors.add(registryProcessor); } else { // 加入到BeanFactoryPostProcessor处理器集合中,待全部的BeanDefinitionRegistryPostProcessor执行完后,来执行它 regularPostProcessors.add(postProcessor); } } List<BeanDefinitionRegistryPostProcessor> currentRegistryProcessors = new ArrayList<>(); // 对从BeanDefinitionRegistry中的BeanDefinition作后置处理 // 先执行被@PriorityOrdered注解的BeanDefinitionRegistryPostProcessor // 而且按排序大小进行优先级排序 // 根据类型,从BeanDefinitionRegistry中查找出全部的BeanDefinitionRegistryPostProcessor的是实现类,及子类 String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); for (String ppName : postProcessorNames) { // 使用@PriorityOrdered注解的先查找出来 if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class)); processedBeans.add(ppName); } } // 按编号大小排序,升序排列 sortPostProcessors(currentRegistryProcessors, beanFactory); registryProcessors.addAll(currentRegistryProcessors); // 执行BeanDefinitionRegistryPostProcessor invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); currentRegistryProcessors.clear(); // 处理被注解@Ordered标注的BeanDefinitionRegistryPostProcessor, // 而且按排序后排序后执行 // 根据类型,从BeanDefinitionRegistry中查找出全部的BeanDefinitionRegistryPostProcessor的是实现类,及子类 postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); for (String ppName : postProcessorNames) { // 没被处理过且被注解@Ordered if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) { currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class)); processedBeans.add(ppName); } } sortPostProcessors(currentRegistryProcessors, beanFactory); registryProcessors.addAll(currentRegistryProcessors); // 执行BeanDefinitionRegistryPostProcessor invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); currentRegistryProcessors.clear(); // 再去执行其余的剩下的全部BeanDefinitionRegistryPostProcessor boolean reiterate = true; while (reiterate) { reiterate = false; postProcessorNames= beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); for (String ppName : postProcessorNames) { if (!processedBeans.contains(ppName)) { currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class)); processedBeans.add(ppName); reiterate = true; } } sortPostProcessors(currentRegistryProcessors, beanFactory); registryProcessors.addAll(currentRegistryProcessors); invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); currentRegistryProcessors.clear(); } // BeanDefinitionRegistryPostProcessor也是一个BeanFactoryPostProcessor // 下面这部分就是执行postProcessBeanFactory方法, // 会在@Configuration的proxyBeanMethods为true时对配置类作一个CGLIB加强, // 表示对配置类中的BeanMethod建立时,使用代理建立 // 将加强后的类,替换到其BeanDefinition#setBeanClass invokeBeanFactoryPostProcessors(registryProcessors, beanFactory); // 最后再执行直接注册到到ApplicationContext中的BeanFactoryPostProcessor invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory); } else { // 处理直接经过ApplicationContext实例注册的BeanFactoryPostProcessor invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory); } // 上面就执行过了定义的全部的BeanDefinitionRegistryPostProcessor,以及实现的 // BeanFactoryPostProcessor#postProcessBeanFactory方法 // 接下来回去执行全部的BeanFactoryPostProcessor处理器 // 查找出全部注册的类型为BeanFactoryPostProcessor的BeanDefinition的name数组 String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false); // 分别归类出使用@PriorityOrdered 和 @Ordered注解和没有使用的 List<BeanFactoryPostProcessor> priorityOrderedPostProcessors = new ArrayList<>(); List<String> orderedPostProcessorNames = new ArrayList<>(); List<String> nonOrderedPostProcessorNames = new ArrayList<>(); for (String ppName : postProcessorNames) { if (processedBeans.contains(ppName)) { // 处理过的,不用重复处理 } else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class)); } else if (beanFactory.isTypeMatch(ppName, Ordered.class)) { orderedPostProcessorNames.add(ppName); } else { nonOrderedPostProcessorNames.add(ppName); } } // 优先处理 PriorityOrdered. sortPostProcessors(priorityOrderedPostProcessors, beanFactory); invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory); // 其次 Ordered. List<BeanFactoryPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size()); for (String postProcessorName : orderedPostProcessorNames) { orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class)); } sortPostProcessors(orderedPostProcessors, beanFactory); invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory); //最后普通的 BeanFactoryPostProcessor List<BeanFactoryPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size()); for (String postProcessorName : nonOrderedPostProcessorNames) { nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class)); } invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory); beanFactory.clearMetadataCache(); }
上面这个方法执行完后,已经完成了全部BeanFactoryPostProcessor的执行,也天然已经处理过全部的配置类了。
在众多的后置处理器中,有一个独属于@Configuration
的后置处理器,就是ConfigurationClassPostProcessor
,一个好的命名的效果,就体现出来了。
下面这个方法,负责两件事
BeanDefinitionRegistry
中筛选出配置类BeanDefinition
进行解析// org.springframework.context.annotation.ConfigurationClassPostProcessor public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { // 候选配置类集合 List<BeanDefinitionHolder> configCandidates = new ArrayList<>(); // 获取全部的BeanDefinition的name数组 String[] candidateNames = registry.getBeanDefinitionNames(); for (String beanName : candidateNames) { BeanDefinition beanDef = registry.getBeanDefinition(beanName); // 若是BeanDefinition中有这个属性存在,说明做为一个配置类已经被处理过了 if (beanDef.getAttribute(ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE) != null) { if (logger.isDebugEnabled()) { logger.debug("Bean definition has already been processed as a configuration class: " + beanDef); } } // 检查是否为一个配置类 // 查看是否具备@Configuration注解 // 这里不会仅仅看BeanDefinition所表明的类直接标注的注解,而是会递归查找其注解的注解是否有为 // @Configuration,只要找到了那么当前的类就是一个配置类 else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) { configCandidates.add(new BeanDefinitionHolder(beanDef, beanName)); } } // 找不到就结束 if (configCandidates.isEmpty()) { return; } // 对使用了@Order的进行排序 天然排序也就是升序 // 注意不是@Ordered configCandidates.sort((bd1, bd2) -> { int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition()); int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition()); return Integer.compare(i1, i2); }); // 若是有自定义Bean Name生成器,就使用自定义的 SingletonBeanRegistry sbr = null; if (registry instanceof SingletonBeanRegistry) { sbr = (SingletonBeanRegistry) registry; if (!this.localBeanNameGeneratorSet) { BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton( AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR); if (generator != null) { this.componentScanBeanNameGenerator = generator; this.importBeanNameGenerator = generator; } } } // 若是尚未初始化Environment对象,初始化一个 if (this.environment == null) { this.environment = new StandardEnvironment(); } // 解析每个被@Configuratin标注的注解类 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()); do { parser.parse(candidates); parser.validate(); Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses()); configClasses.removeAll(alreadyParsed); // 构造一个BeanDefinitionReader if (this.reader == null) { this.reader = new ConfigurationClassBeanDefinitionReader( registry, this.sourceExtractor, this.resourceLoader, this.environment, this.importBeanNameGenerator, parser.getImportRegistry()); } // 加载配置类中的@Bean,生成BeanDefinition this.reader.loadBeanDefinitions(configClasses); alreadyParsed.addAll(configClasses); candidates.clear(); // 下面这段主要是考虑到@Import进来的或者@ImportSource或者@Bean等方式注入进来的会有配置类 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()); //把 ImportRegistry注册成一个Bean,以便支持 继承ImportAware 有注解类@Configuration的配置类 if (sbr != null && !sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) { sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry()); } }
这个方法执行完后,全部的配置类都会被进行处理,而且在此过程当中,BeanDefinition
的总量有可能会增长,有新的BeanDefinition
在解析过程新增进来。
这些BeanDefinition
的来源就是存在于配置类上的其余注解
SpringBoot
是如何使用一个@SpringBootApplication
注解,完成了那么多的事情?
答案就在下面揭晓
// `org.springframework.context.annotation.ConfigurationClassParser protected final SourceClass doProcessConfigurationClass( ConfigurationClass configClass, SourceClass sourceClass, Predicate<String> filter) throws IOException { // 若是有Component注解 if (configClass.getMetadata().isAnnotated(Component.class.getName())) { // 首先递归处理内部类 processMemberClasses(configClass, sourceClass, filter); } // 处理全部的@PropertySource注解 for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable( sourceClass.getMetadata(), PropertySources.class, org.springframework.context.annotation.PropertySource.class)) { if (this.environment instanceof ConfigurableEnvironment) { processPropertySource(propertySource); } else { logger.info("Ignoring @PropertySource annotation on [" + sourceClass.getMetadata().getClassName() + "]. Reason: Environment must implement ConfigurableEnvironment"); } } // 处理全部的 @ComponentScan 和@ComponentScans 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) { // The config class is annotated with @ComponentScan -> perform the scan immediately Set<BeanDefinitionHolder> scannedBeanDefinitions = this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName()); // 继续检查扫描的BeanDefinition有没有是配置类的 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()); } } } } // 处理全部的@Import注解,将导入的Bean注册到BeanDefinitionRegistry // 会递归查找出全部的@Import // getImports会查找全部配置类上的@Import注解,@Import能够导入一个普通的配置类 // 也能够是ImportSelector或者ImportBeanDefinitionRegistrar的实现类 // 之因此须要ImportSelector和ImportBeanDefinitionRegistrar,是为了能够更加方便的一次注册多个类 // 这俩接口的实现类,也一要由Import导入进来,或者直接使用@Component,不过这样就就不必去实现接口了 // 这三个的主要用途不是为了注册本身程序中的类成为一个Bean,而是为了那些不方便使用@Component注解的类 // @Component的更像一个为了业务代码使用的注解 processImports(configClass, sourceClass, getImports(sourceClass), filter, true); // 处理全部的@ImportResource 注解,将导入的Bean注册到BeanDefinitionRegistry 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); } } // 处理独立的 @Bean方法,生成BeanMethod // 使用@Bean,方法要是可重写,也就是不能为default/private,由于要使用CGLIB代理 // 详细可进去下面方法细看 Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass); for (MethodMetadata methodMetadata : beanMethods) { configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass)); } // 处理接口的默认方法 processInterfaces(configClass, sourceClass); // 若是有父类,处理 if (sourceClass.getMetadata().hasSuperClass()) { String superclass = sourceClass.getMetadata().getSuperClassName(); if (superclass != null && !superclass.startsWith("java") && !this.knownSuperclasses.containsKey(superclass)) { this.knownSuperclasses.put(superclass, configClass); // Superclass found, return its annotation metadata and recurse return sourceClass.getSuperClass(); } } //没有父类,处理完成 return null; }
看下@SpringBootApplication
的定义
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Configuration public @interface SpringBootConfiguration { } @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) }) public @interface SpringBootApplication { }
能够看到@SpringBootApplication
在功能上也是一个@Configuration
。
这样就解释了,通常在SpringBoot
的启动类上写了那么多注解,为啥能够被执行。
若是有看过各种@Enable
注解,就必定会看到,每个@Enable
几乎都会被@Import
所注解,而通常使用@Enable
时,都会和@SpringBootApplication
写一块儿,这个写法的一方面是比较清晰,集中写到一块儿,还有个缘由就是部分@Enable
在定义时,没有使用@Configuration
来进行注解,须要借助于一个能被Spring容器启动时处理的配置类上。
上面的这段代码分析,正好解释了@Enable
背后的实现原理。
其实总的看下来,@Configuration
就是一个标志注解,更大的做用就是为别的注解服务的。这么说有点矛盾,主要是以为自己不具有什么功能性。
至于其能实现的对字段进行配置值绑定来讲,可使用@ConfigurationProperties
或者@Value
这两个注解来实现,因而可知,@Configuration
并非用于将配置文件的配置值,绑定到配置类的,这个工做和他没有任何关系,对于一些配置文件的配置来讲,可使用@Component
注解来对普通的配置类注解,达到同样的效果,而并不是必定要使用@Configuration
(@Configuration
注解派生自@Component
)。
经过咱们上面的分析,被@Configuration
注解的类,仅有存在以上那几个注解时,才有意义,才能被ConfigurationClassPostProcessor
所处理,而这个处理过程当中,和配置值绑定一毛钱的关系都没有。
实际上配置值的绑定,都是在Bean
实例化后,Bean
属性填充期间进行的。
@ConfigurationProperties
注解会在ConfigurationPropertiesBindingPostProcessor
执行时进行处理,这个处理器是一个BeanPostProcessor
。
@Value
注解的处理是在AutowiredAnnotationBeanPostProcessor
这个BeanPostProcessor
中来处理的,这个处理器同时也是处理@Inject
、 @Autowired
、 @Resource
的BeanPostProcesoor
。
Spring
或者SpringBoot
中,大量的使用各类后置处理器,除了对主体框架(Bean
的生命周期)的理解外,剩下的主要就是熟悉这些支持各类功能的PostProcessor
。
还有个值得注意的是,@Configuration
有个方法proxyBeanMethods
,这个方法返回true
时,默认也是true
,会对咱们的配置类,生成一个代理类,注意,这里是直接生成一个代理类,而且最后实例化时,也是使用这个代理类进行实例化Bean
,这个就给咱们一个启发,若是想对一些没法直接修改又被Spring
容器所管理的的Bean
,是否能够经过自定义BeanDefinitionRegistryPostProcessor
的方式,来对原Class
作一个加强,从而实现咱们的目的。
PS:是否具有切实可行性,并不保证,只是以为若是遇到,能够尝试下。