SpringBoot 自动配置原理（超级无敌详细）-2

SpringBoot 自动配置原理（超级无敌详细）-1

2.自动配置的实现

刚刚我们整体的过了一下主配置文件是如何实现的，但我们还没深入的研究如何实现自动装配功能。我们回到这个文件下，找一个具体的自动配置类进行分析。

jar:file:/apache-maven-3.6.3-repository/org/springframework/boot/spring-boot-autoconfigure/2.2.6.RELEASE/spring-boot-autoconfigure-2.2.6.RELEASE.jar!/META-INF/spring.factories

在这里，我们用 HttpEncodingAutoConfiguration (Http编码自动配置) 作为例子吧

org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\

注释

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(HttpProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {private final HttpProperties.Encoding properties;public HttpEncodingAutoConfiguration(HttpProperties properties) {this.properties = properties.getEncoding();}@Bean@ConditionalOnMissingBeanpublic 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;}@Beanpublic LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {return new LocaleCharsetMappingsCustomizer(this.properties);}private static class LocaleCharsetMappingsCustomizerimplements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>, Ordered {private final HttpProperties.Encoding properties;LocaleCharsetMappingsCustomizer(HttpProperties.Encoding properties) {this.properties = properties;}@Overridepublic void customize(ConfigurableServletWebServerFactory factory) {if (this.properties.getMapping() != null) {factory.setLocaleCharsetMappings(this.properties.getMapping());}}@Overridepublic int getOrder() {return 0;}}}

HttpEncodingAutoConfiguration 的源码分析

1.条件判断

第1行的 @Configuration(proxyBeanMethods = false)
- //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
第2行的@EnableConfigurationProperties(HttpEncodingProperties.class)
- //启动指定类的ConfigurationProperties功能；即自动为HttpEncodingProperties与配置文件中的值进行映射，并加入到IoC容器中
- 进入HttpProperties.class 类的内部
```
@ConfigurationProperties(prefix = "spring.http")
public class HttpProperties {/*** Whether logging of (potentially sensitive) request details at DEBUG and TRACE level* is allowed.*/private boolean logRequestDetails;/*** HTTP encoding properties.*/private final Encoding encoding = new Encoding();
```
- 将配置文件以spring.http为前缀的值和HttpEncodingProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中
第3行@ConditionalOnWebApplication
- //Spring底层@Conditional注解，根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否是web应用，如果是，当前配置类生效
第4行@ConditionalOnClass(CharacterEncodingFilter.class) // 判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；如果存在，当前配置类生效
第5行 @ConditionalOnProperty(prefix = “spring.http.encoding”, value = “enabled”, matchIfMissing = true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled； matchIfMissing = true的意思是：如果不存在，判断也是成立；即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；

2.获取组件

根据当前不同的条件判断，决定这个配置类是否生效？

**一但这个配置类生效(也就是上面的第3-5行生效)；**那么就会继续往下执行到第 14-22行

 @Bean@ConditionalOnMissingBeanpublic 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 ，这个注解的作用就是帮助我们自动的为IoC容器中添加一个 CharacterEncodingFilter 的组件。添加组件的时候我们可以注意到第18行里，设置setEncoding（）的时候需要从 properties 中获取值。简单的说，添加组件的时候需要用到某些值时，需要到 properties 中获取

3.获取配置文件—properties

那 properties 又从哪里来？我们可以看到第8行代码中，

private final HttpProperties.Encoding properties;

这一行看起来肯定很眼熟，在前面注解中的第2行代码有出现过这个

@EnableConfigurationProperties(HttpProperties.class)@ConfigurationProperties(prefix = "spring.http")
public class HttpProperties {

就是通过配置文件中的值进行对 properties 一一映射。这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

另外，在第11-13行的时候，我们可以注意到一点，HttpEncodingAutoConfiguration 该自动配置类中只有一个构造器，那么该构造器需要的参数的值就会自动的从容器中获取。也就是 properties 自动从容器中获取，并传递给 HttpEncodingAutoConfiguration 自动配置类。

 public HttpEncodingAutoConfiguration(HttpProperties properties) {this.properties = properties.getEncoding();}

那既然 properties 中的值已经获取到了，那么就会回到第18-20行的代码为过滤器等这些组件进行赋值，最种实现了自动配置的功能了。

4. 为什么properties配置文件中可以配置哪些？

不知道发现没，properties 配置文件中的提示是凭空会产生的吗？其实不是的，这也是有依据的

我们回到第2行的 @EnableConfigurationProperties(HttpProperties.class)，我们可以在properties可以配置什么值是由这个HttpProperties.class决定的，当然了，在不同的自动配置类中，这个也是不一样的。在 ``HttpProperties这个类的内部，有一个静态内部类Encoding,这个内部类的属性就是我们能够在properties` 能够配置的属性。

public static class Encoding {public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;private Charset charset = DEFAULT_CHARSET;private Boolean force;private Boolean forceRequest;private Boolean forceResponse;private Map<Locale, Charset> mapping;

所以关于 HttpEncodingAutoConfiguration 该自动配置类能够在 properties 配置文件中配置的属性就有这6个啦。

5. @Conditional派生注解（Spring注解版原生的@Conditional作用）

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

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

刚刚我们在看源码的时候，频繁的用到了@Conditional及其拓展注解，其中很重要的一点是，如果不满足指定的条件，那么就不会为容器中添加组件。

问题来了，有哪些组件时已经被加入到容器当中了的呢？[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oR6E7Gha-1587629414357)(…/…/AppData/Roaming/Typora/typora-user-images/image-20200423160231043.png)]

笨方法就是一个一个的往自动配置类中查看，哪些时为我们自动配置好了的。不过这好像不太实际，前面我们说到了，SpringBoot可以为了们自动配置差不多有141个组件，那我们显然时不能一个一个的查看得了。

这里我们就可以在主配置文件中加入一行

debug=true   //debug模式默认为false

,然后重启SpringBoot,打印日志中就能够为我们显示哪些时已经配置了，那些需要我们自己配置


============================
CONDITIONS EVALUATION REPORT
============================Positive matches:
-----------------AopAutoConfiguration matched:- @ConditionalOnProperty (spring.aop.auto=true) matched (OnPropertyCondition)AopAutoConfiguration.ClassProxyingConfiguration matched:- @ConditionalOnMissingClass did not find unwanted class 'org.aspectj.weaver.Advice' (OnClassCondition)- @ConditionalOnProperty (spring.aop.proxy-target-class=true) matched (OnPropertyCondition)Negative matches:
-----------------ActiveMQAutoConfiguration:Did not match:- @ConditionalOnClass did not find required class 'javax.jms.ConnectionFactory' (OnClassCondition)AopAutoConfiguration.AspectJAutoProxyingConfiguration:Did not match:- @ConditionalOnClass did not find required class 'org.aspectj.weaver.Advice' (OnClassCondition)

精髓：

1）、SpringBoot启动会加载大量的自动配置类

2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；

3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）

4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值；