5. SprigBoot自动配置原理

最新推荐文章于 2025-08-20 17:55:57 发布

weixin_34192993

最新推荐文章于 2025-08-20 17:55:57 发布

阅读量63

点赞数

CC 4.0 BY-SA版权

文章标签： java

原文链接：http://www.cnblogs.com/guchunchao/p/9887511.html

本文深入解析SpringBoot自动配置的工作机制，包括自动配置类如何在启动时被加载，以及它们如何根据条件决定是否生效。通过具体示例HttpEncodingAutoConfiguration，展示了自动配置类如何根据配置文件设置动态调整组件行为。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

配置文件到底能写什么?怎么写?

　　都可以在SpringBoot的官方文档中找到：

配置文件能配置的属性参照

1、自动配置原理:

　　1)、SpringBoot启动的时候加载主配置类，开启了自动配置功能

　　2)、 @EnableAutoConfiguration 作用:

　　　　　1）利用EnableAutoConfigurationImportSelector给容器中导入一些组件?

　　　　　2）可以查看selectImports()方法的内容;

　　　　　3）List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置：

SpringFactoriesLoader.loadFactoryNames()
扫描所有jar包类路径下 META‐INF/spring.factories
把扫描到的这些文件的内容包装成properties对象
从properties中获取到EnableAutoConfiguration.class类(类名)对应的值，然后把他们添加在容器中

　　　　　　将类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConﬁguration的值加入到了容器中；

 1 # Auto Configure
 2 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 3 org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
 4 org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
 5 org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
 6 org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
 7 org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
 8 org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
 9 org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
10 org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
......

　　　　　　每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；

　　　　3）、每一个自动配置类进行自动配置功能；

　　　　4）、以**HttpEncodingAutoConfiguration（Http编码自动配置）**为例解释自动配置原理；　　

//表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@Configuration
//启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中
@EnableConfigurationProperties(HttpEncodingProperties.class)
//Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效； 
//判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication
//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnClass(CharacterEncodingFilter.class)
//判断配置文件中是否存在某个配置  spring.http.encoding.enabled；如果不存在，判断也是成立的
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
//即使我们配置文件中不配置pring.http.encoding.enabled=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;
    }
}

SpringBoot2版本用的是HttpProperties

@Configuration
@EnableConfigurationProperties({HttpProperties.class})
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
    private final Encoding properties;

    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }

    @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.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }

根据当前不同的条件判断，决定这个配置类是否生效？一但这个配置类生效；这个配置类就会给容器中添加各种组件；

　　　　　　这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

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

@ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpEncodingProperties {
   public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");　　
　　本类中的属性对应于spring.http.encoding.XXX 注解项