String boot 的自动配置原理

最近在学习spring boot ,随手记录一下spring boot 的自动配置原理

 

1.String boot 在启动主配置的时候,就开启了自动配置功能    @EnableAutoConfiguration

在 @EnableAutoConfiguration 中则开启了自动配置导入选择器( @Import(AutoConfigurationImportSelector.class))

\

 1 在AutoConfigurationImportSelector 自动导入配置选择器中,重写了方法   selectImports(AnnotationMetadata annotationMetadata) 来实现对导入的配置的选择
 2 
 3 public String[] selectImports(AnnotationMetadata annotationMetadata) {
 4         if (!isEnabled(annotationMetadata)) {  //判断是否开启自动配置,默认是开启的
 5             return NO_IMPORTS;
 6         }
 7         try {
 8             AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
 9                     .loadMetadata(this.beanClassLoader);  //自动配置元数据加载器,加载"META-INF/pring-autoconfigure-metadata.properties"中的属性,返回一个properties属性文件
10             AnnotationAttributes attributes = getAttributes(annotationMetadata);//如果有的话返回注解的属性
11             List<String> configurations = getCandidateConfigurations(annotationMetadata,
12                     attributes);//获取所有的候选配置,配置文件的路径在  META-INF/spring.factories
13             configurations = removeDuplicates(configurations); //底层使用 linkedhashset 去除重复的配置属性
14             configurations = sort(configurations, autoConfigurationMetadata);//根据配置的优先级进行排序
15             Set<String> exclusions = getExclusions(annotationMetadata, attributes); //排除限制的候选配置,返回被排除的候选配置列表
16             checkExcludedClasses(configurations, exclusions);
17             configurations.removeAll(exclusions);//移除所有限制的候选配置
18             configurations = filter(configurations, autoConfigurationMetadata);
19             fireAutoConfigurationImportEvents(configurations, exclusions);
20             return StringUtils.toStringArray(configurations);
21         }
22         catch (IOException ex) {
23             throw new IllegalStateException(ex);
24         }
25     }
26 }

通过  List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置

 
 
SpringFactoriesLoader.loadFactoryNames()
扫描所有jar包类路径下  META‐INF/spring.factories
把扫描到的这些文件的内容包装成properties对象
从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器
中

　　将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；

每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；

 

接下来,我们以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

 1  @Configuration //这里表示,这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
 2     @EnableConfigurationProperties(HttpEncodingProperties.class)//指定启动类 的ConfigurationProperties功能,将配置文件的值和HttpEncodingProperties
 3     //绑定起来,并把HttpEncodingProperties 加入ioc容器
 4     @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)//@conditional spring d的底层注解,判断是不是一个web 应用,如果是,则生效,如果不是,则不生效
 5     @ConditionalOnClass(CharacterEncodingFilter.class)//判断有没有CharacterEncodingFilter这个类,即springmvc的乱码过滤器
 6     @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)//判断是否存在配置文件,"spring.http.encoding"默认不配置也是生效的
 7     public class HttpEncodingAutoConfiguration {
 8 
 9         //已经和springboot 的配置文件映射了,通过@EnableConfigurationProperties 建立映射关系
10         private final HttpEncodingProperties properties;
11 
12         //在只有一个有参构造器的情况下,properties 就需要从容器中拿
13         public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
14             this.properties = properties;
15         }
16 
17         @Bean //给容器添加一个组件,这个组件的值需要从properties中获取
18         @ConditionalOnMissingBean(CharacterEncodingFilter.class)//判断是不是没有加载CharacterEncodingFilter,没加载则执行
19         public CharacterEncodingFilter characterEncodingFilter() {
20             CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
21             filter.setEncoding(this.properties.getCharset().name());
22             filter.setForceRequestEncoding(this.properties.shouldForce(HttpEncodingProperties.Type.REQUEST));
23             filter.setForceResponseEncoding(this.properties.shouldForce(HttpEncodingProperties.Type.RESPONSE));
24             return filter;
25         }

spring boot 根据不同的的条件来判断配置类是否生效,在配置类生效的情况想,就会从 properties中获取各种配置,加载到容器中

 

 

总结:

1)  springboot 会加载大量的配置类

2)在使用时,看看springboot是否有默认写好的配置类,有的话拿来用,没有的话,自己需要写配置类

3) 然后在查看配置类中有哪些组件,我们需要的组件有的话就拿来用,没有的话就需要自己去增加

4) 给容器增加组件的过程中,会从properties 文件中获取值,我们需要在properties 文件中进行配置

5)xxxxAutoConfigurartion：自动配置类；   给容器中添加组件

　　xxxxProperties:封装配置文件中相关属性；

 

转载于:https://www.cnblogs.com/OldMonk/p/8600869.html