SpringCloud入門之Spring Boot多環境配置切換指南

在 spring boot 中，有兩種配置文件，一種是application.properties,另外一種是application.yml,兩種均可以配置spring boot 項目中的一些變量的定義，參數的設置等。

其中yml格式文件編寫規範參考文章手把手學系列之YAML格式文件規範學習

通常在一個項目中，老是會有好多個環境。好比：

開發環境 -> 測試環境 -> 預發佈環境 -> 生產環境

每一個環境上的配置文件老是不同的，甚至開發環境中每一個開發者的環境可能也會有一點不一樣，配置讀取但是一個讓人有點傷腦筋的問題。

Spring Boot提供了一種優先級配置讀取的機制來幫助咱們從這種困境中走出來。

常規狀況下，咱們都知道Spring Boot的配置會從application.properties中讀取。實際上，從resource目錄下的application.properties文件讀取是Spring Boot配置鏈中的一環而已。

根據Spring Boot的文檔,配置使用的優先級從高到低的順序，具體以下所示：

1. 命令行參數。 2. 經過 System.getProperties() 獲取的 Java 系統參數。 3. 操做系統環境變量。 4. 從 java:comp/env 獲得的 JNDI 屬性。 5. 經過 RandomValuePropertySource 生成的「random.*」屬性。 6. 應用 Jar 文件以外的屬性文件(application.properties)。 7. 應用 Jar 文件內部的屬性文件(application.properties)。 8. 在應用配置 Java 類（包含「@Configuration」註解的 Java 類）中經過「@PropertySource」註解聲明的屬性文件。 9. 經過「SpringApplication.setDefaultProperties」聲明的默認屬性。 

這意味着，若是Spring Boot在優先級更高的位置找到了配置，那麼它就會無視低級的配置。

方法1、不在配置文件寫上配置節定義，而是經過執行時定位不一樣配置單獨文件來區分。

好比，我在application.properties目錄中，寫入本地的MySQL的配置：

db.jdbc.driver=com.mysql.jdbc.Driver
db.jdbc.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8 db.jdbc.username=username db.jdbc.password=password 

在本身項目調試的階段，項目老是會使用本地的MySQL數據庫。而一旦打包以後，在外部聲明一個test_evn.properties.

啓動Jar包的時候, 指定一個外部配置文件：

java -jar demo.jar --spring.config.location=/path/test_evn.properties 

這樣一來，咱們在開發者的機器上老是使用本身的配置，而一到對應的環境，就會使用高級的位置所作的配置。

方法2、在配置文件寫上配置節定義，在執行時傳遞配置節需激活定義名稱來區分。

一、在application.properties ，寫法以下：

spring.profiles.active=dev
spring.datasource.data-username=root
spring.datasource.data-password=root

二、在yml 文件中配置的話，寫法以下：

　　

spring:
  profiles:
    active: prod
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/test
    username: root
    password: root

啓動Jar包的時候：Java -jar xxxxxx.jar spring.profiles.actiove=prod 也能夠這樣啓動設置配置文件，可是這只是用於開發和測試

下面提供一個在同一文件中定義多個配置節的詳細參考用例：
spring:
application:
name: config-server  #通常狀況下這部分應放在bootstrap.yml或bootstrap.properties文件中
---
#服務配置
spring:
profiles: config-server1
#應用配置
cloud:
config:
label: master #git label(提交id,分支名稱或tag)
server:
git:
password: '' #登陸密碼
searchPaths: common-config #搜尋目錄，能夠配置多個，用逗號分割
uri: #倉庫地址
username: '' #登陸用戶

#svn:
#uri: http://192.168.0.6/svn/repo/config-repo
#username: username
#password: password
#default-label: trunk
#profiles:
#active: subversion
server:
port: '8888' 
#eureka服務註冊地址
eureka: 
client: 
service-url: 
defaultZone: http://server1:8761/eureka/,http://server1:8762/eureka/,http://server1:8763/eureka/ 
#instance: 
#prefer-ip-address: true
---
#服務配置
spring:
profiles: config-server2
#應用配置
cloud:
config:
label: master #git label(提交id,分支名稱或tag)
server:
git:
password: '' #登陸密碼
searchPaths: common-config #搜尋目錄，能夠配置多個，用逗號分割
uri: *** #倉庫地址
username: '' #登陸用戶

#svn:
#uri: http://192.168.0.6/svn/repo/config-repo
#username: username
#password: password
#default-label: trunk
#profiles:
#active: subversion
server:
port: '8889' 
#eureka服務註冊地址
eureka: 
client: 
service-url: 
defaultZone: http://server1:8761/eureka/,http://server1:8762/eureka/,http://server1:8763/eureka/ 
#instance: 
#prefer-ip-address: true

 

 

啓動Jar包的時候：

Java -jar xxxxxx.jar  --spring.profiles.active=config-server1 

Java -jar xxxxxx.jar  --spring.profiles.active=config-server2

在代碼中讀取這些配置也是很是方便的，在代碼的邏輯中，實際上是無需去關心這個配置是從什麼地方來的，只用關注能獲取什麼配置就夠了。

public class ApplicationConfigure { @Value("${db.jdbc.driver}") private String jdbcDriver; @Value("${db.jdbc.url}") private String jdbcUrl; @Value("${db.jdbc.username}") private String jdbcUsername; @Value("${db.jdbc.password}") private String jdbcPassword; // mysql config class // ..... } 

有時候咱們在項目啓動的時候，老是須要先啓動一些初始化的類，之前比較常見的作法是寫再static塊中，Spring Boot提供了一個CommandLineRunner接口，實現這個接口的類老是會被優先啓動，並優先執行CommandLineRunner接口中提供的run()方法。

public class ApplicationConfigure implements CommandLineRunner { @Value("${db.jdbc.driver}") private String jdbcDriver; @Value("${db.jdbc.url}") private String jdbcUrl; @Value("${db.jdbc.username}") private String jdbcUsername; @Value("${db.jdbc.password}") private String jdbcPassword; // mysql config class // ..... @Override public void run(String... strings) throws Exception { // 預先加載的一些方法，類，屬性。 } }