Spring Boot 配置体系详解

杨同学technotes

发布于 2022-12-01 15:55:09

4750

发布于 2022-12-01 15:55:09

文章被收录于专栏：杨同学technotes杨同学technotes

本文为博主自学笔记整理，内容来源于互联网，如有侵权，请联系删除。个人笔记：https://www.dbses.cn/technotes

一、核心设计理念

在 Spring Boot 中，对配置信息的管理采用的是约定优于配置的核心设计理念。具体体现在配置文件命名以及代码控制的约定。

1.1 配置文件与 Profile

为了达到集中化管理的目的，Spring Boot 对配置文件的命名也做了一定的约定，分别使用 label 和 profile 概念来指定配置信息的版本以及运行环境，其中 label 表示配置版本控制信息，而 profile 则用来指定该配置文件所对应的环境。

/{application}.yml
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties

1.2 代码控制与Profile

先来看一个简单的示例。

@Configuration
public class DataSourceConfig {
 
    @Bean
    @Profile("dev")
    public DataSource devDataSource() {
        //创建 dev 环境下的 DataSource 
    }
 
    @Bean()
    @Profile("prod")
    public DataSource prodDataSource(){
        //创建 prod 环境下的 DataSource 
    }
}

这里使用 @Profile 注解来指定具体所需要执行的 DataSource 创建代码，通过这种方式，可以达到与使用配置文件相同的效果。

在日常开发过程中，一个常见的需求是根据不同的运行环境初始化数据。基于 @Profile 注解，我们就可以将这一过程包含在代码中并做到自动化，如下所示：

@Profile("dev")
@Configuration
public class DevDataInitConfig {
 
  @Bean
  public CommandLineRunner dataInit() { 
    return new CommandLineRunner() {
      @Override
      public void run(String... args) throws Exception {
        //执行 Dev 环境的数据初始化
    };  
}

这里用到了 Spring Boot 所提供了启动时任务接口 CommandLineRunner，实现了该接口的代码会在 Spring Boot 应用程序启动时自动进行执行。

二、自定义配置信息

2.1 在配置文件中嵌入系统配置信息

通过 ${} 占位符可以引用配置文件中的其他配置项内容，如下列配置：

system.name=springcss
system.domain=health
system.description=The system ${name} is used for ${domain}.

最终“system.description”配置项的值就是“The system springcss is used for health”。

再来看一种场景，假设我们使用 Maven 来构建应用程序，那么可以按如下所示的配置项来动态获取与系统构建过程相关的信息：

info: 
  app:
    encoding: @project.build.sourceEncoding@
    java:
      source: @java.version@
      target: @java.version@

上述配置项的效果与如下所示的静态配置是一样的：

info:
  app:
    encoding: UTF-8
    java:
        source: 1.8.0_31
        target: 1.8.0_31

2.2 自定义配置信息

例如，对于现在的配置：

springcss.order.point=10

想要获取这个配置项的内容，通常有两种方法。

1. 使用 @Value 注解

我们可以构建一个 SpringCssConfig 类，如下所示：

@Component
public class SpringCssConfig {
 
    @Value("${springcss.order.point}")
    private int point;
}

1. 使用 @ConfigurationProperties 注解

在使用该注解时，我们通常会设置一个“prefix”属性用来指定配置项的前缀，如下所示：

@Component
@ConfigurationProperties(prefix = "springcss.order")
public class SpringCsshConfig {
 
    private int point;

    //省略 getter/setter
}

考虑一种更常见也更复杂的场景：假设用户根据下单操作获取的积分并不是固定的，而是根据每个不同类型的订单有不同的积分，那么现在的配置项的内容，如果使用 Yaml 格式的话就应该是这样：

springcss:
  points:
    orderType[1]: 10
    orderType[2]: 20
    orderType[3]: 30

把这些配置项全部加载到业务代码中：

@Component
@ConfigurationProperties(prefix = "springcss.points")
public class SpringCssConfig {
 
    private List<Integer> orderType = new ArrayList<>();

    //省略 getter/setter
}

当我们输入某一个配置项的前缀时，诸如 IDEA、Eclipse 这样的 IDE 就会自动弹出该前缀下的所有配置信息供你进行选择，效果如下：

如何实现这种效果呢？

我们需要生成配置元数据。通过 IDE 的“Create metadata for 'springcss.order.point'”按钮，就可以选择创建配置元数据文件。

这个文件的名称为 additional-spring-configuration-metadata.json，文件内容如下所示：

{
  "properties": [
    {
      "name": "springcss.order.point",
      "type": "java.lang.String",
      "description": "A description for 'springcss.order.point'"
      "defaultValue": 10
    }
  ]
}

效果如下所示：

2.3 整合配置信息

在使用 @ConfigurationProperties 注解时，我们可以和 @PropertySource 注解一起进行使用，从而指定从哪个具体的配置文件中获取配置信息。

@Component
@ConfigurationProperties(prefix = "springcss.order")
@PropertySources({
        @PropertySource("classpath:application.properties "),
        @PropertySource("classpath:redis.properties"),
        @PropertySource("classpath:mq.properties")
})
public class SpringCssConfig {
}

我们也可以通过配置 spring.config.location 来改变配置文件的默认加载位置，从而实现对多个配置文件的同时加载。

java -jar customerservice-0.0.1-SNAPSHOT.jar --spring.config.location=file:///D:/application.properties, classpath:/config/

通过 spring.config.location 指定多个配置文件路径也是组织和整合配置信息的一种有效的实现方式。

通过前面的示例，我们看到可以把配置文件保存在多个路径，而这些路径在加载配置文件时具有一定的顺序。Spring Boot 在启动时会扫描以下位置的 application.properties 或者 application.yml 文件作为全局配置文件：

2.4 如何覆写内置的配置类？

Spring Boot 内置了大量的自动配置，如果我们不想使用这些配置，就需要对它们进行覆写。

例如在 Spring Security 体系中，设置用户认证信息所依赖的配置类是 WebSecurityConfigurer 类。这是一个设置 Web 安全的配置类。Spring Security 提供了 WebSecurityConfigurerAdapter 这个适配器类来简化该配置类的使用方式，我们可以继承 WebSecurityConfigurerAdapter 类并且覆写其中的 configure() 的方法来完成自定义的用户认证配置工作。

@Configuration
public class SpringHCssWebSecurityConfigurer extends WebSecurityConfigurerAdapter {
 
    @Override
    @Bean
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }
 
    @Override
    @Bean
    public UserDetailsService userDetailsServiceBean() throws Exception {
        return super.userDetailsServiceBean();
    }
 
    @Override
    protected void configure(AuthenticationManagerBuilder builder) throws Exception {
        builder.inMemoryAuthentication()
          .withUser("springcss_user")
          .password("{noop}password1")
          .roles("USER")
          .and()
          .withUser("springcss_admin")
          .password("{noop}password2")
          .roles("USER", "ADMIN");
    }
}

开发人员可以通过构建诸如上述所示的 SpringCssWebSecurityConfigurer 类来对这些内置配置类进行覆写，从而实现自定义的配置信息。

三、Spring Boot 自动配置的实现原理

我们先从 @SpringBootApplication 注解开始。

3.1 @SpringBootApplication 注解

@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) })
public @interface SpringBootApplication {
    @AliasFor(annotation = EnableAutoConfiguration.class)
    Class<?>[] exclude() default {};
 
