【spring-boot】 屬性配置

摘要: 原創出處 www.bysocket.com 「泥瓦匠BYSocket 」歡迎轉載，保留摘要，謝謝！

一.自動配置

Spring Boot 不單單從 application.properties 擷取配置，是以我們可以在程式中多種設定配置屬性。按照以下清單的優先級排列： 1.指令行參數 2.java:comp/env 裡的 JNDI 屬性 3.JVM 系統屬性 4.作業系統環境變量 5.RandomValuePropertySource 屬性類生成的 random.* 屬性 6.應用以外的 application.properties（或 yml）檔案 7.打包在應用内的 application.properties（或 yml）檔案 8.在應用 @Configuration 配置類中，用 @PropertySource 注解聲明的屬性檔案 9.SpringApplication.setDefaultProperties 聲明的預設屬性

可見，指令行參數優先級最高。這個可以根據這個優先級，可以在測試或生産環境中快速地修改配置參數值，而不需要重新打包和部署應用。 還有第 6 點，根據這個在多 moudle 的項目中，比如常見的項目分 api 、service、dao 等 moudles，往往會加一個 deploy moudle 去打包該業務各個子 moudle，應用以外的配置優先。

二.自定義屬性

在 application.properties 中對應 HomeProperties 對象字段編寫屬性的 KV 值：

## 家鄉屬性 Dev
home.province=ZheJiang
home.city=WenLing
home.desc=dev: I'm living in ${home.province} ${home.city}.      

這裡也可以通過占位符，進行屬性之間的引用。

然後，編寫對應的 HomeProperties Java 對象：

/**
 * 家鄉屬性
 *
 * Created by bysocket on 17/04/2017.
 */
@Component
@ConfigurationProperties(prefix = "home")
public class HomeProperties {

    /**
     * 省份
     */
    private String province;

    /**
     * 城市
     */
    private String city;

    /**
     * 描述
     */
    private String desc;

    public String getProvince() {
        return province;
    }

    public void setProvince(String province) {
        this.province = province;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    @Override
    public String toString() {
        return "HomeProperties{" +
                "province='" + province + '\'' +
                ", city='" + city + '\'' +
                ", desc='" + desc + '\'' +
                '}';
    }
}      

通過  @ConfigurationProperties(prefix = "home”) 注解，将配置檔案中以 home 字首的屬性值自動綁定到對應的字段中。同是用 @Component 作為 Bean 注入到 Spring 容器中。

如果不是用 application.properties 檔案，而是用 application.yml 的檔案，對應配置如下：

## 家鄉屬性
home:
  province: 浙江省
  city: 溫嶺松門
  desc: 我家住在${home.province}的${home.city}      

鍵值對冒号後面，必須空一格。

注意這裡，就有一個坑了： application.properties 配置中文值的時候，讀取出來的屬性值會出現亂碼問題。但是 application.yml 不會出現亂碼問題。原因是，Spring Boot 是以 iso-8859 的編碼方式讀取 application.properties 配置檔案。

注意這裡，還有一個坑： 如果 定義一個鍵值對 user.name=xxx ,這裡會讀取不到對應寫的屬性值。----讀到的是系統本身的使用者名字。 為什麼呢？Spring Boot 的預設 StandardEnvironment 首先将會加載 “systemEnvironment" 作為首個PropertySource. 而 source 即為System.getProperties().當 getProperty時,按照讀取順序,傳回 “systemEnvironment" 的值.即 System.getProperty(" user.name") 配置檔案：

user.name=zhang      

擷取配置檔案 user.name：

@Value("${user.name}")
String name;

@Test
public void getHomeProperties() {
    LOGGER.info("\n\n" + homeProperties.toString() + "\n");
    LOGGER.info(name);
}      

擷取配置檔案 user.name：結果：

2018-03-23 10:54:13.643  INFO 625 --- [           main] o.s.springboot.property.PropertiesTest   : uknowzxt

三.random.*屬性

Spring Boot 通過 RandomValuePropertySource 提供了很多關于随機數的工具類。概括可以生成随機字元串、随機 int 、随機 long、某範圍的随機數。 運作 springboot-properties 工程 org.spring.springboot.property.PropertiesTest 測試類的 randomTestUser 方法。多次運作，可以發現每次輸出不同 User 屬性值：

UserProperties{id=-3135706105861091890, age=41, desc='泥瓦匠叫做3cf8fb2507f64e361f62700bcbd17770', uuid='582bcc01-bb7f-41db-94d5-c22aae186cb4'}
      

application.yml 方式的配置如下（ application.properties 形式這裡不寫了）：

## 随機屬性
user:
  id: ${random.long}
  age: ${random.int[1,200]}
  desc: 泥瓦匠叫做${random.value}
  uuid: ${random.uuid}      

四. 多環境配置

很多場景的配置，比如資料庫配置、Redis 配置、注冊中心和日志配置等。在不同的環境，我們需要不同的包去運作項目。是以看項目結構，有兩個環境的配置：

application-dev.properties：開發環境
application-prod.properties：生産環境      

Spring Boot 是通過 application.properties 檔案中，設定 spring.profiles.active 屬性，比如 ，配置了 dev ,則加載的是 application-dev.properties ：

# Spring Profiles Active
spring.profiles.active=dev      

那運作 springboot-properties 工程中 Application 應用啟動類，從控制台中可以看出，是加載了 application-dev.properties 的屬性輸出：

HomeProperties{province='ZheJiang', city='WenLing', desc='dev: I'm living in ZheJiang WenLing.'}      

将 spring.profiles.active 設定成 prod，重新運作，可得到 application-prod.properties的屬性輸出：

HomeProperties{province='ZheJiang', city='WenLing', desc='prod: I'm living in ZheJiang WenLing.'}
      

根據優先級，順便介紹下 jar 運作的方式，通過設定 -Dspring.profiles.active=prod 去指定相應的配置:

mvn package
java -jar -Dspring.profiles.active=prod springboot-properties-0.0.1-SNAPSHOT.jar      

五.通過指令行設定屬性

相信使用過一段時間Spring Boot的使用者，一定知道這條指令：

java -jar xxx.jar --server.port=8888

，通過使用—server.port屬性來設定xxx.jar應用的端口為8888。

在指令行運作時，連續的兩個減号

--

就是對

application.properties

中的屬性值進行指派的辨別。是以，

java -jar xxx.jar --server.port=8888

指令，等價于我們在

application.properties

中添加屬性

server.port=8888

，該設定在樣例工程中可見，讀者可通過删除該值或使用指令行來設定該值來驗證。

通過指令行來修改屬性值固然提供了不錯的便利性，但是通過指令行就能更改應用運作的參數，那豈不是很不安全？是的，是以Spring Boot也貼心的提供了屏蔽指令行通路屬性的設定，隻需要這句設定就能屏蔽：

SpringApplication.setAddCommandLineProperties(false)

。