02.spring-boot自动配置原理

自动配置原理

1--首先找到spring-boot的启动主类"@SpringBootApplication"

@SpringBootApplication
public class FirstSpringbootApplication {

    public static void main(String[] args) {
        SpringApplication.run(FirstSpringbootApplication.class, args);
    }

}

2--点进去,找到自动配置的注解“@EnableAutoConfiguration”

@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}
)}
)

3--@Import({AutoConfigurationImportSelector.class}),这个注解自动注入了ImportSelector这个类。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};

    String[] excludeName() default {};
}

4--点进去，在selectImports()方法中，会将所有的自动配置信息加载出来。

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

5--加载要配置类的名字。

SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader()); 

6--这些类的名字从"META-INF/spring.factories"这里面获取

classLoader.getResources("META-INF/spring.factories")

7--把EnableAutoConfiguration类的类名加载到容器中，用来做自动配置。

this.getSpringFactoriesLoaderFactoryClass()
protected Class<?> getSpringFactoriesLoaderFactoryClass() {
    return EnableAutoConfiguration.class;
}

8--我们找到“META-INF/spring.factories”下的EnableAutoConfiguration的类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
...

HttpEncodingAutoConfiguration(例子)

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

注解

@Configuration //是一个配置类，就像配置文件一样，给容器中添加主件
@EnableConfigurationProperties({HttpEncodingProperties.class})//启用ConfigurationProperties功能
@ConditionalOnWebApplication(
    type = Type.SERVLET
)//根据不同的条件来判断，满足指定的条件配置才会生效，判断是不是web应用
@ConditionalOnClass({CharacterEncodingFilter.class}) //判断当前项目里有没有这个类
CharacterEncodingFilter.class 解决乱码的拦截器
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)//是否存在某些配置
spring.http.encoding.enabled
即使不配置spring.http.encoding.enabled=true也生效
@ConfigurationProperties(
    prefix = "spring.http.encoding"
)//从配置文件中获取指定的值
public class HttpEncodingProperties {

属性配置什么，看类里面有什么；根据当前不同的条件配置，决定这个配置类是否生效

//某些值需要从properties中获取
private final HttpEncodingProperties properties;
//从之前的注解中去拿
public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
    this.properties = properties;
}
@Bean
@ConditionalOnMissingBean
public CharacterEncodingFilter characterEncodingFilter() {
    CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
    filter.setEncoding(this.properties.getCharset().name());
    filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpEncodingProperties.Type.REQUEST));
    filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpEncodingProperties.Type.RESPONSE));
    return filter;
}

总结

1. spring boot 启动时会加载大量的自动配置的类。
2. 当我们需要写什么功能的时候，首先去找这个功能spring boot有没有自动加载。
3. 如果有，且我们对一些自动配置的参数不满意，我们需要在配置文件中去写，怎么写参考自动配置类绑定的类。boot会从这些properties中获取这些属性的值。
4. 如果没有，则需要我们自己去写配置类。
5. debug=true:看自动配置的类有哪些。