SpringBoot-源码剖析-3-自动配置

---

前言

这一篇主要是针对SpringBoot的主要特性中的自动配置进行学习
也就是学习下，Springboot自动配置的原理
前面已经学习过SpringBoot的自动配置使用了，什么是SpringBoot的自动配置呢？
就是根据添加的jar包依赖，自动的将一些配置类的bean注册进ioc容器，然后我们可以在需要的地方使用@AutoWired注解或者@Resource注解来使用
接下来还是带着问题来学习源码

---

一、Spring Boot到底是如何进行自动配置的，都把哪些组件进行了自动配置?

首先我们知道SpringBoot项目的启动入口是**@SpringBootApplication注解标注的类中的main方法**
在SpringBoot项目中@SpringBootApplication注解标注的类就是这个项目的主配置类
那么我们肯定还要从这个注解开始看的，我们先看一下注解的源码

从源码可以看出**@SpringBootApplication注解是一个组合注解**
上面四个注解是元注解我们就不多说了，所以重点是下边的三个注解：
@SpringBootConfiguration、@EnableAutoConfiguration、 @ComponentScan
接下来我们一个一个的看

1、@SpringBootConfiguration注解

这个注解我们不陌生，SpringBoot中标注这个注解的就表示该类是一个配置类，需要在启动的时候加载
我们也顺便再看一下这个注解的源码：
我们可以看到，@SpringBootConfiguration注解的核心注解是@Configuration注解，这个注解是Spring提供的，表示当前类是一个配置类，并可以被组件扫描器扫描，所以说：@SpringBootConfiguration注解只是对@Configuration注解的一个重命名封装而已

2、@EnableAutoConfiguration注解

直接看下源码：

我们看到它里面主要就是两个注解：一个@AutoConfigurationPackage，一个@Import注解
SpringBoot中有很多以Enable开头的注解，其作用都是借助@Import注解来收集并注册特定场景相关的Bean，并加载到IOC容器中

(1)、@AutoConfigurationPackage注解

从字面理解就是自动配置包，我们看下源码：

可以看到主要也是使用了@Import注解
意思就是使用@Import注解向容器中导入AutoConfigurationPackages.Registrar.class组件
我们来看一下这个组件具体是做什么的：

可以看到这边是一个静态内部类，我们来看一下我们的项目启动的时候这里是什么效果：

可以看到这边获取到的就是我们当前项目的包，我们再看下register方法里做了什么：

从上面的代码我们可以看到，如果该Bean已经注册的话就将注册包名称添加进去，如果没有注册的话就先注册bean，参数中的包名会被设置到bean定义中去

总结一下：
AutoConfigurationPackages.Registrar.class组件就干了一件事：注册一个bean，这个bean是org.springframework.boot.autoconfigure.AutoConfigurationPackages，他有一个参数这个参数是使用了@AutoConfigurationPackage 这个注解的类所在的包路径,保存自动配置类以供之后的使用，比如给 JPA entity 扫描器用来扫描开发人员通过注解 @Entity 定义的 entity 类。

(2)、@Import(AutoConfigurationImportSelector.class)

这个我们应该就可以理解了：把AutoConfigurationImportSelector这个组件导入到Spring容器中
我们来看下这个组件源码

可以看到 AutoConfigurationImportSelector 主要是实现了 DeferredImportSelector 接口和各种 Aware 接口

这些Aware接口就是为了回调给下面的属性赋值

二、自动装配的核心逻辑

1、入口

自动装配的逻辑相关入口方法在静态内部类：DeferredImportSelectorGrouping中的getImports方法（别人告诉我在这里的，我确实没找到），接下来我们从这里入手开下自动配置的具体源码：

AutoConfigurationGroup:是AutoConfigurationImportSelector的内部类，主要用来处理自动配置相关的逻辑，拥有process和selectImports方法，然后拥有entries和 autoConfigurationEntries集合属性，这两个集合分别存储被处理后的符合条件的自动配置类，我们知道这些就足够了; AutoConfigurationImportSelector:承担自动配置的绝大部分逻辑，负责选择一些符合条件的自动配置类;
metadata:标注在SpringBoot启动类上的@SpringBootApplication注解元数据
标【2】的this.group.selectImports的方法主要是针对前面的process方法处理后的自动配置类再进一步有选择的选择导入

往里走看下AutoConfigurationImportSelector的内部类AutoConfigurationGroup的process方法（具体的执行）：

图中可以看到，自动装配相关的入口方法就在process方法中，接下来就是主要逻辑了：

同样一步步看一下，首先是调用AutoConfigurationImportSelector.getAutoConfigurationEntry方法将得到的自动配置类放到autoConfigurationEntry对象中

顺便看一下响应的是什么：

开始正文：首先第一步获取所有的自动配置列，从哪来呢？怎么来呢？我们看代码：

深入 这个getCandidateConfigurations 方法看看：

再看下loadFactoryNames方法：

