36.SpringBoot应用属性加载和自动配置@EnableAutoConfiguration

╰+攻爆jí腚メ 2022-05-19 01:17 279阅读 0赞

### SpringBoot应用文件加载 ###

SpringApplication将从以下位置的application.properties文件加载属性，并将它们添加到Spring环境中：

1. file:./config/  
2. file:./  
3. classpath:/config/  
4. classpath:/

优先级由高到底，高优先级配置会覆盖底优先级的配置。

如果您不喜欢application.properties作为配置文件名，则可以使用spring.config.name属性指定自定义文件名。

$ java -jar myproject.jar --spring.config.name=myproject

还可以使用spring.config.location属性来显式引用配置文件位置（多个以逗号隔开）。

$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

利用spring.config.location这个可以实现配置分离：

如在  classpath:application.properties(类路径的application.properties)配置如下

spring.config.location=/home/config/application.properties

然后在/home/config 的application.properties中进行你的正常配置

如果spring.config.location包含目录（而不是文件），则它们应该以/结尾（并且在加载之前将附加从spring.config.name生成的名称，包括特定于配置文件的文件名）。 spring.config.location中指定的文件按原样使用，不支持特定于配置文件的变体，并且将被任何特定于配置文件的属性覆盖。

### @EnableAutoConfiguration ###

@EnableAutoConfiguration是类级注释。 这个注释告诉Spring Boot根据你添加的jar依赖关系“猜测”你将如何配置Spring（Spring Boot自动配置尝试根据您添加的jar依赖项自动配置Spring应用程序）。例如你在pom.xml引入了spring-boot-starter-web，Spring将自动引入添加Tomcat和Spring MVC相关jar依赖，因此自动配置将假设您正在开发Web应用程序并相应地设置了默认的Spring环境。

如果您需要了解当前正在应用的自动配置以及原因，请启动您的应用程序使用--debug开关。 这将为选择的核心记录器启用调试日志并记录**自动配置报告到控制台**。

![70][]

也可以在application.properties中配置如下

#开起springboot的debug模式
    debug=true

![70 1][]

**main方法启动**

main方法是Java约定的标准方法。main方法通过调用run来委托Spring Boot的SpringApplication类。 SpringApplication将引导我们的应用程序，启动Spring，然后启动自动配置的Tomcat Web服务器。 例如：我们需要将WebApplication.class作为参数传递给run方法，以告诉SpringApplication是主要的Spring组件，args数组也被传递以暴露任何命令行参数。

@SpringBootApplication
    public class WebApplication extends SpringBootServletInitializer {
    
    	public static void main(String[] args) {
    		SpringApplication.run(WebApplication.class, args); 
    	}
    
    }

## 自动配置原理 ##

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

@@SpringBootApplication注解已经整合@EnableAutoConfiguration

2）、@EnableAutoConfiguration 作用：  
利用EnableAutoConfigurationImportSelector给容器中导入一些组件？

![70 2][]

![70 3][]

可以查看selectImports()方法的内容；

![70 4][]

/\*\*

返回应该考虑的自动配置类名。 默认情况下，此方法将使用SpringFactoriesLoader和getSpringFactoriesLoaderFactoryClass（）加载候选项。

\*/

List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置，源码如下

![70 5][]

![70 6][]

SpringFactoriesLoader.loadFactoryNames()源码如下

扫描所有jar包类路径下 META‐INF/spring.factories  
   把扫描到的这些文件的内容包装成properties对象  
   从properties中获取到EnableAutoConfiguration.class（相当于是key,查找key对应的value）类（类名）对应的值，然后把他们添加在容器中

![70 7][]

FACTORIES\_RESOURCE\_LOCATION  为

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

![70 9][]

