SpringBoot自动配置原理深入浅析SpringBoot自动配置原理

时间:2021-10-13 胡榕昆人气:0

想了解深入浅析SpringBoot自动配置原理的相关内容吗，胡榕昆在本文为您仔细讲解SpringBoot自动配置原理的相关知识和一些Code实例，欢迎阅读和指正，我们先划重点：SpringBoot自动配置原理,SpringBoot自动配置，下面大家一起来学习吧。

SpringBoot2.3.1版本源码

一、SpringBoot启动的时候加载主配置类，通过@EnableAutoConﬁguration注解开启了自动配置功能。

二、@EnableAutoConﬁguration作用：

1、点击该注解进入可以发现，它利用AutoConfigurationImportSelector.class 选择器给SpringBoot导入一些组件。导入哪些组件呢？可以点击选择器进入查看selectImports()方法的内容，该方法最终会返回一个configurations。

2、selectImports方法调用了getAutoConfigurationEntry()方法获取自动配置实体，在getAutoConfigurationEntry()方法中有一条代码

List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);

用于获取候选的配置

其中getCandidateConfigurations()方法有一条代码

List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());

从类路径下得到一个资源，loadFactoryNames()方法中→loadSpringFactories()方法→classLoader.getResources("META-INF/spring.factories")，扫描所有jar包类路径下的META-INF/spring.factories的文件

loadSpringFactories()方法通过如下代码：

Enumeration<URL>urls=classLoader!=null?classLoader.getResources("META-INF/spring.factories")

得到META-INF/spring.factories文件的URL，然后把每一个URL遍历，最终通过Propertiesproperties=PropertiesLoaderUtils.loadProperties(resource);把这些文件封装成一个properties对象，然后从properties对象中获取一些值，把每一个url获取到的值添加到最终要返回的结果中。而这些返回结果就是我们要交给容器中的所有组件。其中factoryTypeName指的就是传过来的Class的类名，而传过来的class是从AutoConfigurationImportSelector类的getCandidateConfigurations()方法的this.getSpringFactoriesLoaderFactoryClass()中得到的，其返回值是EnableAutoConfiguration.class意思就是从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器中。

在spring-boot-autoconfigure-2.3.1.RELEASE.jar!\META-INF\spring.factories文件中，我们可以找到EnableAutoConfiguration的值

所以相当于把EnableAutoConfiguration值里面的这些组件加到了容器中。

简而言之就是：将类路径下\META-INF\spring.factories里面配置的所有EnableAutoConfiguration的值加入到了容器中。所以最终容器中会添加很多的类，这些就是自动配置之源，自动配置的开始。每一个xxxAutoConfiguration类(自动配置类)都是容器中的一个组件，都加入到容器中，用他们来做自动配置。

三、每一个自动配置类进行自动配置功能

以HttpEncodingAutoConﬁguration（Http编码自动配置）自动配置类为例解释自动配置原理

@Configuration(  //这是一个配置类，就类似配置文件一样，也可以给容器中添加组件
    proxyBeanMethods = false
)
@EnableConfigurationProperties({ServerProperties.class})
//启用指定类(ServerProperties.class)的EnableConfigurationProperties功能；
将配置文件中对应的值和ServerProperties类绑定起来，并把ServerProperties加入到IOC容器中。
@ConditionalOnWebApplication( 
//底层使用的是Spring底层的Conditional注解，根据不同的条件，如果满足指定的条件，
整个配置类里面的配置才会生效。ConditionalOnWebApplication:判断当前应用是否是web应用，如果是，当前配置类生效。
    type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
//判断当前项目有没有CharacterEncodingFilter这个类，(SpringMVC中进行乱码解决的过滤器)，如果有，当前配置类生效。
@ConditionalOnProperty(
//判断配置文件中是否存在某个配置，server.servlet.encoding.enabled,
matchIfMissing = true表示，如果不存在判断也是成立的。(即使配置文件中不配置server.servlet.encoding.enabled，也是默认生效的)
    prefix = "server.servlet.encoding",
    value = {"enabled"},
    matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
	
	private final Encoding properties;//properties属性已经和SpringBoot的配置文件映射了。
	public HttpEncodingAutoConfiguration(ServerProperties properties) {
	//只有一个有参构造器的情况下，参数的值就会从容器中拿
	        this.properties = properties.getServlet().getEncoding();
	    }
	
    @Bean//给容器中添加一个组件，这个组件的某些值需要从properties中获取。
    @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));
              //需要使用什么编码就从Encoding类的properties属性中获取
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));
        return filter;
    }

简而言之：xxxAutoConfiguration自动配置类就是根据当前不同条件判断，决定这个配置类是否生效。

那如果这些判断都成功了，配置类生效了，接下来怎么办呢？

一旦这个配置类生效，接下来这个配置类会通过@Bean注解给容器中添加各种组件，这些组件的属性是从对应的xxxProperties类中获取的，而这个类里面的每一个属性又是和配置文件绑定的

ServerProperties.class类

  	@ConfigurationProperties(//从配置文件中获取指定的值，和ServerProperties类的属性进行绑定
	    prefix = "server",
	    ignoreUnknownFields = true
 	)
     	public class ServerProperties {

所以说，我们在配置文件中应该配置什么，就按照她的旨意，根据 prefix = "server"我们可以知道，在配置文件中可以配server这个属性。而server属性里面能配置什么值，就看ServerProperties.class类中有哪些属性。

ServerProperties中有的这些属性，都可以在配置文件中配置。

例如：server.port server.address

四、由此我们可以知道，所有能在配置文件中配置的属性都是在xxxProperties类中封装着，

配置文件能配置就可以参照某一个功能对应的这个xxxProperties类。

精髓：

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

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

3)、我们再来看这些自动配置类到底配置了哪些组件；(只要我们要用的组件有，我们就不需要再来配置了)如果没有，我们就需要自己写配置类。

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

自动配置中最重要的两种类：

xxxAutoConfiguration：自动配置类给容器中添加组件

xxxProperties：封装配置文件中相关的属性

加载全部内容

SpringBoot自动配置原理 深入浅析SpringBoot自动配置原理

SpringBoot自动配置原理深入浅析SpringBoot自动配置原理