(最新 9000 字 )Spring Boot 配置特性解析

架構技術專欄發表於2020-09-25

愛生活，愛編碼，微信搜一搜【架構技術專欄】關注這個喜歡分享的地方。本文架構技術專欄已收錄，有各種JVM、多執行緒、原始碼視訊、資料以及技術文章等你來拿

一、概述

目前Spring Boot版本： 2.3.4.RELEASE，這更新的速度也是嗖嗖的了，隨著新版本的釋出，也一步步針對公司基礎元件進行了升級改造，其中很重要的一塊就是配置檔案的更新（雖然目前已經全部使用了Apollo）。針對Spring Boot 新版本的配置檔案也做了一次梳理，確實發現了以前沒有注意到的點。

二、新版的外部配置

1、基礎配置載入

Spring Boot 為我們提供了很多的外部配置引數，我們可以使用 YAML 檔案（當然你也可以使用properties,但不建議）、環境變數和命令列引數，來區分不同的環境配置。

使用配置有兩種方式：

使用註解@Value，來注入Environment 裡面包含的屬性
使用@ConfigurationProperties 來定義一個屬性類，來包含我們需要的屬性（這些屬性都可以配置在YAML中）

Spring Boot 外部配置這麼多，那如果都配置了哪個會生效呢？

Spring Boot會以下面的順序來載入配置，優先順序從高到低（相同配置優先順序高的會覆蓋低的），從外到裡的來進行配置覆蓋載入：

1）開發者全域性配置的properties檔案（當開發者工具啟用時，檔案在$HOME/.config/spring-boot下的spring-boot-devtools.properties）

2）測試中配置了@TestPropertySource("base.properties") 註解來載入的配置，比如base.properties這種

3）測試中使用了@SpringBootTest的 properties

4）命令列引數配置，也就是java -jar後面使用的配置

5）可以使用SPRING_APPLICATION_JSON 屬性載入的SON配置，載入方式有兩種：

在系統環境變數載入 SPRING_APPLICATION_JSON='{"persion":{"name":"xxx"}}'，這種載入會將這個資料加到Spring Environment中，我們可以獲得一個persion.name 的屬性，值為xxx
使用System屬性載入 java -Dspring.application.json='{"persion":{"name":"xxx"}}' -jar app.jar，這種載入方式會將spring.application.json屬性的值當做一個String來載入，不會解析。

6）ServletConfig 初始化的配置

7）ServletContext初始化的配置

8）java:comp/env的JNDI特性

9）Java的系統屬性，就是System.getProperties() 獲取到的這些

10）作業系統配置的環境變數

11）在RandomValuePropertySource中配置的以random. 開頭的屬性

12）應用外部配置的 application-{profile}.properties或YAML ,可以使用spring.profiles.active 來選擇配置的環境，不選擇預設就是application-default.properties。我們可以使用spring.config.location 來定義檔案的路徑進行載入。

13）在你應用內部配置的application-{profile}.properties 或 YAML,也是用於多環境載入選擇使用，可以用spring.profiles.active 來啟用配置

14）應用外部配置的application.properties或 YAML

15）應用內部配置的application-{profile}.properties 或 YAML。

這裡14、和15 的 SpringApplication 會從application.properties來進行配置屬性的載入。

這個配置會從四個位置按照優先順序從高到低的方式覆蓋載入，高優先順序覆蓋低優先順序的，來看下：

應用外部當前目錄裡 /config 資料夾下的 application.properties 或者application.yml
應用外部當前目錄裡的 application.properties 或者application.yml
應用內部classpath下的/config ，也就是resources/config 目錄下的 application.properties 或者application.yml
應用內部classpath下，也就是resources 目錄下的application.properties 或者application.yml

16）@Configuration 配置類上配置了 @PropertySource註解的，但在spring 上下文重新整理前這個配置是不會被載入到Environment裡面的。這種載入方式不能配置那些應用上下文重新整理前就需要載入的屬性，比如logging.* 和spring.main.* 這種。

使用方式：

 //這裡載入classpath:/com/myco/app.properties檔案
@Configuration
 @PropertySource("classpath:/com/myco/app.properties")
 public class AppConfig {

     @Autowired
     Environment env;

     @Bean
     public TestBean testBean() {
         TestBean testBean = new TestBean();
         testBean.setName(env.getProperty("testbean.name"));
         return testBean;
     }
 }

17）SpringApplication.setDefaultProperties 設定的引數

下面來用一個Demo 說下：

import org.springframework.stereotype.*;
import org.springframework.beans.factory.annotation.*;

