当前位置:   article > 正文

Spring Boot自动配置_springboot自动配置

springboot自动配置

Spring boot 特性:

1、能够快速创建基于Spring的应用程序; 2、能够直接使用java main方法启动内嵌的Tomcat,Jetty服务器运行Spring boot程序,不需要部署war包文件; 3、提供约定的starter POM来简化Maven配置,让Maven的配置变得简单; 4、根据项目的Maven依赖配置,Spring boot自动配置Spring、Spring mvc等; 5、提供了程序的健康检查等功能; 6、基本可以完全不使用XML配置文件,采用注解配置。

Spring boot四大核心:

1、自动配置:针对很多Spring应用程序和常见的应用功能,Spring Boot能自动提供相关配置; 2、起步依赖:告诉Spring Boot需要什么功能,它就能引入需要的依赖库; 3、Actuator:让你能够深入运行中的应用程序,一探Spring Boot程序的内部信息; 4、命令行界面:这是Spring Boot的可选特性,主要针对Groovy语言使用。

1.1、自动配置简介

SpringBoot的自动配置就是当Spring容器启动后,一些自动配置类(只是自动配置类,并不是当前的组件配置到IOC容器中,自动配置类通过@Conditional注解来按需配置)就自动装配的IOC容器中,不需要我们手动注入,从而简化了开发,省去繁琐的配置。

一个SpringBoot工程如果想运行成功,就必须有一个主程序类,所有 Spring Boot 项目的主启动程序类上都使用了一个 @SpringBootApplication 注解,该注解是 Spring Boot 中最重要的注解之一 ,也是 Spring Boot 实现自动化配置的关键。

当我们进入@SpringBootApplication注解的源码当中,可以发现它是一个复合注解,它由@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan这三个注解组成。

  • @EnableAutoConfiguration:启用 SpringBoot 的自动配置机制。
  • @SpringBootConfiguration(实际是:@Configuration):声明当前类是一个配置类,然后Spring会自动扫描到添加了@Configuration的类,并且读取其中的配置信息,允许在上下文中注册额外的 bean 或导入其他配置类,
  • @ComponentScan: 扫描被@Component (@Service,@Controller)注解的 bean,注解默认会扫描启动类所在的包下所有的类 ,可以自定义不扫描某些 bean

1.2、自动配置原理

@EnableAutoConfiguration会开启SpringBoot的自动配置,并且根据你引入的依赖来生效对应的默认配置。那么问题来了:

  • 这些默认配置是在哪里定义的呢?
  • 为何依赖引入就会触发配置呢?

Spring Factories 机制

Spring Boot 的自动配置是基于 Spring Factories 机制实现的。
Spring Factories 机制是 Spring Boot 中的一种服务发现机制,这种扩展机制与 Java SPI 机制十分相似。Spring Boot 会自动扫描所有 Jar 包类路径下 META-INF/spring.factories 文件,并读取其中的内容,进行实例化,这种机制也是 Spring Boot Starter 的基础。

在 spring-boot-autoconfigure-xxx.jar 类路径下的 META-INF/spring.factories 中设置了 Spring Boot 自动配置的内容,其中定义了大量自动配置类,几乎涵盖了现在主流的开源框架,例如:redis、amqp、jdbc、jackson、mongodb、jpa、elasticsearch等等,如下图

SpringBoot内部对大量的第三方库或Spring内部库进行了默认配置,这些配置是否生效,取决于我们是否引入了对应库所需的依赖,如果有那么默认配置就会生效(通过@ConditionalOnBean注解实现,@ConditionalOnBean的作用是 容器中存在指定的 Bean 时才生效)。

所以,我们使用SpringBoot构建一个项目,只需要引入所需框架的依赖,配置就可以交给SpringBoot处理了。除非你不希望使用SpringBoot的默认配置,它也提供了自定义配置的入口。

1.3、自动配置加载过程

