SpringBoot自动配置原理

SpringBoot 官方文档中有大量的配置，我们无法全部记住

1、寻找配置目录

1、进入启动类的@SpringBootApplication

2、进入该注解下的@EnableAutoConfiguration

3、进入@Import({AutoConfigurationImportSelector.class}) 里导入的 AutoConfigurationImportSelector类

4、找到该类的 getAutoConfigurationEntry方法，进入getCandidateConfigurations方法

5、进入SpringFactoriesLoader类中

6、使用给定的类加载器，从FACTORIES_RESOURCE_LOCATION加载并实例化给定类型的工厂实现。

• 框架内部使用的通用工厂加载机制
• 从 classpath 下多个 jar 包特定的位置读取文件并初始化类
• 文件内容必须是 kv 形式，即 properties 类型
• key 是全限定名【抽象类接口】、value是实现，多个实现用逗号【,】分割

7、找到配置目录spring.factories

2、回顾配置属性

在 yaml 语法学习中，通常需要我们在 property 中配置信息时，通常使用@ConfigurationProperties(pefix=“前缀”) 注解的方式从配置文件中获取配置，如下：

1、编写实体类Person

/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉 SpringBoot 将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Component //注册bean
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

2、在 application.yaml 中配置信息

person:
  name: cyo_${random.uuid}
  age: 3
  happy: false
  birth: 2021/1/24
  map: {k1: v1,k2: v2}
# hello: lian

  list:
    - code
    - girl
    - music
  dog:
    name: ${person.hello:other}_漫龙
    age: 3

3、编写测试类

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    Person person; //将person自动注入进来

    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }

}

4、成功注入

Person{
	name='cyo_063dd484-575e-4c00-a4ad-eb6297a66a66', 
	age=3, 
	happy=false, 
	birth=Sun Jan 24 00:00:00 CST 2021, 
	map={k1=v1, k2=v2}, 
	list=[code, girl, music], 
	dog=Dog{name='other_漫龙', age=3}}

3、自动配置原理流程

在pom.xml 中导入对应的 start 使自动配置生效

mybatis-spring-boot-starter、spring-boot-starter-web 等组件的 META-INF 文件下均含有spring.factories文件；

自动配置模块中，SpringFactoriesLoader 收集到文件中的类全名并返回一个类全名的数组，返回的类全名通过反射被实例化，就形成了具体的工厂实例，工厂实例来生成组件具体需要的bean。

样例分析

以**HttpEncodingAutoConfiguration** （Http编码自动配置） 为例解释自动配置原理；

//表示这是一个配置类，和以前编写的配置文件一样，也可以给容器中添加组件；
@Configuration(
    proxyBeanMethods = false
) 

//启动指定类的ConfigurationProperties功能；
  //进入这个ServerProperties查看，将配置文件中对应的值和ServerProperties绑定起来；
  //并把ServerProperties加入到ioc容器中
@EnableConfigurationProperties({ServerProperties.class}) 

//Spring底层@Conditional注解
  //根据不同的条件判断，如果满足指定的条件，整个配置类里面的配置就会生效；
  //这里的意思就是判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(
    type = Type.SERVLET
)

//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnClass({CharacterEncodingFilter.class})

//判断配置文件中是否存在某个配置：spring.http.encoding.enabled；
  //如果不存在，判断也是成立的
  //即使我们配置文件中不配置spring.http.encoding.enabled=true，也是默认生效的；
@ConditionalOnProperty(
    prefix = "server.servlet.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

public class HttpEncodingAutoConfiguration {
    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(ServerProperties properties) {
        this.properties = properties.getServlet().getEncoding();
    }
    
    //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @Bean
    @ConditionalOnMissingBean //判断容器没有这个组件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));
        return filter;
    }
    //。。。。。。。
}

一句话总结 ：根据当前不同的条件判断，决定这个配置类是否生效！

• 一但这个配置类生效；这个配置类就会给容器中添加各种组件；
• 这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
• 所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；
• 配置文件能配置什么就可以参照某个功能对应的这个属性类

//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "servlet.server") 
public class ServerProperties{
    // .....
}

我们去配置文件里面试试前缀，看提示！

这就是自动装配的原理！

精髓

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

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

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

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

**xxxxAutoConfigurartion：自动配置类；**给容器中添加组件

xxxxProperties：封装配置文件中相关属性；

了解 @Conditional

了解完自动装配的原理后，我们来关注一个细节问题，自动配置类必须在一定的条件下才能生效；

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

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

那么多的自动配置类，必须在一定的条件下才能生效；也就是说，我们加载了这么多的配置类，但不是所有的都生效了。

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

我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

#开启springboot的调试类
debug: true

Positive matches:（自动配置类启用的：正匹配）

Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）

Unconditional classes: （没有条件的类）

【演示：查看输出的日志】

参考资料

本文主要作为观看遇见狂神说视频做的笔记，以便回顾
视频地址：
[1] https://www.bilibili.com/video/BV1PE411i7CV?spm_id_from=333.999.0.0
[2] spring boot(二)：启动原理解析：https://www.cnblogs.com/xiaoxi/p/7999885.html