一則小故事：小坤肌蜻，你過來，昨天叫你搞得新項目原型搭好沒恕刘？經(jīng)理缤谎，我還在配置XML呢。褐着。這可能是發(fā)生在你們身邊的故事坷澡，不過傳統(tǒng)Spring項目各種眼花繚亂的XML配置確實讓開發(fā)人員調(diào)試的想發(fā)瘋，如今含蓉，你有了新的選擇频敛，是時候扔掉這些煩人的XML了。

學習目標

快速學會和掌握 SpringBoot 的核心配置文件的使用馅扣。

快速查閱

外部配置： Externalized Configuration
默認屬性列表：Common Application properties
智能提示：IDEA With Yaml Plugin

學習目錄

一斟赚、基本介紹
二、快速添加屬性
四差油、快速讀取屬性（基于注解）
五拗军、默認加載路徑
六、使用YAML代替Properties（推薦）
七蓄喇、命令行參數(shù)

一发侵、基本介紹

SpringBoot 提供了豐富的外部配置，常見的有：

核心配置文件
- application.properties
- application.yml
命令行參數(shù)
OS環(huán)境變量
Dev屬性

其中核心配置文件我們并不陌生妆偏，主要以Key-Value的形式進行配置刃鳄，其中屬性Key主要分為兩種：

默認屬性：根據(jù) 《默認屬性列表》填寫，SpringBoot將自動讀取配置和進行初始化楼眷。
自定義屬性：根據(jù)需求任意填寫铲汪，但需要自行讀取配置和進行初始化。

如圖所示：

二罐柳、添加默認屬性

在 application.properties 添加配置如下：

① 添加數(shù)據(jù)源信息

spring.datasource.url=jdbc:oracle:thin:@localhost:1521:XE
spring.datasource.username=admin
spring.datasource.password=admin
spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver

溫馨提示：
有小伙伴反饋說上面的默認屬性容易寫錯掌腰，這里推薦大家使用IDEA開發(fā)工具，因為其內(nèi)置插件可自動提示并識別《默認屬性列表》张吉，免除查閱資料的煩惱齿梁。PS：初學者可查閱《IntelliJ IDEA 使用教程(2019圖文版) -- 從入門到上癮》快速上手。

三肮蛹、添加自定義屬性

在 application.propertis 添加配置如下：

① 添加認證信息勺择，其中 socks.indentity.* 是自定義的屬性前綴。

socks.identity.number=441881199610245710
socks.identity.name=socks
socks.identity.address=beijing load

② 添加隨機值伦忠，其中spring.test.* 是自定義的屬性前綴省核。

spring.test.my-id1=${random.int}
spring.test.my-id2=${random.int(10)}  
spring.test.my-id3=${random.int[10,20]}
spring.test.my-id4=${random.long}
spring.test.my-name= ${random.value} 
spring.test.my-uuid=${random.uuid} #生成UUID

注：核心配置文件Properties和Yaml 兩者都支持使用屬性占位符${param}來填值，例如${random.int}就是在Environment預先定義的屬性值昆码，詳情可查閱 RandomValuePropertySource气忠。

四、讀取屬性

1. 使用@ConfigurationProperties 讀取多個屬性

使用方法：@ConfigurationProperties(prefix = "spring.datasource")

使用說明：提供 Setter方法和標記組件 Component

@Component
@ConfigurationProperties(prefix = "spring.datasource")
public class MyDataSource {

    private String url;

    private String username;

    private String password;

    private String driverClassName;

    // 提供Setter 和 Getter 方法
}

如何驗證是否成功讀取配置赋咽？答：這里可以簡單做個驗證旧噪，注入MyDataSource，使用Debug模式可以看到如下信息：

讀取配置成功