@EnableAutoConfiguration 注解 用于开启 Spring Boot 的自动配置功能, 它使用 Spring 框架提供的 @Import 注解通过
AutoConfigurationImportSelector类(选择器)给容器中导入自动配置组件。

1.3.1 @AutoConfigurationPackage注解

默认将主配置类( @SpringBootApplication )所在的包及其子包里面的所有组件扫描到IOC容器中。

在@AutoConfigurationPackage注解中存在一个@Import(AutoConfigurationPackages.Registrar.class)注解,自动配置包就是通过这个Registrar类的方法来完成的。

1.3.2 AutoConfigurationImportSelector 类

AutoConfigurationImportSelector 加载所有符合条件的META-INF/spring.factorie类

AutoConfigurationImportSelector 接口何时被执行?

SpringBoot 启动时会使用 ConfigurationClassParser 来解析被 @Configuration 标识的配置类, 然后再处理这个类内部被其他注解修饰的情况, 比如 @Import 注解, @ComponentScan 注解,@Bean 注解等

如果发现注解中存在 @Import(ImportSelector) 的情况下,就会创建一个相应的 ImportSelector 对象,并调用其 process 方法

process() 方法,该方法通过调用 getAutoConfigurationEntry() 方法读取 spring.factories 文件中的内容,获得自动配置类的集合,代码如下

  1. public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
  2. Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector, () -> {
  3. return String.format("Only %s implementations are supported, got %s", AutoConfigurationImportSelector.class.getSimpleName(), deferredImportSelector.getClass().getName());
  4. });
  5. //拿到 META-INF/spring.factories中的EnableAutoConfiguration,并做排除、过滤处理
  6. //AutoConfigurationEntry里有需要引入配置类和排除掉的配置类,最终只要返回需要配置的配置类
  7. AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector)deferredImportSelector).getAutoConfigurationEntry(annotationMetadata);
  8. //加入缓存,List<AutoConfigurationEntry>类型
  9. this.autoConfigurationEntries.add(autoConfigurationEntry);
  10. Iterator var4 = autoConfigurationEntry.getConfigurations().iterator();
  11. while(var4.hasNext()) {
  12. String importClassName = (String)var4.next();
  13. //加入缓存,Map<String, AnnotationMetadata>类型
  14. this.entries.putIfAbsent(importClassName, annotationMetadata);
  15. }
  16. }

getAutoConfigurationEntry() 方法通过调用 getCandidateConfigurations() 方法来获取自动配置类的完全限定名,并在经过排除、过滤等处理后,将其缓存到成员变量中,具体代码如下。

  1. protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
  2. if (!this.isEnabled(annotationMetadata)) {
  3. return EMPTY_ENTRY;
  4. } else {
  5. //获取注解元数据中的属性设置
  6. AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
  7. //获取自动配置类
  8. //通过getCandidateConfigurations得到待配置的class的类名集合,这个集合就是所有需要进行自动配置的类名,而是是否配置的关键在于META-INF/spring.factories文件中是否存在该配置信息
  9. List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
  10. //删除list 集合中重复的配置类
  11. configurations = this.removeDuplicates(configurations);
  12. //获取排除导入的配置类
  13. Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
  14. //检查是否还存在排除配置类
  15. this.checkExcludedClasses(configurations, exclusions);
  16. //删除排除的配置类
  17. configurations.removeAll(exclusions);
  18. //获取过滤器,过滤配置类
  19. configurations = this.getConfigurationClassFilter().filter(configurations);
  20. //触发自动化配置导入事件
  21. this.fireAutoConfigurationImportEvents(configurations, exclusions);
  22. return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
  23. }
  24. }

通过getCandidateConfigurations得到待配置的class的类名集合,这个集合就是所有需要进行自动配置的类名,而是是否配置的关键在于META-INF/spring.factories文件中是否存在该配置信息