每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置  
3）、每一个自动配置类进行自动配置功能；  
4）、以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
    @Configuration
    //启动指定类的
    //ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把
    //HttpEncodingProperties加入到ioc容器中
    @EnableConfigurationProperties(HttpEncodingProperties.class)
    //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果
    //满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否是web应用，如果是，当前配置类生效
    @ConditionalOnWebApplication
    //判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
    @ConditionalOnClass(CharacterEncodingFilter.class)
    //判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的
    //即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
    @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
    public class HttpEncodingAutoConfiguration {
        ///他已经和SpringBoot的配置文件映射了
    	private final HttpEncodingProperties properties;
        只有一个有参构造器的情况下，参数的值就会从容器中拿
    	public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
    		this.properties = properties;
    	}
        给容器中添加一个组件，这个组件的某些值需要从properties中获取
    	@Bean
    	@ConditionalOnMissingBean(CharacterEncodingFilter.class)
    	public CharacterEncodingFilter characterEncodingFilter() {
    		CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
    		filter.setEncoding(this.properties.getCharset().name());
    		filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
    		filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
    		return filter;
    	}
    
    	@Bean
    	public LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {
    		return new LocaleCharsetMappingsCustomizer(this.properties);
    	}
    
    	private static class LocaleCharsetMappingsCustomizer
    			implements EmbeddedServletContainerCustomizer, Ordered {
    
    		private final HttpEncodingProperties properties;
    
    		LocaleCharsetMappingsCustomizer(HttpEncodingProperties properties) {
    			this.properties = properties;
    		}
    
    		@Override
    		public void customize(ConfigurableEmbeddedServletContainer container) {
    			if (this.properties.getMapping() != null) {
    				container.setLocaleCharsetMappings(this.properties.getMapping());
    			}
    		}
    
    		@Override
    		public int getOrder() {
    			return 0;
    		}
    
    	}
    
    }

根据当前不同的条件判断，决定这个配置类是否生效？  
一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取  
的，这些类里面的每一个属性又是和配置文件绑定的；  
5）、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘；配置文件能配置什么就可以参照某个功  
能对应的这个属性类

//从配置文件中获取指定的值和bean的属性进行绑定,如果配置文件中没有设置，将采用系统默认属性
    @ConfigurationProperties(prefix = "spring.http.encoding")
    public class HttpEncodingProperties {
    
    	public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

精髓：  
1）、SpringBoot启动会加载大量的自动配置类  
2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；  
3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）  
4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这  
些属性的值；  
xxxxAutoConfigurartion：自动配置类；  
给容器中添加组件  
xxxxProperties:封装配置文件中相关属性；

2、细节  
1、@Conditional派生注解（Spring注解版原生的@Conditional作用）  
作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

org.springframework.boot.autoconfigure.condition 这个包里面有所有的Conditional注解

<table> 
 <tbody> 
  <tr> 
   <td>@Conditional扩展注解</td> 
   <td>作用（判断是否满足当前指定条件）</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnJava</td> 
   <td>系统的java版本是否符合要求</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnBean</td> 
   <td>容器中存在指定Bean；</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingBean</td> 
   <td>容器中不存在指定Bean；</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnExpression</td> 
   <td>满足SpEL表达式指定</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnClass</td> 
   <td>系统中有指定的类</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingClass</td> 
   <td>系统中没有指定的类</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnSingleCandidate</td> 
   <td>容器中只有一个指定的Bean，或者这个Bean是首选Bean</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnProperty</td> 
   <td>系统中指定的属性是否有指定的值</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnResource</td> 
   <td>类路径下是否存在指定资源文件</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnWebApplication</td> 
   <td>当前是web环境</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnNotWebApplication</td> 
   <td>当前不是web环境</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnJndi</td> 
   <td>JNDI存在指定项</td> 
  </tr> 
 </tbody> 
</table>

自动配置类必须在一定的条件下才能生效，我们怎么知道哪些自动配置类生效；  
我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置  
类生效；

**微信公众号**               ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70][]

[70]: /images/20220519/677611b0df1044e6a192db4a7b01c284.png
[70 1]: /images/20220519/4d45434f763648279eddfe6db224fe77.png
[70 2]: /images/20220519/827b436c0e9a4066b36117df5416ee94.png
[70 3]: /images/20220519/cec90a4f35d742ab92fd4febb444a51d.png
[70 4]: /images/20220519/2aab280672be4cfe921978cd6f8f4b7b.png
[70 5]: /images/20220519/c921e2db1e454825a37a3afdfa9133ca.png
[70 6]: /images/20220519/f3189e44e0bd40b0b1bc7bd11edf26a2.png
[70 7]: /images/20220519/61eef99a41a84586b8604d3313024209.png
[70 8]: /images/20220519/a95bf1bff403482d92215c03af09846d.png
[70 9]: /images/20220519/20c2970224a04ec0ae4056901b189834.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20220519/891af80b70ca47eeb959e6f9c8a94bdd.png