@Component
public class MyBean {

    @Value("${name}")
    private String name;

    // ...

}

你可以使用 classpath 下的application.yml來配置name= laowang
可以使用一個外部的application.yml 來設定一個name = laoli 覆蓋上一個配置 (當前name 獲取的話是laoli)
在可以使用java -jar app.jar --name="Spring" 在來覆蓋上一個配置（當前name獲取的話是 Spring）

Spring Boot 配置檔案也支援萬用字元的方式來載入，比如使用 spring.config.additional-location和spring.config.location來載入配置的時候就可以使用萬用字元載入多個檔案。

2、配置隨機屬性

隨機屬性的注入其實是通過RandomValuePropertySource 來實現的，它可以幫我們來產生integers、 longs、 uuid、strings 的隨機值。這個對於我們平時進行一些測試案例還是很實用的。

//可以配置在application.yml
my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number.less.than.ten=${random.int(10)}
my.number.in.range=${random.int[1024,65536]}

3、命令列屬性

我們可以使用 java -jar --server.port=9000的方式將命令列引數server.port 新增到我們應用的Environment，可以使用@Value等方式獲取。正常情況下命令列新增的屬性優先順序是我們們優先順序高的。

如果你不想將命令列的屬性新增到應用的Environment中，那你可以配置SpringApplication.setAddCommandLineProperties(false)就行了。

其實使用命令列載入最多的可能就是--javaagent 這個屬性了，對於現在的公司，APM監控那是必不可少的。我們也可以通過命令引數的配置來臨時的載入一些屬性進行測試使用。

4、應用載入配置檔案

其實上面已經說過了，這裡在重新提一下。SpringApplication 會從application.yml裡面載入屬性配置，並將他們新增到Spring 的Environment中供我們使用。優先順序如下，高優先順序覆蓋低的（這裡放個原版，可以自己嘗試理解下）：

A /config subdirectory of the current directory
The current directory
A classpath /config package
The classpath root

如果你不喜歡配置檔案叫做application.properties，也可以使用spring.config.name來進行配置。也可以使用spring.config.location 來指定配置載入路徑。

舉例說明：

//修改我的配置檔案叫myproject
java -jar myproject.jar --spring.config.name=myproject
  
  
//換一個地方來載入我得配置檔案
java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

因為spring.config.name 和 spring.config.location 配置是用來確定應用需要載入哪些屬性的，所以需要儘可能早的載入。一般都是使用系統環境變數、系統引數、命令列載入的方式進行使用。

預設的配置載入路徑如下，安裝優先順序從高到低排序（file:./config/ 優先順序最高），所以在使用載入的時候一定要注意：