在 getCandidateConfigurations() 方法中,根据 Spring Factories 机制调用 SpringFactoriesLoader 的 loadFactoryNames() 方法(后面Spring Factories 实现原理中有介绍这个方法),根据 EnableAutoConfiguration.class (自动配置接口)获取其实现类(自动配置类)的类名的集合,如下图。

 

2、Spring Factories 原理

2.1、spring.factories

spring.factories 文件本质上与 properties 文件相似,其中包含一组或多组键值对

(key=vlaue),其中,key 的取值为接口的完全限定名;value 的取值为接口实现类的完全限定名,一个接口可以设置多个实现类,不同实现类之间使用“,”隔开,例如:\

  1. org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
  2. org.springframework.boot.autoconfigure.condition.OnBeanCondition,\
  3. org.springframework.boot.autoconfigure.condition.OnClassCondition,\
  4. org.springframework.boot.autoconfigure.condition.OnWebApplicationCondition

spring.factories 文件可以将 spring-boot 项目包以外的 bean(即在 pom 文件中添加依赖中的 bean)注册到 spring-boot 项目的 spring 容器。由于@ComponentScan 注解只能扫描 spring-boot 项目包内的 bean 并注册到 spring 容器中,因此需要 @EnableAutoConfiguration 注解来注册项目包外的bean。而 spring.factories 文件,则是用来记录项目包外需要注册的bean类名

2.2 Spring Factories 实现原理

spring-core 包里定义了 SpringFactoriesLoader 类,这个类会扫描所有 Jar 包类路径下的 META-INF/spring.factories 文件,并获取指定接口的配置。在 SpringFactoriesLoader 类中定义了两个对外的方法,如下表。

返回值方法描述
ListloadFactories(Class factoryType, @Nullable ClassLoader classLoader)静态方法; 根据接口获取其实现类的实例; 该方法返回的是实现类对象列表。
ListloadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader)公共静态方法; 根据接口l获取其实现类的名称; 该方法返回的是实现类的类名的列表

以上两个方法的关键都是从指定的 ClassLoader中获取spring.factories 文件,并解析得到类名列表,具体代码如下。 loadFactories() 方法能够获取指定接口的实现类对象,具体代码如下。

  1. public static <T> List<T> loadFactories(Class<T> factoryType, @Nullable ClassLoader classLoader) {
  2. // 调用loadFactoryNames获取接口的实现类
  3. List<String> factoryImplementationNames = loadFactoryNames(factoryType, classLoaderToUse);
  4. // 遍历 factoryNames 数组,创建实现类的对象
  5. List<T> result = new ArrayList(factoryImplementationNames.size());
  6. Iterator var5 = factoryImplementationNames.iterator();
  7. //排序
  8. while(var5.hasNext()) {
  9. String factoryImplementationName = (String)var5.next();
  10. result.add(instantiateFactory(factoryImplementationName, factoryType, classLoaderToUse));
  11. }
  12. AnnotationAwareOrderComparator.sort(result);
  13. return result;
  14. }

loadFactoryNames() 方法能够根据接口获取其实现类类名的集合,具体代码如下。

  1. public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
  2. String factoryTypeName = factoryType.getName();
  3. //获取自动配置类
  4. return (List)loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
  5. }

