spring 注解解析流程回顾
基本流程与3.1.x中基本一致,5.2.x版本在注解解析的时候 ,在加入到注册中心前,新增了 一个判断ConditionEvaluator.shouldSkip()。需要注解的类满足Condition.match 操作才能被添加到bean 注册中心去。
入口函数:
ConfigurationClassPostProcessor#processConfigBeanDefinition
image.png
1、ConfigurationClassParser#parse(List<BeanDefinitionHolder> configCandidates)
ConfigurationClassParser#parse.png
processConfigurationClass.png
2、ConfigurationClassBeanDefinitionReader#loadBeanDefinitions(getImportRegistry())
loadBeanDefinitions.png示例分析
@SpringBootApplication
public class Example {
public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}
}
初始化阶段
SpringApplication.run
1、进行默认资源的查找和初始化,以及判断创建何种context。
2、依据客户端传入的配置信息进行bean 的创建。我们传入spring 的参数只有Example一个类名。然后这个类被@SpringBootApplication注解,@SpringBootApplication这个注解是资源解析的关键。
看下@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 注解封装了很多其他注解,其中能够被解析的元注解有这个三个,重点就是看在spring 中如果对三个注解进行解析。
@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 是一个类,用AnnotatedBeanDefinitionReader 解析配置类。
AnnotatedBeanDefinitionReader 在实例化的时候会注册一个ConfigurationClassPostProcessor,供注解二次解析使用
AnnotationConfigUtils#registerAnnotationConfigProcessors
ConfigurationClassPostProcessor 这是一个 BeanFactoryPostProcessor ,会在context 创建默认bean 之前调用(见AbstractAplicationContext#refresh),可以实现对注册的bean 信息进行扩展。
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) 加载一个类的配置就完成了它的使命,至此第一阶段配置解析结束,逻辑还是很简单。
第二阶段AbstractAplicationContext#refresh
1、ConfigurationClassPostProcessor
refresh 调用 ConfigurationClassPostProcessor 进行注解解析,对bean 进行第二阶段扩展注册,ConfigurationClassPostProcessor 解析过程
1.1、判断 Example.class 是否被@Configuration 或者@Component 注解, 递归查找注解过程,通过SpringBootApplication 查找到Configuration 注解,满足条件,将Configuration注解的类委派为ConfigurationClassParser 处理
@SpringBootApplication —>@SpringBootConfiguration—>@Configuration—>@Component
2、ConfigurationClassParser
ConfigurationClassPostProcessor调用 ConfigurationClassParser 解析Example.class 上面所有的注解进行解析
1、@ComponentScan
2、@Import(AutoConfigurationPackages.Registrar.class)
3、@Import(AutoConfigurationImportSelector.class)
2.1 @ComponentScan 解析
由于@SpringBootApplication没有自定义扫描的包,使用Example所在的包作为扫描的基础包,这就把工程下面所有的包添加到扫描的路径中了,最佳实践一般是将Example 放在包的最外层,以便使用其默认功能。
if(basePackages.isEmpty())
basePackages.add(ClassUtils.getPackageName(declaringClass));
2.2 @Import(AutoConfigurationPackages.Registrar.class)
注册自动配置类的包名
//metadata 为import 注解的类
register(registry, new PackageImport(metadata).getPackageName());
// 注册BasePackages 定义类
GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
beanDefinition.setBeanClass(BasePackages.class);
registry.registerBeanDefinition(BEAN, beanDefinition);
2.3 @Import(AutoConfigurationImportSelector.class)
这是spring 自动配置的核心类,加载META-INF/spring.factories 的EnableAutoConfiguration类实现自动配置。spring 内置自动配置类见:spring-boot-autoconfigure/META-INF/spring.factories
public String[] selectImports(AnnotationMetadata annotationMetadata) {
//通过属性配置 spring.boot.enableautoconfiguration 开关改功能,默认为开启
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
// 加载 classpath 下面 META-INF/spring-autoconfigure-metadata.properties 属性内容
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
// 加载 META-INF/spring.factories文件中定义的 EnableAutoConfiguration 配置的所有类进行配置
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
3、回到 ConfigurationClassParser 进行递归解析。包含条件判断等。
小结
spring boot 使用了spring-framework 注解解析模型,对已经实现的类,添加上了默认的配置,然后按需加载到bean 注册中心去。除了实现自动配置,boot 项目还提供其他功能模块,比如统一日志,默认属性appplication.properties文件配置,校验,web 相关等。 boot 项目核心是在org.springframework.boot.context 包下面实现的。
网友评论