file:./config/
file:./config/*/
file:./
classpath:/config/
classpath:/

5、佔位符的使用

在application.properties 我們可以使用佔位符來進行屬性的動態載入

比如我們可以藉助maven 的profile 在打包的時候動態的對環境引數進行替換（比如替換mysql 、redis等域名）

上幾個例子：

//簡單的使用
app.name=MyApp
app.description=${app.name} is a Spring Boot application
  
//配合命令列引數使用，如引數增加 --port=9000 來代替--server.port=9000，那在配置檔案中我們就可以配置
server.port=${port:8080}

注意一點：

如果你的POM 裡面整合了spring-boot-starter-parent ，那麼預設的maven-resources-plugins外掛會使用@maven.token@來代替${maven.token}。這麼做其實是為了防止和Spring的佔位符產生衝突，所以如果我們使用maven 的profile 或者其他的來動態替換application.properties 內部的屬性，請使用 @name@.

6、YAML檔案進行多環境配置

1）配置檔案使用

在application.yml中，你可以使用spring.profiles 來啟用你想載入的環境配置內容。

例子：

server:
    address: 192.168.1.100
---
spring:
    profiles: development
server:
    address: 127.0.0.1
---
spring:
    profiles: production & eu-central
server:
    address: 192.168.1.120

在上面的例子中，如果我們啟用development 那server.address 就是127.0.0.1。如果production & eu-central 被啟用，那server.address 就是192.168.1.120。如果這三個我都沒啟用，那server.address 就是192.168.1.100，環境配置直接使用---來隔離開。

注意：spring.profiles 這個屬性可以是一個名字，也可以是一個表示式。

2）@Profile註解使用

我們很多時候會遇到元件動態選擇的問題，比如我有多種的許可權接入方式或者資料來源選擇性啟用。但我又不想來來回回寫點if else，那麼@Profile就是一個神器了，他的到來使我們的程式碼更加的靈活多變。

比如我們重寫一個屬於源配置：

//第一個
@Configuration
@Profile("development")
public class StandaloneDataConfig {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .addScript("classpath:com/bank/config/sql/test-data.sql")
            .build();
    }
}

//第二個
@Configuration
@Profile("production")
public class JndiDataConfig {

    @Bean(destroyMethod="")
    public DataSource dataSource() throws Exception {
        Context ctx = new InitialContext();
        return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
    }
}

這樣，我們就可以根據不同的配置來啟用不同的邏輯了，如果再能搭配上遠端配置中心，那就更美麗了。

7、YAML的問題

1） YAML有很多優點，那必然也是有一丟丟的小毛病的。那就是YAML檔案預設不能使用@PropertySource註解來進行配置載入。如果你不想進行多餘的改造，那就老實的建一個properties檔案用吧。

2）在YAML中配置多環境配置資訊有的時候會有奇奇怪怪的問題，比如下面的：

application-dev.yml

server:
  port: 8000
---
spring:
  profiles: "!test"
  security:
    user:
      password: "secret"

如果此時我啟動應用的時候載入了--spring.profiles.active=dev ，那我正常是應該得到security.user.password = secret，但真實的情況卻不是這樣。

因為我們在配置檔名上使用了xxx-dev.yml，這時候當應用載入的時候就會直接找到application-dev.yml檔案.而這時我們配置檔案內的多環境配置就失效了。

所以再多環境配置使用的時候，我們要不然就選擇xxx-dev.yml、xxx-pro.yml 這種方式，要不然就選擇在一個檔案內配置多環境。二者只能選一個，以免出現噁心人的問題。

8、物件屬性繫結

有時候我們會有一組相同型別的屬性需要載入，如果使用@Value 那真是累死人。這裡Spring Boot為我們提供了一個便捷的方式，我們可以使用一個類對所需要的變數進行統一的配置載入。

舉個例子：

//屬性類
package com.example;

import java.net.InetAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

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

@ConfigurationProperties("acme")
public class AcmeProperties {

    private boolean enabled;

    private InetAddress remoteAddress;

    private final Security security = new Security();

    public boolean isEnabled() { ... }

    public void setEnabled(boolean enabled) { ... }

    public InetAddress getRemoteAddress() { ... }

    public void setRemoteAddress(InetAddress remoteAddress) { ... }

    public Security getSecurity() { ... }

    public static class Security {

        private String username;

        private String password;

        private List<String> roles = new ArrayList<>(Collections.singleton("USER"));

        public String getUsername() { ... }

        public void setUsername(String username) { ... }

        public String getPassword() { ... }

        public void setPassword(String password) { ... }

        public List<String> getRoles() { ... }

        public void setRoles(List<String> roles) { ... }

    }
}

這時我在application.yml中配置如下屬性，Spring Boot就會幫助我們直接將屬性繫結到AcmeProperties類中

acme.enabled =false

acme.remote-address=127.0.0.1

acme.security.username=xxx

因為 @EnableConfigurationProperties 只是幫助我們進行宣告，在實際使用上我們需要配合@Configuration，比如下面的配置，這樣配置完後我們就可以使用@Resource 進行屬性注入了。

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

9、寬鬆的繫結規則

上面聊了@ConfigurationProperties 可以幫助我們進行物件屬性繫結，其實在Spring Boot中為我們提供了相當寬鬆的繫結規則。

比如context-path繫結到 contextPath屬性，PORT繫結到 port屬性，下面繼續搞個Demo。

@ConfigurationProperties(prefix="acme.my-project.person")
public class OwnerProperties {

    private String firstName;

    public String getFirstName() {
        return this.firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

}

以上面的程式碼為例，我們能在application.yml中下面的四種配置形式都可以將屬性繫結到 firstName引數上，厲不厲害。

acme.my-project.person.first-name

acme.myProject.person.firstName

acme.my_project.person.first_name

ACME_MYPROJECT_PERSON_FIRSTNAME

當然，為了統一不出問題，建議都使用小寫進行屬性宣告如 acme.my-project.person.first-name 。

10、屬性繫結校驗

在@ConfigurationProperties 宣告的屬性類上，我們可以增加@Validated 來對配置屬性進行校驗。

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

    @NotNull
    private InetAddress remoteAddress;

    @Valid
    private final Security security = new Security();

    // ... getters and setters

    public static class Security {

        @NotEmpty
        public String username;

        // ... getters and setters

    }

}