loadSpringFactories() 方法能够读取该项目中所有 Jar 包类路径下 META-INF/spring.factories 文件的配置内容,并以 Map 集合的形式返回,具体代码如下。

  1. private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
  2. Map<String, List<String>> result = (Map)cache.get(classLoader);
  3. if (result != null) {
  4. return result;
  5. } else {
  6. HashMap result = new HashMap();
  7. try {
  8. //扫描所有 Jar 包类路径下的 META-INF/spring.factories 文件
  9. Enumeration urls = classLoader.getResources("META-INF/spring.factories");
  10. while(urls.hasMoreElements()) {
  11. URL url = (URL)urls.nextElement();
  12. UrlResource resource = new UrlResource(url);
  13. //将扫描到的 META-INF/spring.factories 文件中内容包装成 properties 对象
  14. Properties properties = PropertiesLoaderUtils.loadProperties(resource);
  15. Iterator var6 = properties.entrySet().iterator();
  16. while(var6.hasNext()) {
  17. Map.Entry<?, ?> entry = (Map.Entry)var6.next();
  18. //提取 properties 对象中的 key
  19. String factoryTypeName = ((String)entry.getKey()).trim();
  20. //提取 proper 对象中的 value 值(多个类的完全限定名使用逗号连接的字符串)
  21. // 使用逗号为分隔符转换为数组,数组内每个元素都是配置类的完全限定名
  22. String[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
  23. String[] var10 = factoryImplementationNames;
  24. int var11 = factoryImplementationNames.length;
  25. //遍历配置类数组,并将数组转换为 list 集合
  26. for(int var12 = 0; var12 < var11; ++var12) {
  27. String factoryImplementationName = var10[var12];
  28. ((List)result.computeIfAbsent(factoryTypeName, (key) -> {
  29. return new ArrayList();
  30. })).add(factoryImplementationName.trim());
  31. }
  32. }
  33. }
  34. //将 propertise 对象的 key 与由配置类组成的 List 集合一一对应存入名为 result 的 Map 中
  35. result.replaceAll((factoryType, implementations) -> {
  36. return (List)implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList));
  37. });
  38. cache.put(classLoader, result);
  39. //返回 result
  40. return result;
  41. } catch (IOException var14) {
  42. throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var14);
  43. }
  44. }
  45. }

2.3 应用启动时ConfigurationClassPostProcessor的注册

Springboot 应用在启动时,会创建一个ApplicationContext上下文实例。如果是Web应用,该上下文实例会使用类 AnnotationConfigEmbeddedWebApplicationContext来创建;否则使用类AnnotationConfigApplicationContext来创建。

不管是以上两种情况中的哪一种,相应的上下文类实例在创建时都会创建一个AnnotatedBeanDefinitionReader实例用于读取注解方式的Bean定义,而在创建这个AnnotatedBeanDefinitionReader实例的过程中,它注册了一个 ConfigurationClassPostProcessor Bean定义到容器,这是一个BeanFactoryPostProcessor,更明确地讲,它是一个BeanDefinitionRegistryPostProcessor。

ConfigurationClassPostProcessor被设计用来发现所有的配置类和相关的Bean定义并注册到容器,它在所有BeanFactoryPostProcessor中具备最高执行优先级,因为其他BeanFactoryPostProcessor需要基于注册了Bean定义工作

在springboot启动过程中,具体的来讲,是在以下位置被完成自动配置

  1. SpringApplication.run()
  2. => refreshContext()
  3. => AbstractApplicationContext.refresh()
  4. => invokeBeanFactoryPostProcessors()
  5. => ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry()
  6. => processConfigBeanDefinitions()
  7. => ConfigurationClassParser.parse()
  8. => processDeferredImportSelectors()
  9. => AutoConfigurationImportSelector.selectImports()

在启动时把实现类org.springframework.boot.autoconfigure.EnableAutoConfiguration定义了哪些类是自动配置类,使用属性org.springframework.boot.autoconfigure.AutoConfigurationImportFilter定义了哪些自动配置导入过滤器会被应用,缺省情况下,只有一个过滤器会被应用,那就是OnClassCondition

AutoConfigurationImportSelector.selectImports()在执行时 :

1.从spring-autoconfigure-metadata.properties属性文件中提取自动配置元数据AutoConfigurationMetadata;

  1. spring-boot-autoconfigure jar包的文件结构
  2. ├─META-INF
  3. │ spring-autoconfigure-metadata.properties
  4. │ spring.factories
  5. └─org
  6. └─springframework
  7. └─boot
  8. └─autoconfigure