从代码中我们可以知道，在这个方法中会遍历整个ClassLoader中所有jar包下的spring.factories文件，该文件里面保存着springboot的默认提供的自动配置类

总结一下这个方法主要做的就是从类加载器中获取到所有的jar包里的spring.factoties文件中的自动装配配置类（EnableAutoConfiguration）进行加载

我们返回去继续往下看：

这一小段就比较简单，就是想尽办法把重复的或者标记过排除的类从自动装配列表里干掉
接下来我们继续看filter方法：

filter方法主要做的事情就是调用接口AutoConfigurationImportFilter的match方法来判断每一个自动配置类上的条件注解(若有的话) @ConditionalOnBean 或 @ConditionalOnWebApplication 是否满足 条件，若满足，则返回true，说明匹配，若不满足，则返回false说明不匹配。

好了process讲完了，我们来看下this.group.selectImports方法：

可以看到， selectImports 方法主要是针对经过排除掉 的和被 AutoConfigurationImportFilter 接口过滤后的满足条件的自动配置类再进一步排除的自动配置类，然后再排序

关于条件注解的讲解
@Conditional是Spring4新提供的注解，它的作用是按照一定的条件进行判断，满足条件给容器注册 bean。
@ConditionalOnBean:仅仅在当前上下文中存在某个对象时，才会实例化一个Bean。
@ConditionalOnClass:某个class位于类路径上，才会实例化一个Bean。
@ConditionalOnExpression:当表达式为true的时候，才会实例化一个Bean。基于SpEL表达式 的条件判断。 @ConditionalOnMissingBean:仅仅在当前上下文中不存在某个对象时，才会实例化一个Bean。
@ConditionalOnMissingClass:某个class类路径上不存在的时候，才会实例化一个Bean。
@ConditionalOnNotWebApplication:不是web应用，才会实例化一个Bean。
@ConditionalOnWebApplication:当项目是一个Web项目时进行实例化。
@ConditionalOnNotWebApplication:当项目不是一个Web项目时进行实例化。
@ConditionalOnProperty:当指定的属性有指定的值时进行实例化。
@ConditionalOnJava:当JVM版本为指定的版本范围时触发实例化。
@ConditionalOnResource:当类路径下有指定的资源时触发实例化。
@ConditionalOnJndi:在JNDI存在的条件下触发实例化。
@ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个，或者有多个但是指定了首 选的Bean时触发实例化。

三、举例：以 HttpEncodingAutoConfiguration( 编码自动配置)为例解释自动配置原理

我们知道在spring项目中j经常会出现中文的乱码，那么我们在测试的SpringBoot项目中并没有处理过编码问题效果是怎样的呢？

我们可以看到并没有出现乱码的情况，这是为什么呢？SpringBoot是怎么做到的呢？同样是自动装配，这里我们就来看一下
我们看到在spring.factories文件中，有一个HttpEncodingAutoConfiguration组件

我们来具体看下它的实现：

根据当前不同的条件判断，决定这个配置类是否生效。
一旦这个配置类生效，这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的
properties 类中获取的，这些类里面的每一个属性又是和配置文件绑定的

# 我们能配置的属性都是来源于这个功能的properties类 
spring.http.encoding.enabled=true 
spring.http.encoding.charset=utf-8 
spring.http.encoding.force=true

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

// 从配置文件中获取指定的值和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 类中获取某些属性，我们就可以在配置文件中指定这些属性的值。
   xxxAutoConfiguration :自动配置类，用于给容器中添加组件从而代替之前我们手动完成大量繁琐的配置。
   xxxProperties : 封装了对应自动配置类的默认属性值，如果我们需要自定义属性值，只需要根据xxxProperties 寻找相关属性在配置文件设值即可。**

@ComponentScan注解
@ComponentScan使用
主要是从定义的扫描路径中，找出标识了需要装配的类自动装配到spring 的bean容器中。

常用属性如下:
basePackages、value:指定扫描路径，如果为空则以@ComponentScan注解的类所在的包为基本的扫描路径
basePackageClasses:指定具体扫描的类
includeFilters:指定满足Filter条件的类
excludeFilters:指定排除Filter条件的类
includeFilters和excludeFilters 的FilterType可选:ANNOTATION=注解类型默认、 ASSIGNABLE_TYPE(指定固定类)、ASPECTJ(ASPECTJ类型)、REGEX(正则表达式)、CUSTOM(自定义类 型)，自定义的Filter需要实现TypeFilter接口
@ComponentScan的配置如下:

@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

借助excludeFilters将TypeExcludeFillter及FilterType这两个类进行排除
当前@ComponentScan注解没有标注basePackages及value，所以扫描路径默认为@ComponentScan 注解的类所在的包为基本的扫描路径(也就是标注了@SpringBootApplication注解的项目启动类所在的路径)

抛出疑问:@EnableAutoConfiguration注解是通过@Import注解加载了自动配置固定的bean，@ComponentScan注解自动进行注解扫描，那么真正根据包扫描，把组件类生成实例对象存到IOC容器中，又是怎么来完成的?

---

总结