yml配置文件中能写什么配置呢?
我们知道SpringBoot自动配置是通过将spring.factories中的xxxAutoConfiguration导入容器,从而使自动配置类生效 ,进行自动配置工作的
那么我们就以spring.factories中的HttpEncodingAutoConfiguration(Http编码自动配置)为例分析自动配置原理
//这个自动配置类是用于在web应用程序中配置编码的
//表示这是一个配置类,和以前编写的配置文件一样,也可以给容器中添加组件,如注入该类中的两个bean
@Configuration(proxyBeanMethods = false)
//用来启动该类的配置Properties
//将我们写的yml配置文件中和ServerProperties对应的值绑定
//并把ServerProperties添加到容器中
@EnableConfigurationProperties(ServerProperties.class)
//判断当前应用是否是web应用,如果是,当前配置类生效
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
//判断当前项目有没有这个类CharacterEncodingFilter,这是SpringMVC中进行乱码解决的过滤器
@ConditionalOnClass(CharacterEncodingFilter.class)
//判断配置文件中是否存在某个配置:server.servlet.encoding.enabled
//即使我们配置文件中没有配置pring.http.encoding.enabled=true,也是默认生效的
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
//将获取到的Encoding私有化
private final Encoding properties;
//这个构造器从ServerProperties子类获取Encoding对象
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(Encoding.Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
return filter;
}
@Bean
public LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {
return new LocaleCharsetMappingsCustomizer(this.properties);
}
static class LocaleCharsetMappingsCustomizer
implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>, Ordered {
private final Encoding properties;
LocaleCharsetMappingsCustomizer(Encoding properties) {
this.properties = properties;
}
@Override
public void customize(ConfigurableServletWebServerFactory factory) {
if (this.properties.getMapping() != null) {
factory.setLocaleCharsetMappings(this.properties.getMapping());
}
}
@Override
public int getOrder() {
return 0;
}
}
}
这个配置类是否生效会根据当前不同的条件判断,一旦生效,这个配置类就会给容器中添加各种组件,这些组件的属性是从对应的properties类中获取的,这些类里面的每一个属性又是和我们写的yml配置文件绑定,所有在配置文件中能配置的属性都是在xxxxProperties类中封装着,所以配置文件能配置什么就可以参照某个功能对应的Properties类
1、SpringBoot启动会加载大量的自动配置类
2、我们看我们需要的功能有没有在SpringBoot默认写好的自动配置类当中
3、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件存在在其中,我们就不需要再手动配置了)
4、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们只需要在配置文件中指定这些属性的值即可
xxxxAutoConfigurartion:自动配置类;给容器中添加组件
xxxxProperties:封装配置文件中相关属性;
@Conditional派生注解
必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效,所以尽管加载了这么多的配置类,但不是所有的都生效了
我们可以通过启用 debug=true属性;来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置类生效
Positive matches:(自动配置类启用的:正匹配)
Negative matches:(没有启动,没有匹配成功的自动配置类:负匹配)
Unconditional classes: (没有条件的类)