2.获取spring.factories属性文件中属性org.springframework.boot.autoconfigure.EnableAutoConfiguration定义的所有配置类作为候选配置类;

3.然后,获取spring.factories属性文件中属性org.springframework.boot.autoconfigure.AutoConfigurationImportFilter定义的过滤器,缺省是一个 : org.springframework.boot.autoconfigure.condition.OnClassCondition

4.对所有的候选配置类在自动配置元数据上 应用 所发现的过滤器,其实缺省情况下就一个,就是 OnClassCondition,也就是利用每个候选配置类上的注解 @ConditionalOnClass , 来看这个候选配置类是否需要被应用。

selectImports()会返回所有需要被应用的配置类(注解@ConditionalOnClass条件被满足),ConfigurationClassPostProcessor.postProcessBeanFactory()会将识别这些配置类中定义的bean并将它们注册到容器

整个流程如下图所示

2.4、自动配置的生效和修改

spring.factories 文件中的所有自动配置类(xxxAutoConfiguration),都是必须在一定的条件下才会作为组件添加到容器中,配置的内容才会生效。这些限制条件在 Spring Boot 中以 @Conditional 派生注解的形式体现,如下表。

注解生效条件
@ConditionalOnJava应用使用指定的 Java 版本时生效
@ConditionalOnBean容器中存在指定的 Bean 时生效
@ConditionalOnMissingBean容器中不存在指定的 Bean 时生效
@ConditionalOnExpression满足指定的 SpEL 表达式时生效
@ConditionalOnClass存在指定的类时生效
@ConditionalOnMissingClass不存在指定的类时生效
@ConditionalOnSingleCandidate容器中只存在一个指定的 Bean 或这个 Bean 为首选 Bean 时生效
@ConditionalOnProperty系统中指定属性存在指定的值时生效
@ConditionalOnResource类路径下存在指定的资源文件时生效
@ConditionalOnWebApplication当前应用是 web 应用时生效
@ConditionalOnNotWebApplication当前应用不是 web 应用生效

下面我们以
ServletWebServerFactoryAutoConfiguration 为例,介绍 Spring Boot 自动配置是如何生效的。

