以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(ServerProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
1. @Configuration
@Configuration
作用:表示这是一个配置类,和以前编写的配置文件一样,也可以给容器中添加组件
2. @EnableConfigurationProperties()
@EnableConfigurationProperties(ServerProperties.class)
作用:启动指定类的ConfigurationProperties功能
进入这个ServerProperties查看,这个配置文件有一些默认值,同时也将配置文件(例如:application.yaml)中对应的值和ServerProperties绑定起来,并把ServerProperties加入到ioc容器中。
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {
..........
}
3. @ConditionalOnWebApplication()
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
作用:Spring底层@Conditional注解,根据不同的条件判断,如果满足指定的条件,整个配置类里面的配置就会生效
这里的意思就是判断当前应用是否是web应用,如果是,当前配置类生效
4. @ConditionalOnClass()
@ConditionalOnClass(CharacterEncodingFilter.class)
作用:判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器
5. @ConditionalOnProperty()
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
作用:判断配置文件中是否存在某个配置:server.servlet.encoding.enabled;
如果不存在,判断也是成立的
即使我们配置文件中不配置server.servlet.encoding.enabled=true,也是默认生效的。
public class HttpEncodingAutoConfiguration {
//他已经和SpringBoot的配置文件映射了
private final Encoding properties;
//只有一个有参构造器的情况下,参数的值就会从容器中拿
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;
}
..........
}
6. 一句话总结 : 根据当前不同的条件判断,决定这个配置类是否生效!
- 但这个配置类生效;这个配置类就会给容器中添加各种组件
- 这些组件的属性是从对应的properties中获取的,这些类里面的每一个属性又是和配置文件绑定的
- 所有在配置文件中能配置的属性都是在xxxxProperties类中封装着
- 配置文件能配置什么就可以参照某个功能对应的这个属性类
精髓:
- 1、SpringBoot启动会加载大量的自动配置类
- 2、我们看我们需要的功能有没有在SpringBoot默认写好的自动配置类当中
- 3、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件存在在其中,我们就不需要再手动配置了)
- 4、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们只需要在配置文件中指定这些属性的值即可
xxxxAutoConfigurartion:自动配置类 (给容器中添加组件 )
xxxxProperties:封装配置文件中相关属性
@Conditional派生注解(Spring注解版原生的@Conditional作用)
作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效