自动配置原理
Springboot启动类中
@SpringBootApplication 注解里面主要的三个注解为
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
其中 @EnableAutoConfiguration 注解开启自动配置功能;
@EnableAutoConfiguration 作用
@EnableAutoConfiguration 中的 @import 注解利用 EnableAutoConfigurationImportSelector给容器中导入组件,可以通过 selectImports() 方法查看导入的内容
然后EnableAutoConfigurationImportSelector 类 中的 getAutoConfigurationEntry() 方法的内部调用 getCandidateConfigurations 方法获取候选配置;
从上面封装的properties中获取到 EnableAutoConfiguration.class类(类名) 对应的值,然后把它们添加在容器中
(List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
就是将所有jar包下** META-INF/spring.factories** 中的这些加到了容器当中实现一个自动配置,
每一个这样的 XXXAutoConfiguration 类都是容器中的一个组件,都加入到容器中,用它们来做自动配置,然后这些自动配置类会根据各自的properties文件去进行自动配置功能。
——————————————————————————————
自动配置示例
以 **HttpEncodingAutoConfiguration(Http编码自动配置)**为例解释自动配置原理
@Configuration //表示这是一个配置类
@EnableConfigurationProperties({HttpProperties.class}) //启动指定类的ConfigurationProperties功能
//将配置文件中对应的值和HttpProperties绑定起来,
//并把 HttpProperties 加入到IOC容器中
@ConditionalOnWebApplication(type = Type.SERVLET) //判断当前应用是不是web应用,如果是,当前配置类才生效
@ConditionalOnClass({CharacterEncodingFilter.class}) //判断当前项目有没有 CharacterEncodingFilter 这个类(用来解决乱码的过滤器)
@ConditionalOnProperty( //判断是否存在 spring.http.encoding 配置;如果不存在,也是生效的(matchIfMissing )
prefix = "spring.http.encoding",
value = {"enabled"},
matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
private final Encoding properties;
//只有一个有参构造器的情况下,参数的值就会从容器中拿。即上面的 HttpProperties.class
public HttpEncodingAutoConfiguration(HttpProperties properties) {
this.properties = properties.getEncoding();
}
@Bean //给容器中添加一个组件 这个组件的某些值(this.properties.getCharset().name()) 需要从properties中获取
@ConditionalOnMissingBean
public CharacterEncodingFilter characterEncodingFilter() {
CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
filter.setEncoding(this.properties.getCharset().name());
filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
return filter;
}
根据当前的不同的条件判断,决定这个配置类是否生效;
一旦这个配置生效,这些配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties中去获取的,这些类里面的每一个属性又是和配置文件绑定的。
所有在配置文件中能配置的属性都是在 xxxProperties类中封装着;
所以配置文件能配置什么,就可以参照某个功能对应的这个属性类。
@ConfigurationProperties(prefix = "spring.http") //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpProperties {
private boolean logRequestDetails;
private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();
总结
-
SpringBoot启动会加载大量的自动配置类;
-
看我们需要的功能有没有SpringBoot提供的默认写好的自动配置类;**
-
然后再看这个默认写好的自动配置类中到底配置了哪些组件;**(只要我们要用的有,就不用配置,或者在配置文件重新配置即可)
-
给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中去指定这些属性的值。**