spring 注解解析流程回顧
基本流程與3.1.x中基本一致,5.2.x版本在注解解析的時(shí)候 ,在加入到注冊(cè)中心前,新增了 一個(gè)判斷ConditionEvaluator.shouldSkip()。需要注解的類滿足Condition.match 操作才能被添加到bean 注冊(cè)中心去。
入口函數(shù):
ConfigurationClassPostProcessor#processConfigBeanDefinition

1、ConfigurationClassParser#parse(List<BeanDefinitionHolder> configCandidates)


2、ConfigurationClassBeanDefinitionReader#loadBeanDefinitions(getImportRegistry())

示例分析
@SpringBootApplication
public class Example {
public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}
}
初始化階段
SpringApplication.run
1、進(jìn)行默認(rèn)資源的查找和初始化,以及判斷創(chuàng)建何種context。
2、依據(jù)客戶端傳入的配置信息進(jìn)行bean 的創(chuàng)建。我們傳入spring 的參數(shù)只有Example一個(gè)類名。然后這個(gè)類被@SpringBootApplication注解,@SpringBootApplication這個(gè)注解是資源解析的關(guān)鍵。
看下@SpringBootApplication注解的組成
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
public @interface SpringBootApplication{
@AliasFor(annotation = EnableAutoConfiguration.class)
Class<?>[] exclude() default {};
@AliasFor(annotation = EnableAutoConfiguration.class)
String[] excludeName() default {};
@AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
String[] scanBasePackages() default {};
@AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
Class<?>[] scanBasePackageClasses() default {};
}
@Configuration
public @interface SpringBootConfiguration {
}
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}
@SpringBootApplication 注解封裝了很多其他注解,其中能夠被解析的元注解有這個(gè)三個(gè),重點(diǎn)就是看在spring 中如果對(duì)三個(gè)注解進(jìn)行解析。
@Configuration
@import
@@ComponentScan
第一階段
BeanDefinitionLoader#load(Example.class)
private int load(Object source) {
Assert.notNull(source, "Source must not be null");
if (source instanceof Class<?>) {
return load((Class<?>) source);
}
if (source instanceof Resource) {
return load((Resource) source);
}
if (source instanceof Package) {
return load((Package) source);
}
if (source instanceof CharSequence) {
return load((CharSequence) source);
}
throw new IllegalArgumentException("Invalid source type " + source.getClass());
}
source 是一個(gè)類,用AnnotatedBeanDefinitionReader 解析配置類。
AnnotatedBeanDefinitionReader 在實(shí)例化的時(shí)候會(huì)注冊(cè)一個(gè)ConfigurationClassPostProcessor,供注解二次解析使用
AnnotationConfigUtils#registerAnnotationConfigProcessors
ConfigurationClassPostProcessor 這是一個(gè) BeanFactoryPostProcessor ,會(huì)在context 創(chuàng)建默認(rèn)bean 之前調(diào)用(見AbstractAplicationContext#refresh),可以實(shí)現(xiàn)對(duì)注冊(cè)的bean 信息進(jìn)行擴(kuò)展。
public AnnotatedBeanDefinitionReader(BeanDefinitionRegistry registry, Environment environment) {
Assert.notNull(registry, "BeanDefinitionRegistry must not be null");
Assert.notNull(environment, "Environment must not be null");
this.registry = registry;
this.conditionEvaluator = new ConditionEvaluator(registry, environment, null);
AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}
BeanDefinitionLoader#load(Example.class) 加載一個(gè)類的配置就完成了它的使命,至此第一階段配置解析結(jié)束,邏輯還是很簡(jiǎn)單。
第二階段AbstractAplicationContext#refresh
1、ConfigurationClassPostProcessor
refresh 調(diào)用 ConfigurationClassPostProcessor 進(jìn)行注解解析,對(duì)bean 進(jìn)行第二階段擴(kuò)展注冊(cè),ConfigurationClassPostProcessor 解析過程
1.1、判斷 Example.class 是否被@Configuration 或者@Component 注解, 遞歸查找注解過程,通過SpringBootApplication 查找到Configuration 注解,滿足條件,將Configuration注解的類委派為ConfigurationClassParser 處理
@SpringBootApplication —>@SpringBootConfiguration—>@Configuration—>@Component
2、ConfigurationClassParser
ConfigurationClassPostProcessor調(diào)用 ConfigurationClassParser 解析Example.class 上面所有的注解進(jìn)行解析
1、@ComponentScan
2、@Import(AutoConfigurationPackages.Registrar.class)
3、@Import(AutoConfigurationImportSelector.class)
2.1 @ComponentScan 解析
由于@SpringBootApplication沒有自定義掃描的包,使用Example所在的包作為掃描的基礎(chǔ)包,這就把工程下面所有的包添加到掃描的路徑中了,最佳實(shí)踐一般是將Example 放在包的最外層,以便使用其默認(rèn)功能。
if(basePackages.isEmpty())
basePackages.add(ClassUtils.getPackageName(declaringClass));
2.2 @Import(AutoConfigurationPackages.Registrar.class)
注冊(cè)自動(dòng)配置類的包名
//metadata 為import 注解的類
register(registry, new PackageImport(metadata).getPackageName());
// 注冊(cè)BasePackages 定義類
GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
beanDefinition.setBeanClass(BasePackages.class);
registry.registerBeanDefinition(BEAN, beanDefinition);
2.3 @Import(AutoConfigurationImportSelector.class)
這是spring 自動(dòng)配置的核心類,加載META-INF/spring.factories 的EnableAutoConfiguration類實(shí)現(xiàn)自動(dòng)配置。spring 內(nèi)置自動(dòng)配置類見:spring-boot-autoconfigure/META-INF/spring.factories
public String[] selectImports(AnnotationMetadata annotationMetadata) {
//通過屬性配置 spring.boot.enableautoconfiguration 開關(guān)改功能,默認(rèn)為開啟
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
// 加載 classpath 下面 META-INF/spring-autoconfigure-metadata.properties 屬性內(nèi)容
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
// 加載 META-INF/spring.factories文件中定義的 EnableAutoConfiguration 配置的所有類進(jìn)行配置
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
3、回到 ConfigurationClassParser 進(jìn)行遞歸解析。包含條件判斷等。
小結(jié)
spring boot 使用了spring-framework 注解解析模型,對(duì)已經(jīng)實(shí)現(xiàn)的類,添加上了默認(rèn)的配置,然后按需加載到bean 注冊(cè)中心去。除了實(shí)現(xiàn)自動(dòng)配置,boot 項(xiàng)目還提供其他功能模塊,比如統(tǒng)一日志,默認(rèn)屬性appplication.properties文件配置,校驗(yàn),web 相關(guān)等。 boot 項(xiàng)目核心是在org.springframework.boot.context 包下面實(shí)現(xiàn)的。