SpringBoot--自定义配置-CFANZ编程社区

外化属性

属性源

为了使应用能适应不同的环境，SpringBoot支持外化配置。可以使用.properties文件、YAML文件、环境变量、命令行参数等方式。

SpringBoot能从多种属性源获得属性，包括以下几处：
1. 命令行参数
2. JVM系统属性
3. 操作系统环境变量
4. 随机生成的带random.*前缀的属性（在设置其他属性时，可以引用它们，比如${random.long})
5. 应用程序以外的application.properties或者application.yml文件
6. 打包在应用程序内的application.properites或者application.yml文件
7. 通过@propertySource标注的属性源
8. 默认属性

优先级由高到低，即在上面的列表中“命令行参数”的优先级最高，会覆盖下面其他属性源的相同配置。

这里只挑选了部分比较常见的属性源，详细信息可以参考官网教程：<u>24. Externalized Configuration</u>

默认情况下SpringApplication将任何可选的命令行参数（以'--'开头，比如，--server.port=9000）转化为property，并将其添加到Spring Environment中。如上所述，命令行属性总是优先于其他属性源。

如果不想用这个特性可以用SpringApplication.setAddCommandLineProperties(false)来禁用。

YAML

SpringBoot支持YAML格式的配置文件文件后缀为yml，是一种更易读写的通用的数据串行化格式。
在SpringBoot中.yml效果相当于.properties，通常情况下二者是可以互相替换的，比如下面2种配置文件在SpringBoot中是等效的：

application.properties

server.port=8020
server.address=127.0.0.1

application.yml

server:
  port: 8020
  address: 127.0.0.1

.yml文件在配置数据的时候具有面向对象的特性，更易阅读。
虽然.yml配置和.properties基本等效，但也有略微区别，.yml配置不能用@propertySource注解加载。

Application属性文件

SpringBoot会从以下位置加载.properties或.yml配置文件：
1. 当前目录下的/config目录
2. 当前目录
3. classpath下的/config目录
4. classpath的根目录
5. 优先级也是从高到低，高优先级的配置文件会覆盖低优先级的配置。

使用.properties或.yml配置文件可以对SpringBoot的自动配置进行覆盖，比如在默认的情况下http端口为8080，我们可以像上面的例子那样在修改为8020。

SpringBoot提供了上百个这样可以覆盖的配置，具体可以查阅官网或者查看autoconfiguration包的的META-INF/spring-configuration-metadata.json和META-INF/additional-spring-configuration-metadata.json文件（这2个文件用来给IDE做输入提示用，有一些简单的描述）。

类型安全的配置属性

有时候使用@Value("#{property}")注解注入配置会比较笨重，SpringBoot提供一个类型安全的方案，用强类型的Bean对象来替代属性。

@ConfigurationProperties用法如下

@ConfigurationProperties(prefix = "acme")
public class AcmeProperties {
    private boolean enabled;
    private final Security security = new Security();
    // 省略getter、setter

    public static class Security {
        private String username;
        private String password;
        private List<String> roles = new ArrayList<>(Collections.singleton("USER"));
        // 省略getter、setter
    }
}

@ConfigurationProperties的参数prefix表示前缀，AcmeProperties里的每个属性的名称便是具体的配置名。比如成员变量enabled绑定属性acme.enabled。
上面这个例子表示AcmeProperties对象分别绑定下列属性：

acme.ebalbe：布尔类型
acme.security.username：String类型
acme.security.pasword：String类型
acme.security.roles：类型是一个String集合
绑定配置之后还需要注册Spring上下文中，有3种方式：
1. 在java配置类中用@EnableConfigurationProperties注解激活

@Configuration
@EnableConfigurationProperties(AcmeProperties.class)
public class MyConfiguration {
}

直接在AcmeProperties加@Component注解

@Component
@ConfigurationProperties(prefix="acme")
public class AcmeProperties {

    // ... see the preceding example
}

在配置类中与@Bean注解组合

@Bean
public AnotherComponent anotherComponent() {
    ...
}

注册之后，可以在任意地方使用@Autowire注解注入使用。

松散的绑定(Relaxed binding)

Spring Boot使用一些宽松的规则用于绑定Environment属性到@ConfigurationProperties beans，所以Environment属性名和bean属性名不需要精确匹配。常见的有虚线匹配大写（比如，context-path绑定到contextPath）和将环境属性转为大写字母（比如，PORT绑定port）。

比如：

@ConfigurationProperties(prefix="acme.my-project.person")
public class OwnerProperties {
    private String firstName;
    // 省略getter、setter
}

去除指定的自动配置

用@EnableAutoConfiguration注解的exclude参数去除指定的自动配置：

import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;

@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

小结

本节介绍了SpringBoot自定义配置的几种方式。通过属性外化，我们可以灵活选择不同的属性元来应对不同的场景。利用YAML可以让配置文件结构化更易于阅读，特别是有多层结构的属性。@ConfigurationProperties提供类型安全的属性使用方式，使用起来更加直观。组合使用YAML和@ConfigurationProperties相信能让项目的配置变得更加清晰。SpringBoot不仅仅是帮助我们快速搭建一个可用的项目，在使用便利性上也提供了更多的姿势。