注：嘿嘿脓匿，你現(xiàn)在能大概猜到為什么SpringBoot 應(yīng)用能夠根據(jù)默認屬性來自動配置數(shù)據(jù)源了吧淘钟？因為內(nèi)置的數(shù)據(jù)源類DataSourceProperties通過@ConfigurationProperties(prefix = "spring.datasource")讀取到了我們在配置文件填寫的數(shù)據(jù)源信息，然后通過DataSourceAutoConfiguration 創(chuàng)建了數(shù)據(jù)源Bean和進行了相關(guān)初始化配置陪毡。

2. 使用@Value 讀取單個屬性

使用方法：@Value("spring.datasource.*")

使用說明：提供 Setter方法和標記組件 Component

@Component
public class MyDataSource {

    @Value("spring.datasource.url")
    private String url;

    @Value("spring.datasource.username")
    private String username;

    @Value("spring.datasource.password")
    private String password;

    @Value("spring.datasource.driver-class-name")
    private String driverClassName;

    // 提供Setter 和 Getter 方法
}

注意事項：@Value不支持注入靜態(tài)變量米母，可間接通過Setter注入來實現(xiàn)。

    private static String siteUrl;

    @Value("${my.url}")
    public void setSiteUrl(String myUrl) {
        System.out.println(myUrl);
        siteUrl = myUrl;
    }

3. 關(guān)于@ConfigurationProperties和@Value的區(qū)別

關(guān)于兩者的簡單功能對比：

特性	@ConfigurationProperties	@Value
松綁定	Yes	No
元數(shù)據(jù)（Meta-data ）	Yes	No
支持SpringEL	No	Yes

顯然毡琉，前者支持松綁定的特性更強大爱咬，所以在實際開發(fā)中建議使用@ConfigurationProperties來讀取自定義屬性。

五绊起、默認加載路徑

SpringBoot 默認會加載這些路徑加載核心配置文件精拟，按優(yōu)先級從高到低進行排列：具體規(guī)則詳見 ConfigFileApplicationListener

1. 工程根目錄的config目錄：file:./config/
1. 工程根目錄：file:./
1. 類路徑的config目錄：classpath:/config/
1. 類路徑：classpath:/ （推薦使用）

如果存在多個配置文件，則嚴格按照優(yōu)先級進行覆蓋虱歪，最高者勝出：

舉個簡單的例子蜂绎，例如再上述位置都有一個application.properties ，并且每個文件都寫入了server.port=xx （xx分別是9001笋鄙，9002师枣，9003，9004）萧落，在啟動成功之后践美，最終應(yīng)用的端口為：9004洗贰。圖例：

工程頂層目錄

如果想修改默認的加載路徑或者調(diào)改默認的配置文件名，我們可以借助命令行參數(shù)進行指定陨倡，例如：

java -jar demo.jar --spring.config.name=app --spring.config.location=classpath:/myconfig/

注：不管 spring.config.location 配置什么值敛滋，默認總會按照 classpath:,classpath:/config,file:,file:config/ 的順序進行搜索，優(yōu)先級由低到高兴革，也就是 file:config/ 獲勝绎晃。如果你指定自己的位置，它們會優(yōu)先于所有的默認位置杂曲，并使用相同的由低到高的優(yōu)先級順序庶艾。詳見SpringBoot Custom-Config

六、使用YAML代替Properties

1. 基本介紹

YAML是JSON的一個超集擎勘，是一種可輕松定義層次結(jié)構(gòu)的數(shù)據(jù)格式咱揍。

2. 為什么推薦YAML？

答：因為配置文件這東西棚饵，結(jié)構(gòu)化越早接觸越規(guī)范越好述召。這里推薦閱讀阮一峰老師寫的YAML語言教程，寫的很簡單明了蟹地。

3. 如何使用YAML

引入依賴：在POM文件引入snakeyaml 的依賴积暖。

注：spring-boot-starter-xxx 會自動引入該依賴。

使用說明：直接在類路徑添加application.yml 即可怪与。

4. YAML和Properties的使用對比

