一、概念

占位符——形如：${guo.name}是一種靈活的配置方式，可以讓我們很靈活的使用配置參數(shù)，@Value注解的配置也是占位符的一種體現(xiàn)方式，這種方式可以從Environment內(nèi)獲取對應(yīng)的配置值。

二、配置方式

2.1 配置文件

在application.yml/properties配置文件內(nèi)可以直接使用占位符來進行配置的相互引用，如下所示：

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的配置值，這樣我們在系統(tǒng)中通過@Value("${guo.name}")或者通過@ConfigurationProperties方式使用時，得到的值都為sc-gateway-application。

2.2 @ConfigurationProperties方式使用配置文件

@ConfigurationProperties 主要用于配置文件中的指定鍵值對映射到一個java實體類上。
基本用法非常簡單:我們?yōu)槊總€要捕獲的外部屬性提供一個帶有屬性的類。請注意以下幾點:

1. 前綴定義了那些哪部屬性將綁定到類的字段上
2. 根據(jù) Spring Boot 寬松的綁定規(guī)則，類的屬性名稱必須與外部屬性的名稱匹配
3. 我們可以簡單地用一個值初始化一個字段來定義一個默認(rèn)值
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: 郭秀志 jbcode@126.com
 * @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);
    }

占位符方式極大地減少了相同的配置出現(xiàn)，讓我們在配置文件中也可以實現(xiàn)類似于常量的定義。

三、使用默認(rèn)值

當(dāng)我們使用@Value注解來注入配置參數(shù)時，如果所引入的配置為NULL，啟動項目時會拋出異常，項目無法正常啟動，所以我們有必要添加一個默認(rèn)值，格式為冒號后面寫上默認(rèn)值，配置文件修改如下：

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

通過${xxx:defaultValue}的形式可以配置默認(rèn)值，當(dāng)占位符所引用的配置為NULL時，將會使用默認(rèn)值（默認(rèn)值的類型要對配置匹配）。此時我們注釋了pring.application.name相當(dāng)于沒有設(shè)置值，那么默認(rèn)一個取到erbadagang。
測試輸出:configname = erbadagang。

也可以通過@Value("${guo.name:defaultValue}")這種方式配置默認(rèn)值，不建議使用這種方式，默認(rèn)值有變動時，我們還要逐個修改。

四、“短”命令行參數(shù)

在實際部署應(yīng)用程序時，有很多通過命令行參數(shù)方式實現(xiàn)配置是動態(tài)，不過SpringBoot所提供的配置參數(shù)名稱都比較長，對此我們完全可以利用占位符配置方式實現(xiàn)自定義參數(shù)名。

占位符是從Environment內(nèi)讀取對應(yīng)的配置值，而命令行參數(shù)在應(yīng)用程序啟動時會被一并加入到Environment中，因此也就實現(xiàn)了占位符動態(tài)配置，其實這個“短”的含義，是你定義的新的配置名稱比較短而已。

假設(shè)我們的guo.name值需要動態(tài)指定，我們自定義一個短變量名稱my-name，配置文件改為：

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

在運行前，配置my-name的值為trek：

配置測試方法的環(huán)境變量

運行返回：configname = trek
實際運行中多數(shù)是使用jar命令啟動，所以上圖配置方法的等同: java -jar project-1.0.0.SNAPSHOT.jar --my-name=trek。