ServletWebServerFactoryAutoConfiguration 代码如下。

  1. @Configuration( //表示这是一个配置类,与 xml 配置文件等价,也可以给容器中添加组件
  2. proxyBeanMethods = false
  3. )
  4. @AutoConfigureOrder(-2147483648)
  5. @ConditionalOnClass({ServletRequest.class})//判断当前项目有没有 ServletRequest 这个类
  6. @ConditionalOnWebApplication(// 判断当前应用是否是 web 应用,如果是,当前配置类生效
  7. type = Type.SERVLET
  8. )
  9. @EnableConfigurationProperties({ServerProperties.class})
  10. //启动指定类的属性配置(ConfigurationProperties)功能;将配置文件中对应的值和 ServerProperties 绑定起来;并把 ServerProperties 加入到ioc容器中
  11. @Import({ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class, EmbeddedTomcat.class, EmbeddedJetty.class, EmbeddedUndertow.class})
  12. public class ServletWebServerFactoryAutoConfiguration {
  13. public ServletWebServerFactoryAutoConfiguration() {
  14. }
  15. @Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获取
  16. public ServletWebServerFactoryCustomizer servletWebServerFactoryCustomizer(ServerProperties serverProperties, ObjectProvider<WebListenerRegistrar> webListenerRegistrars) {
  17. return new ServletWebServerFactoryCustomizer(serverProperties, (List) webListenerRegistrars.orderedStream().collect(Collectors.toList()));
  18. }
  19. @Bean
  20. @ConditionalOnClass(
  21. name = {"org.apache.catalina.startup.Tomcat"}
  22. )
  23. public TomcatServletWebServerFactoryCustomizer tomcatServletWebServerFactoryCustomizer(ServerProperties serverProperties) {
  24. return new TomcatServletWebServerFactoryCustomizer(serverProperties);
  25. }
  26. @Bean
  27. @ConditionalOnMissingFilterBean({ForwardedHeaderFilter.class})
  28. @ConditionalOnProperty(
  29. value = {"server.forward-headers-strategy"},
  30. havingValue = "framework"
  31. )
  32. public FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter() {
  33. ForwardedHeaderFilter filter = new ForwardedHeaderFilter();
  34. FilterRegistrationBean<ForwardedHeaderFilter> registration = new FilterRegistrationBean(filter, new ServletRegistrationBean[0]);
  35. registration.setDispatcherTypes(DispatcherType.REQUEST, new DispatcherType[]{DispatcherType.ASYNC, DispatcherType.ERROR});
  36. registration.setOrder(-2147483648);
  37. return registration;
  38. }
  39. public static class BeanPostProcessorsRegistrar implements ImportBeanDefinitionRegistrar, BeanFactoryAware {
  40. private ConfigurableListableBeanFactory beanFactory;
  41. public BeanPostProcessorsRegistrar() {
  42. }
  43. public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
  44. if (beanFactory instanceof ConfigurableListableBeanFactory) {
  45. this.beanFactory = (ConfigurableListableBeanFactory) beanFactory;
  46. }
  47. }
  48. public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
  49. if (this.beanFactory != null) {
  50. this.registerSyntheticBeanIfMissing(registry, "webServerFactoryCustomizerBeanPostProcessor", WebServerFactoryCustomizerBeanPostProcessor.class, WebServerFactoryCustomizerBeanPostProcessor::new);
  51. this.registerSyntheticBeanIfMissing(registry, "errorPageRegistrarBeanPostProcessor", ErrorPageRegistrarBeanPostProcessor.class, ErrorPageRegistrarBeanPostProcessor::new);
  52. }
  53. }
  54. private <T> void registerSyntheticBeanIfMissing(BeanDefinitionRegistry registry, String name, Class<T> beanClass, Supplier<T> instanceSupplier) {
  55. if (ObjectUtils.isEmpty(this.beanFactory.getBeanNamesForType(beanClass, true, false))) {
  56. RootBeanDefinition beanDefinition = new RootBeanDefinition(beanClass, instanceSupplier);
  57. beanDefinition.setSynthetic(true);
  58. registry.registerBeanDefinition(name, beanDefinition);
  59. }
  60. }
  61. }
  62. }

该类使用了以下注解:

  • @Configuration:用于定义一个配置类,可用于替换 Spring 中的 xml 配置文件;
  • @Bean:被 @Configuration 注解的类内部,可以包含有一个或多个被 @Bean 注解的方法,用于构建一个 Bean,并添加到 Spring 容器中;该注解与 spring 配置文件中 等价,方法名与 的 id 或 name 属性等价,方法返回值与 class 属性等价;
  • @EnableConfigurationProperties(ServerProperties.class).他的意思是启动指定类的
    ConfigurationProperties功能;将配置文件中对应的值和 ServerProperties 绑定起来;并把
    ServerProperties 加入到 IOC 容器中。

除了 @Configuration 和 @Bean 注解外,该类还使用 5 个 @Conditional 衍生注解:

  • @ConditionalOnClass({ServletRequest.class}):判断当前项目是否存在 ServletRequest 这个类,若存在,则该配置类生效。
  • @ConditionalOnWebApplication(type = Type.SERVLET):判断当前应用是否是 Web 应用,如果是的话,当前配置类生效。
  • @ConditionalOnClass(name = {"org.apache.catalina.startup.Tomcat"}):判断是否存在 Tomcat 类,若存在则该方法生效。
  • @ConditionalOnMissingFilterBean({ForwardedHeaderFilter.class}):判断容器中是否有 ForwardedHeaderFilter 这个过滤器,若不存在则该方法生效。
  • @ConditionalOnProperty(value = {"server.forward-headers-strategy"},havingValue = "framework"):判断配置文件中是否存在 server.forward-headers-strategy = framework,若不存在则该方法生效。