例如下面這兩段配置是完全等價的：

① 在application.yml 配置數(shù)據(jù)源:

spring:
  datasource:
    url: jdbc:oracle:thin:@localhost:1521:XE
    username: admin
    password: admin
    driver-class-name: oracle.jdbc.driver.OracleDriver

② 在application.properties 配置數(shù)據(jù)源：

spring.datasource.url=jdbc:oracle:thin:@localhost:1521:XE
spring.datasource.username=admin
spring.datasource.password=admin
spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver

注：雖然application.yml和application.properties語法上存在差異夺刑，但實際效果相同，因為內(nèi)置的YamlPropertySourceLoader 會將application.yml 的屬性通過PropertySource導入到Environment上下文分别。

5. Yaml支持多環(huán)境配置

在項目的實際開發(fā)中遍愿，我們往往需要根據(jù)不同的環(huán)境來加載不同的配置文件。例如生產(chǎn)環(huán)境耘斩，測試環(huán)境和開發(fā)環(huán)境等沼填。此時，我們可以借助Profiles來指定加載哪些配置文件括授。例如：

application.yml  配置如下：
spring:
  profiles:
    active: test   # 選擇加載文件application-{test}.yml

application-prod.yml  配置如下：
server:
  port: 9001 #生產(chǎn)環(huán)境端口

application-test.yml  配置如下：
server:
  port: 8081  #測試環(huán)境端口

溫馨提示：如果spring.profiles.active指定了多個配置文件坞笙，則按順序加載，其中最后的優(yōu)先級最高荚虚，也就是最后的會覆蓋前者薛夜。

七、命令行參數(shù)

使用方法：
使用Maven插件打包好項目版述，然后在當前路徑梯澜，執(zhí)行DOS命令： java -jar demo.jar --server.port=8081，在控制臺可看到應(yīng)用端口變成了8081渴析。

實現(xiàn)原理：
默認情況下晚伙，SpringBoot會將這些命令行參數(shù)轉(zhuǎn)化成一個 Property 吮龄，并將其添加到Environment上下文。

溫馨提示：
由于命令行參數(shù)優(yōu)先級非常之高咆疗，基本高于所有常見的外部配置漓帚，所以使用的時候要謹慎。詳見PropertySource 執(zhí)行順序民傻。

關(guān)閉方法：
如果想禁用命令行屬性胰默，可以設(shè)置如下操作：springApplication.setAddCommandLineProperties(false)

SpringBoot 配置文件詳解（告別XML）

SpringBoot 配置文件詳解（告別XML）

學習目標

快速查閱

學習目錄

一发侵、基本介紹

二罐柳、添加默認屬性

三肮蛹、添加自定義屬性

四、讀取屬性

1. 使用@ConfigurationProperties 讀取多個屬性

2. 使用@Value 讀取單個屬性

3. 關(guān)于@ConfigurationProperties和@Value的區(qū)別

五绊起、默認加載路徑

六、使用YAML代替Properties

1. 基本介紹

2. 為什么推薦YAML？

3. 如何使用YAML

4. YAML和Properties的使用對比

5. Yaml支持多環(huán)境配置

七、命令行參數(shù)

SpringBoot 配置文件詳解（告別XML）

學習目標

快速查閱

學習目錄

一发侵、基本介紹

二罐柳、添加默認屬性

三肮蛹、添加自定義屬性

四、讀取屬性

1. 使用@ConfigurationProperties 讀取多個屬性

2. 使用@Value 讀取單個屬性

3. 關(guān)于@ConfigurationProperties和@Value的區(qū)別

五绊起、 默認加載路徑

六、使用YAML代替Properties

1. 基本介紹

2. 為什么推薦YAML？

3. 如何使用YAML

4. YAML和Properties的使用對比

5. Yaml支持多環(huán)境配置

七、命令行參數(shù)

五绊起、默認加載路徑