Springboot自动配置原理

Springboot自动配置原理

当Springboot启动的时候，会加载主配置类，也就是 @SpringBootApplication 注解，在这个注解中有这些注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

起到自动配置的就是这个@EnableAutoConfiguration 注解，点进去这个注解，可以看到在这个注解中有这些注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)

import了一个AutoConfigurationImportSelector 类，这个类的作用就是给容器自动导入一些组件，点进去这个类，在这个类中有一个getAutoConfigurationEntry（）方法 ，这个方法中使用了

List configurations = getCandidateConfigurations(annotationMetadata, attributes); 来获取候选的配置，其中getCandidateConfigurations方法中调用了

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

点进loadFactoryNames（）方法 ,这个方法调用了getResources（）去扫描jar包类路径下的META-INF/spring.factories 文件 ，这个文件中包含了springboot会自动装配的类的路径名，然后将这些文件的内容封装成Properties对象，通过类路径拿到这个类，一般这些类都是带有@Configuration注解来表示这个一个配置类。起的是传统spring中配置文件的作用。然后把他们添加到容器中

public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
Enumeration<URL> urls = (classLoader != null ?
					classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
					ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
//循环将扫描到的文件内容封装成Properties对象
result = new LinkedMultiValueMap<>();
			while (urls.hasMoreElements()) {
				URL url = urls.nextElement();
				UrlResource resource = new UrlResource(url);
				Properties properties = PropertiesLoaderUtils.loadProperties(resource);
				for (Map.Entry<?, ?> entry : properties.entrySet()) {
					String factoryTypeName = ((String) entry.getKey()).trim();
					for (String factoryImplementationName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
						result.add(factoryTypeName, factoryImplementationName.trim());
					}
				}
			}

spring.factories里文件的内容

# Application Context Initializers
org.springframework.context.ApplicationContextInitializer=
org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,
org.springframework.boot.context.ContextIdApplicationContextInitializer,
org.springframework.boot.context.config.DelegatingApplicationContextInitializer,
org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer

# Application Listeners
org.springframework.context.ApplicationListener=
org.springframework.boot.ClearCachesApplicationListener,
org.springframework.boot.builder.ParentContextCloserApplicationListener,
org.springframework.boot.context.FileEncodingApplicationListener,
org.springframework.boot.context.config.AnsiOutputApplicationListener,
org.springframework.boot.context.config.ConfigFileApplicationListener,
org.springframework.boot.context.config.DelegatingApplicationListener,
org.springframework.boot.context.logging.ClasspathLoggingApplicationListener,
org.springframework.boot.context.logging.LoggingApplicationListener,
org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener

用一个实例来说明

 //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@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;

    }
    @Bean   //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @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;

    }

其中，在@EnableConfigurationProperties注解中点进去可以发现他配置了一个@ConfigurationProperties(prefix = "spring.datasource")注解，也就是用于加载application.yml文件中的注解，用这个注解来加载我们在yml文件中所配置的一些东西，比如说数据源等等这些东西，来完成配置，一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

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

@ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpEncodingProperties {

   public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

总结：

1. 当Springboot启动的时候会加载大量的自动配置类
2. 通过AutoConfigurationImportSelector 类调用一系列方法去加载spring.factories这个文件中的类路径
3. 拿到路径进行封装成properties对象进行加载
4. 拿到的对象，通过@Configuration注解标注自己是一个配置类，然后通过@EnableConfigurationProperties注解去调用加载配置文件的类，去application.yml加载所需要的配置文件信息，完成注入