SpringBoot自动配置原理

蔚落 2022-01-31 22:39 558阅读 0赞

配置文件到底能写什么?怎么写?自动配置原理; 配置文件能配置的属性参照

1**、自动配置原理:**

1)、SpringBoot启动的时候加载主配置类,开启了自动配置功能 @EnableAutoConfiguration

2**)、**@EnableAutoConfiguration 作用:

  • 利用EnableAutoConfigurationImportSelector给容器中导入一些组件?
  • 可以查看selectImports()方法的内容;
  • List confifigurations = getCandidateConfifigurations(annotationMetadata, attributes);获取候选的配置

SpringFactoriesLoader.loadFactoryNames()

扫描所有jar包类路径下 META‐INF/spring.factories

把扫描到的这些文件的内容包装成properties对象

从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,然后把他们添加在容器 中

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

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70

  1. # Auto Configure
  2. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  3. org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
  4. org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
  5. org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
  6. org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
  7. org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
  8. org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
  9. org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
  10. org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
  11. org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
  12. org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
  13. org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
  14. org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,
  15. \
  16. org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
  17. org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration
  18. ......
  19. org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration,\
  20. org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration,\
  21. org.springframework.boot.autoconfigure.web.HttpEncodingAutoConfiguration,\
  22. org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration,\
  23. org.springframework.boot.autoconfigure.web.MultipartAutoConfiguration,\
  24. org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration,\
  25. org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration,\
  26. org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration,\
  27. org.springframework.boot.autoconfigure.websocket.WebSocketAutoConfiguration,\
  28. org.springframework.boot.autoconfigure.websocket.WebSocketMessagingAutoConfiguration,\
  29. org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration

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

3)、每一个自动配置类进行自动配置功能;

4)、以HttpEncodingAutoConfifiguration**Http编码自动配置)**为例解释自动配置原理;

  1. @Configuration //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
  2. @EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的
  3. //ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把
  4. //HttpEncodingProperties加入到ioc容器中
  5. @ConditionalOnWebApplication //Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果
  6. //满足指定的条件,整个配置类里面的配置就会生效; 判断当前应用是否是web应用,如果是,当前配置类生效
  7. @ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类
  8. CharacterEncodingFilterSpringMVC中进行乱码解决的过滤器;
  9. @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing =
  10. true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled;如果不存在,判断也是成立的
  11. //即使我们配置文件中不配置pring.http.encoding.enabled=true,也是默认生效的;
  12. public class HttpEncodingAutoConfiguration {
  13. //他已经和SpringBoot的配置文件映射了
  14. private final HttpEncodingProperties properties;
  15. //只有一个有参构造器的情况下,参数的值就会从容器中拿
  16. public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
  17. this.properties = properties;
  18. }
  19. @Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获
  20. @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件?
  21. public CharacterEncodingFilter characterEncodingFilter() {
  22. CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter()
  23. filter.setEncoding(this.properties.getCharset().name());
  24. filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
  25. filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
  26. return filter;
  27. }
  28. }
  29. 一旦这个配置类生效;这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties类中获取 的,这些类里面的每一个属性又是和配置文件绑定的;

5)、所有在配置文件中能配置的属性都是在xxxxProperties类中封装着;配置文件能配置什么就可以参照某个功能对应的这个属性类 。

  1. @ConfigurationProperties(prefix = "spring.http.encoding") //从配置文件中获取指定的值和bean的属性进行绑定
  2. public class HttpEncodingProperties {
  3. public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");

精髓:

  • 1**)、SpringBoot启动会加载大量的自动配置类**
  • 2**)、我们看SpringBoot默认写好的自动配置类有没有我们需要的功能;**
  • 3**)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)**
  • 4**)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这**些属性的值;

例如:

20190512171002119.png

  • xxxxAutoConfifigurartion:自动配置类; xxxxProperties:封装配置文件中相关属性;

@Conditional**派生注解(Spring注解版原生的@Conditional作用)**

作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70 1

自动配置类必须在一定的条件下才能生效;

我们怎么知道哪些自动配置类生效;

我们可以在配置文件中通过启用**debug=true**属性;来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置

类生效;

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70 2

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70 3

发表评论

表情:
评论列表 (有 0 条评论,558人围观)

还没有评论,来说两句吧...

相关阅读

    相关 SpringBoot自动配置原理

    SpringBoot可以简化开发的一个主要原因就是采用了默认配置,所谓约定大于配置就是这个意思。在没有自己指定配置的时候使用默认配置的原理大致如下。如有错误,还请指正。 ==

    相关 SpringBoot自动配置原理

            配置文件到底能写什么?怎么写?自动配置原理; [配置文件能配置的属性参照][Link 1] 1、自动配置原理: 1)、SpringBoot启动的时候加