ServerProperties

ServletWebServerFactoryAutoConfiguration 类还使用了一个 @EnableConfigurationProperties 注解,通过该注解导入了一个 ServerProperties 类,其部分源码如下。

  1. @ConfigurationProperties(
  2. prefix = "server",
  3. ignoreUnknownFields = true
  4. )
  5. public class ServerProperties {
  6. private Integer port;
  7. private InetAddress address;
  8. @NestedConfigurationProperty
  9. private final ErrorProperties error = new ErrorProperties();
  10. private ServerProperties.ForwardHeadersStrategy forwardHeadersStrategy;
  11. private String serverHeader;
  12. private DataSize maxHttpHeaderSize = DataSize.ofKilobytes(8L);
  13. private Shutdown shutdown;
  14. @NestedConfigurationProperty
  15. private Ssl ssl;
  16. @NestedConfigurationProperty
  17. private final Compression compression;
  18. @NestedConfigurationProperty
  19. private final Http2 http2;
  20. private final ServerProperties.Servlet servlet;
  21. private final ServerProperties.Tomcat tomcat;
  22. private final ServerProperties.Jetty jetty;
  23. private final ServerProperties.Netty netty;
  24. private final ServerProperties.Undertow undertow;
  25. public ServerProperties() {
  26. this.shutdown = Shutdown.IMMEDIATE;
  27. this.compression = new Compression();
  28. this.http2 = new Http2();
  29. this.servlet = new ServerProperties.Servlet();
  30. this.tomcat = new ServerProperties.Tomcat();
  31. this.jetty = new ServerProperties.Jetty();
  32. this.netty = new ServerProperties.Netty();
  33. this.undertow = new ServerProperties.Undertow();
  34. }
  35. ....
  36. }

我们看到,
ServletWebServerFactoryAutoConfiguration 使用了一个 @EnableConfigurationProperties 注解,而 ServerProperties 类上则使用了一个 @ConfigurationProperties 注解。这其实是 Spring Boot 自动配置机制中的通用用法。 Spring Boot 中为我们提供了大量的自动配置类 XxxAutoConfiguration 以及 XxxProperties,每个自动配置类 XxxAutoConfiguration 都使用了 @EnableConfigurationProperties 注解,而每个 XxxProperties 上都使用 @ConfigurationProperties 注解。

@ConfigurationProperties 注解的作用,是将这个类的所有属性与配置文件中相关的配置进行绑定,以便于获取或修改配置,但是 @ConfigurationProperties 功能是由容器提供的,被它注解的类必须是容器中的一个组件,否则该功能就无法使用。而 @EnableConfigurationProperties 注解的作用正是将指定的类以组件的形式注入到 IOC 容器中,并开启其 @ConfigurationProperties 功能。因此,@ConfigurationProperties + @EnableConfigurationProperties 组合使用,便可以为 XxxProperties 类实现配置绑定功能

自动配置类 XxxAutoConfiguration 负责使用 XxxProperties 中属性进行自动配置,而 XxxProperties 则负责将自动配置属性与配置文件的相关配置进行绑定,以便于用户通过配置文件修改默认的自动配置。也就是说,真正“限制”我们可以在配置文件中配置哪些属性的类就是这些 XxxxProperties 类,它与配置文件中定义的 prefix 关键字开头的一组属性是唯一对应的。

注意:XxxAutoConfiguration 与 XxxProperties 并不是一一对应的,大多数情况都是多对多的关系,即一个 XxxAutoConfiguration 可以同时使用多个 XxxProperties 中的属性,一个 XxxProperties 类中属性也可以被多个 XxxAutoConfiguration 使用。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/很楠不爱3/article/detail/165668
推荐阅读
相关标签
  

闽ICP备14008679号