spring boot學習(6)— 配置信息及其讀取優先級

1. properties 信息從哪裏取

在不同的環境，我們需要使用不同的配置，Spring boot 已經提供了相關功能，可以是 properties 文件， yaml 文件 或是命令行參數。優先級如下

1. Devtools global settings properties on your home directory (~/.spring-boot-devtools.properties when devtools is active).
2. @TestPropertySource annotations on your tests.
3. @SpringBootTest#properties annotation attribute on your tests.

4. Command line arguments.

   java -jar app.jar --name="Spring"

5. Properties from SPRING_APPLICATION_JSON (inline JSON embedded in an environment variable or system property).

   • environment vaiable：SPRING_APPLICATION_JSON='{"acme":{"name":"test"}}' java -jar myapp.jar

   • command line:

     • java -Dspring.application.json='{"name":"test"}' -jar myapp.jar
     • java -jar myapp.jar --spring.application.json='{"name":"test"}'
6. ServletConfig init parameters.
7. ServletContext init parameters.
8. JNDI attributes from java:comp/env.
9. Java System properties (System.getProperties()).
10. OS environment variables.
11. A RandomValuePropertySource that has properties only in random.*.

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]}

1. Profile-specific application properties outside of your packaged jar (application-{profile}.properties and YAML variants).
2. Profile-specific application properties packaged inside your jar (application-{profile}.properties and YAML variants).
3. Application properties outside of your packaged jar (application.properties and YAML variants).
4. Application properties packaged inside your jar (application.properties and YAML variants).
5. @PropertySource annotations on your @Configuration classes.
6. Default properties (specified by setting SpringApplication.setDefaultProperties).

2. 使用 application.properties 文件

使用 properties 文件，spring boot 會根據以下目錄去尋找，添加到 Spring Environment 中，優先級依次遞增。

1. classpath:/: resources 目錄
2. classpath:/config/: resources 下 config 目錄
3. file:./：工程根目錄
4. file:./config/: 工程跟目錄下的 config 目錄

2.1 加載順序：

從優先級高的先加載。

1. file:./config/
2. file:./
3. classpath:/config/
4. classpath:/

2019-03-27 22:38:24.848 DEBUG 39802 --- [           main] o.s.boot.SpringApplication               : Loading source class com.example.exitcode.DemoApplication
2019-03-27 22:38:24.915 DEBUG 39802 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Loaded config file 'file:./config/application.properties' (file:./config/application.properties)
2019-03-27 22:38:24.915 DEBUG 39802 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Loaded config file 'file:./application.properties' (file:./application.properties)
2019-03-27 22:38:24.915 DEBUG 39802 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Loaded config file 'jar:file:xxxxx-0.0.1-SNAPSHOT.jar!/BOOT-INF/classes!/config/application.properties' (classpath:/config/application.properties)
2019-03-27 22:38:24.915 DEBUG 39802 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Loaded config file 'jar:file:xxxxx-0.0.1-SNAPSHOT.jar!/BOOT-INF/classes!/application.properties' (classpath:/application.properties)

2.2 屬性值怎麼取

優先級高的會覆蓋優先級低的。

1. ./config/application.properties

   testconfig.first=./config/
   #testconfig.second=./config/
   #testconfig.third=./config/
   #testconfig.fourth=./config/

2. ./application.properties

   testconfig.first=./
   testconfig.second=./
   #testconfig.third=./
   #testconfig.fourth=./

3. classpath:/config/application.properties

   testconfig.first=classpath/config/
   testconfig.second=classpath/config/
   testconfig.third=classpath/config/
   #testconfig.fourth=classpath/config/

4. classpath:/application.properties

   testconfig.first=classpath
   testconfig.second=classpath
   testconfig.third=classpath
   testconfig.fourth=classpath

輸出如下：

2019-03-27 23:29:12.434  INFO 1335 --- [           main] com.example.properties.DemoApplication   : No active profile set, falling back to default profiles: default
first: ./config/
second: ./
third: classpath/config/
fourth: classpath
2019-03-27 23:29:13.052  INFO 1335 --- [           main] com.example.properties.DemoApplication   : Started DemoApplication in 16.565 seconds (JVM running for 23.467)

2.3 多環境配置文件

加一個文件： classpath:/application-product.properties

testconfig.first=product-classpath
testconfig.second=product-classpath

通過 spring.profiles.active 來指定環境所對應的 properties 文件：
運行 java -jar build/libs/properties-0.0.1-SNAPSHOT.jar --spring.profiles.active=product, 輸出如下：

2019-03-28 20:34:44.726  INFO 25859 --- [           main] com.example.properties.DemoApplication   : The following profiles are active: product
first: product-classpath
second: product-classpath
third: classpath/config/
fourth: classpath
fifth: ./config/
sixth: ./config/
seventh: ./config/
eightth: ./config/

2.3 使用 yaml 文件來代替 properties 文件。

也可以使用 yaml 格式的文件。但是在同等目錄下，properties 優先級高於 yaml 文件的配置信息。

新增文件 ./config/application.yml

testconfig:
  frist: ./config/yml
  second: ./config/yml

命令 java -jar build/libs/properties-0.0.1-SNAPSHOT.jar 輸出爲:

first: ./config/
second: ./config/yml
third: classpath/config/
fourth: classpath
fifth: ./config/
sixth: ./config/
seventh: ./config/
eightth: ./config/

2.5 屬性文件中可以使用變量已經聲明過的變量值：

app.name=MyApp
app.description=${app.name} is a Spring Boot application