SpringBoot2.x配置文件使用占位符

一、概念

占位符——形如：${guo.name}是一种灵活的配置方式，可以让我们很灵活的使用配置参数，@Value注解的配置也是占位符的一种体现方式，这种方式可以从Environment内获取对应的配置值。

二、配置方式

2.1 配置文件

在application.yml/properties配置文件内可以直接使用占位符来进行配置的相互引用，如下所示：

2.1.1 yml方式：

#自定义的属性，引用了spring.application.name
guo:
  name: ${spring.application.name}

spring:
  application:
    name: sc-gateway-application

2.1.2 properties方式：

spring.application.name=sc-gateway-application
#自定义的属性，引用了spring.application.name
guo.name=${spring.application.name}

在上面的配置中，name配置直接引用了spring.application.name的配置值，这样我们在系统中通过@Value("${guo.name}")或者通过@ConfigurationProperties方式使用时，得到的值都为sc-gateway-application。

2.2 @ConfigurationProperties方式使用配置文件

@ConfigurationProperties 主要用于配置文件中的指定键值对映射到一个java实体类上。
基本用法非常简单:我们为每个要捕获的外部属性提供一个带有属性的类。请注意以下几点:

1. 前缀定义了那些哪部属性将绑定到类的字段上
2. 根据 Spring Boot 宽松的绑定规则，类的属性名称必须与外部属性的名称匹配
3. 我们可以简单地用一个值初始化一个字段来定义一个默认值
4. 类本身可以是包私有的
5. 类的字段必须有公共 setter 方法

示例代码

package com.erbadagang.springboot.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

/**
 * LoadConfig作用是：主要用于配置文件中的指定键值对映射到一个java实体类上。
 *
 * @ClassName: LoadConfig
 * @author: 郭秀志 [email protected]
 * @date: 2020/7/30 9:22
 * @Copyright:
 */
// @ConfigurationProperties方式
@Configuration
@ConfigurationProperties(prefix = "guo")
public class LoadConfig {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

测试

package com.erbadagang.springboot.async;

import com.erbadagang.springboot.config.LoadConfig;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class AsyncApplicationTests {


    @Autowired
    private LoadConfig loadConfig;

    @Test
    void testConfig() {
        System.out.println("loadConfig.getName() = " + loadConfig.getName());
    }
}

输出

loadConfig.getName() = sc-gateway-application

2.3 @value方式使用配置文件

    // @Value方式
    @Value("${guo.name}")
    private String configname;

    @Test
    void testConfigValue() {
        System.out.println("configname = " + configname);
    }

占位符方式极大地减少了相同的配置出现，让我们在配置文件中也可以实现类似于常量的定义。

三、使用默认值

当我们使用@Value注解来注入配置参数时，如果所引入的配置为NULL，启动项目时会抛出异常，项目无法正常启动，所以我们有必要添加一个默认值，格式为冒号后面写上默认值，配置文件修改如下：

#spring.application.name=sc-gateway-application
#自定义的属性，引用了spring.application.name
guo.name=${spring.application.name:erbadagang}

通过${xxx:defaultValue}的形式可以配置默认值，当占位符所引用的配置为NULL时，将会使用默认值（默认值的类型要对配置匹配）。此时我们注释了pring.application.name相当于没有设置值，那么默认一个取到erbadagang。
测试输出:configname = erbadagang。

也可以通过@Value("${guo.name:defaultValue}")这种方式配置默认值，不建议使用这种方式，默认值有变动时，我们还要逐个修改。

四、“短”命令行参数

在实际部署应用程序时，有很多通过命令行参数方式实现配置是动态，不过SpringBoot所提供的配置参数名称都比较长，对此我们完全可以利用占位符配置方式实现自定义参数名。

占位符是从Environment内读取对应的配置值，而命令行参数在应用程序启动时会被一并加入到Environment中，因此也就实现了占位符动态配置，其实这个“短”的含义，是你定义的新的配置名称比较短而已。

假设我们的guo.name值需要动态指定，我们自定义一个短变量名称my-name，配置文件改为：

#自定义的属性，引用了spring.application.name
guo.name=${my-name:erbadagang}

在运行前，配置my-name的值为trek：

配置测试方法的环境变量

运行返回：configname = trek
实际运行中多数是使用jar命令启动，所以上图配置方法的等同: java -jar project-1.0.0.SNAPSHOT.jar --my-name=trek。