    @AliasFor(annotation = EnableAutoConfiguration.class)
    String[] excludeName() default {};
 
    @AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
    String[] scanBasePackages() default {};
 
    @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
    Class<?>[] scanBasePackageClasses() default {};
}

我们可以通过 exclude 和 excludeName 属性来配置不需要实现自动装配的类或类名，也可以通过 scanBasePackages 和 scanBasePackageClasses 属性来配置需要进行扫描的包路径和类路径。

@SpringBootApplication 注解实际上是一个组合注解，它由三个注解组合而成，分别是 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan。

1. @ComponentScan 注解：扫描基于 @Component 等注解所标注的类所在包下的所有需要注入的类，并把相关 Bean 定义批量加载到容器中。
2. @SpringBootConfiguration 注解：它是一个空注解，只是使用了 Spring 中的 @Configuration 注解。
3. @EnableAutoConfiguration 注解：该注解的定义如下代码所示。

@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 {};
}

这里我们关注两个新注解，@AutoConfigurationPackage 和 @Import(AutoConfigurationImportSelector.class)。

@AutoConfigurationPackage 对该注解所在包下的类进行自动配置。AutoConfigurationImportSelector 类会执行 selectImports 方法，核心是获取 configurations 集合并进行过滤。

AutoConfigurationImportSelector 类是一种选择器，负责从各种配置项中找到需要导入的具体配置类。该类的结构如下图所示：

3.2 SPI 机制

ServiceLoader

JDK 提供了用于服务查找的一个工具类 java.util.ServiceLoader 来实现 SPI 机制。可以在 jar 包的 META-INF/services/ 目录下创建一个以服务接口命名的文件。JDK 中 SPI 机制开发流程如下图所示：

SpringFactoriesLoader

SpringFactoriesLoader 类似这种 SPI 机制，只不过以服务接口命名的文件是放在 META-INF/spring.factories 文件夹下。

spring.factories 配置文件片段如下：

# Auto Configure
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.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
…

以上就是 Spring Boot 中基于 @SpringBootApplication 注解实现自动配置的基本过程和原理。

@ConditionalOn 系列条件注解

Spring Boot 中提供了一系列的条件注解，常见的包括：

• @ConditionalOnProperty：只有当所提供的属性属于 true 时才会实例化 Bean
• @ConditionalOnBean：只有在当前上下文中存在某个对象时才会实例化 Bean
• @ConditionalOnClass：只有当某个 Class 位于类路径上时才会实例化 Bean
• @ConditionalOnExpression：只有当表达式为 true 的时候才会实例化 Bean
• @ConditionalOnMissingBean：只有在当前上下文中不存在某个对象时才会实例化 Bean
• @ConditionalOnMissingClass：只有当某个 Class 在类路径上不存在的时候才会实例化 Bean
• @ConditionalOnNotWebApplication：只有当不是 Web 应用时才会实例化 Bean

这些注解的实现原理大致相同，我们挑选 @ConditionalOnClass 注解进行展开，该注解定义如下：

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnClass {
  Class<?>[] value() default {};
  String[] name() default {};
}

OnClassCondition 是 SpringBootCondition 的子类，SpringBootCondition 中的 matches 方法实现如下：：

@Override
public final boolean matches(ConditionContext context,
            AnnotatedTypeMetadata metadata) {
    String classOrMethodName = getClassOrMethodName(metadata);
    try {
        ConditionOutcome outcome = getMatchOutcome(context, metadata);
        logOutcome(classOrMethodName, outcome);
        recordEvaluation(context, classOrMethodName, outcome);
        return outcome.isMatch();
    }
    //省略其他方法
}

本文参与腾讯云自媒体分享计划，分享自微信公众号。

原始发表：2022-10-22，如有侵权请联系 cloudcommunity@tencent.com 删除

spring

spring boot

本文分享自杨同学technotes 微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体分享计划，欢迎热爱写作的你一起参与！

spring

spring boot

登录后参与评论

0 条评论

热度