51. spring boot屬性檔案之多環境配置【從零開始學Spring Boot】（
【視訊&交流平臺】
http://study.163.com/course/introduction.htm?courseId=1004329008&utm_campaign=commission&utm_source=400000000155061&utm_medium=share
http://study.163.com/course/introduction.htm?courseId=1004638001&utm_campaign=commission&utm_source=400000000155061&utm_medium=share
https://gitee.com/happyangellxq520/spring-boot
http://412887952-qq-com.iteye.com/blog/2321532
原本這個章節是要介紹《log4j多環境不同日誌級別的控制的》但是沒有這篇文章做基礎的話，學習起來還是有點難度的，所以我們先一起了解下spring boot屬性檔案之多環境配置，當然文章中也會提到屬性檔案基本的一些知識，然後慢慢在昇華到多環境配置。
相信很多人選擇SpringBoot主要是考慮到它既能兼顧Spring的強大功能，還能實現快速開發的便捷。我們在Spring Boot使用過程中，最直觀的感受就是沒有了原來自己整合Spring應用時繁多的XML配置內容，替代它的是在pom.properties
在之前的各篇文章中都有提及關於application.properties的使用，主要用來配置資料庫連線、日誌相關配置等。除了這些配置內容之外，本文將具體介紹一些在application.properties配置中的其他特性和使用方法。
自定義屬性與載入
這方面的知識我們在之前一篇文章
中就已經有介紹過了，這裡也當做溫故下吧，當然重點還是之後的多環境配置檔案。
我們在使用SpringBoot的時候，通常也需要定義一些自己使用的屬性，我們可以如下方式直接定義：
在src/main/resources/application.properties：加入：
#自定義屬性.
com.kfit.blog.name= Angel
com.kfit.blog.title=Spring Boot教程
然後通過@Value("${屬性名}")註解來載入對應的配置屬性，具體如下：
（以下這種方式已經過時了，不推薦使用，但能正常執行的）。
@Component
publicclass BlogProperties {
@Value("${com.kfit.blog.name}")
private Stringname;//部落格作者
@Value("${com.kfit.blog.title}")
private Stringtitle;//部落格標題
// 省略getter和setter
}
通過單元測試來驗證BlogProperties中的屬性是否已經根據配置檔案載入了。
引入單元測試依賴：
<!-- spring boot單元測試. -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
進行編碼進行單元測試：
package com.kfit;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
importorg.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import com.kfit.properties.BlogProperties;
/**
*
*@author Angel(QQ:412887952)
*@version v.0.1
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(App.class)
publicclass AppTest{
@Autowired
private BlogPropertiesblogProperties;
@Test
publicvoid testBlog()throws Exception {
System.out.println("AppTest.testBlog()="+blogProperties);
Assert.assertEquals("Angel",blogProperties.getName());
Assert.assertEquals("SpringBoot教程",blogProperties.getTitle());
}
}
執行單元測試，完美的看到我們想要的結果了，但是我們剛剛提到了BlogProperties寫法已經不推薦使用了，那麼怎麼寫會比較perfect呢？看如下優雅的編碼風格：
先引入spring boot提供的一個配置依賴：
<!--spring boot配置處理器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
在這裡我們主要使用@ConfigurationProperties註解進行編碼，
修改BlogProperties為：
/**
* prefix="com.kfit.blog"：
*
*在application.properties配置的屬性字首，
*
*在類中的屬性就不用使用{@value}進行注入了。
*
*@author Angel(QQ:412887952)
*@version v.0.1
*/
@ConfigurationProperties(prefix="com.kfit.blog")
publicclass BlogProperties {
private Stringname;//部落格作者
private Stringtitle;//部落格標題
// 省略getter和setter
}
在啟動類中加入：
@EnableConfigurationProperties({BlogProperties.class})
在執行單元測試還是能夠正常進行的。
這種的好處就是隻需要配置一個地方，其它地方就是正常定義類的屬性即可了。
引數間的引用
在application.properties中的各個引數之間也可以直接引用來使用，就像下面的設定：
com.kfit.blog.desc=${com.kfit.blog.name}正在寫《${com.kfit.blog.title}》
com.kfit.blog.desc引數引用了上文中定義的name和title屬性，最後該屬性的值就是Angel正在努力寫《SpringBoot教程》。
使用隨機數
在一些情況下，有些引數我們需要希望它不是一個固定的值，比如金鑰、服務埠等。Spring Boot的屬性配置檔案中可以通過${random}來產生int值、long值或者string字串，來支援屬性的隨機值。
#隨機字串
com.kfit.blog.value=${random.value}
#隨機int
com.kfit.blog.number=${random.int}
#隨機long
com.kfit.blog.bignumber=${random.long}
# 10以內的隨機數
com.kfit.blog.test1=${random.int(10)}
# 10-20的隨機數
com.kfit.blog.test2=${random.int[10,20]}
通過命令列設定屬性值
相信使用過一段時間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)。
在Eclipse中具體操作如下：
【右鍵工程】--【Run As】 -- 【Runconfigurations】--找到【Arguments】--【Program arguments】-- 新增【--server.port=8888】
多環境配置
以上都不是重點，這才是重點，這才是重點，這才是重點，重要的事情說3遍。我們在開發SpringBoot應用時，通常同一套程式會被應用和安裝到幾個不同的環境，比如：開發、測試、生產等。其中每個環境的資料庫地址、伺服器埠等等配置都會不同，如果在為不同環境打包時都要頻繁修改配置檔案的話，那必將是個非常繁瑣且容易發生錯誤的事。
對於多環境的配置，各種專案構建工具或是框架的基本思路是一致的，通過配置多份不同環境的配置檔案，再通過打包命令指定需要打包的內容之後進行區分打包，Spring Boot也不例外，或者說更加簡單。
在Spring Boot中多環境配置檔名需要滿足application-{profile}.properties的格式，其中{profile}對應你的環境標識，比如：
· application-dev.properties：開發環境
· application-test.properties：測試環境
· application-prod.properties：生產環境
至於哪個具體的配置檔案會被載入，需要在application.properties檔案中通過spring.profiles.active屬性來設定，其值對應{profile}值。
如：spring.profiles.active=test就會載入application-test.properties配置檔案內容
下面，以不同環境配置不同的服務埠為例，進行樣例實驗。
· 針對各環境新建不同的配置檔案application-dev.properties、application-test.properties、application-prod.properties
· 在這三個檔案均都設定不同的server.port屬性，如：dev環境設定為1111，test環境設定為2222，prod環境設定為3333
· application.properties中設定spring.profiles.active=dev，就是說預設以dev環境設定
· 測試不同配置的載入
o 執行java -jar xxx.jar，可以觀察到服務埠被設定為1111，也就是預設的開發環境（dev）
o 執行java -jar xxx.jar --spring.profiles.active=test，可以觀察到服務埠被設定為2222，也就是測試環境的配置（test）
o 執行java -jar xxx.jar--spring.profiles.active=prod，可以觀察到服務埠被設定為3333，也就是生產環境的配置（prod）
按照上面的實驗，可以如下總結多環境的配置思路：
· application.properties中配置通用內容，並設定spring.profiles.active=dev，以開發環境為預設配置
· application-{profile}.properties中配置各個環境不同的內容
· 通過命令列方式去啟用不同環境的配置
多環境高階應用
在某些情況下，應用的某些業務邏輯可能需要有不同的實現。例如郵件服務，假設EmailService中包含的send(String
email)方法向指定地址傳送電子郵件，但是我們僅僅希望在生產環境中才執行真正傳送郵件的程式碼，而開發環境裡則不傳送以免向用戶傳送無意義的垃圾郵件。
我們可以藉助Spring的註解@Profile實現這樣的功能，這樣需要定義兩個實現EmailService藉口的類：
/**
*傳送郵件介面.
*@author Angel(QQ:412887952)
*@version v.0.1
*/
publicinterface EmailService {
/**傳送郵件*/
publicvoid send();
}
傳送郵件的具體實現（dev-開發環境的程式碼）：
@Service
@Profile("dev")//開發環境的時候.
publicclass DevEmailServiceImplimplements EmailService{
@Override
publicvoid send() {
System.out.println("DevEmailServiceImpl.send().開發環境不執行郵件的傳送.");
}
}
傳送郵件的具體實現（prod-生產環境的程式碼）：
@Service
@Profile("prod")//生產環境.
publicclass ProdEmailServiceImpl2implements EmailService{
@Override
publicvoid send() {
System.out.println("DevEmailServiceImpl.send().生產環境執行郵件的傳送.");
//具體的郵件傳送程式碼.
//mail.send();
}
}
@Profile("dev")表明只有Spring定義的Profile為dev時才會例項化DevEmailService這個類。那麼如何設定Profile呢？
在配置檔案中指定
在application.properties中加入：
spring.profiles.active=dev
通過命令列引數
java -jar app.jar --spring.profiles.active=dev
多環境tomcat配置：
#將下面引數放在JVM中,如果是TOMCAT則放在catalina.sh
#開發:
JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=dev "
#測試:
JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=test "
#如果是ECLIPSE中啟動TOMCAT，則只需加
-Dspring.profiles.active=dev