spring-boot實戰【08】【轉】：Spring Boot屬性設定檔詳解

標籤：過程   long   osc   感受   應用   tle   隨機   red   oschina   

相信很多人選擇Spring Boot主要是考慮到它既能兼顧Spring的強大功能，還能實現快速開發的便捷。我們在Spring Boot使用過程中，最直觀的感受就是沒有了原來自己整合Spring應用時繁多的XML配置內容，替代它的是在pom.xml中引入模組化的Starter POMs，其中各個模組都有自己的預設配置，所以如果不是特殊應用情境，就只需要在application.properties中完成一些屬性配置就能開啟各模組的應用。

在之前的各篇文章中都有提及關於application.properties的使用，主要用來設定資料庫串連、日誌相關配置等。除了這些配置內容之外，本文將具體介紹一些在application.properties配置中的其他特性和使用方法。

自訂屬性與載入

我們在使用Spring Boot的時候，通常也需要定義一些自己使用的屬性，我們可以如下方式直接定義：

12	com.didispace.blog.name=程式猿DDcom.didispace.blog.title=Spring Boot教程

然後通過@Value("${屬性名稱}")註解來載入對應的配置屬性，具體如下：

1234567891011

@Componentpublic class BlogProperties { @Value("${com.didispace.blog.name}")private String name;@Value("${com.didispace.blog.title}")private String title; // 省略getter和setter }

按照慣例，通過單元測試來驗證BlogProperties中的屬性是否已經根據設定檔載入了。

123456789101112131415

@RunWith(SpringJUnit4ClassRunner.class)@SpringApplicationConfiguration(Application.class)public class ApplicationTests { @Autowiredprivate BlogProperties blogProperties;  @Testpublic void getHello() throws Exception {Assert.assertEquals(blogProperties.getName(), "程式猿DD");Assert.assertEquals(blogProperties.getTitle(), "Spring Boot教程");} }

參數間的引用

在application.properties中的各個參數之間也可以直接引用來使用，就像下面的設定：

123	com.didispace.blog.name=程式猿DDcom.didispace.blog.title=Spring Boot教程com.didispace.blog.desc=${com.didispace.blog.name}正在努力寫《${com.didispace.blog.title}》

com.didispace.blog.desc參數引用了上文中定義的name和title屬性，最後該屬性的值就是程式猿DD正在努力寫《Spring Boot教程》。

使用隨機數

在一些情況下，有些參數我們需要希望它不是一個固定的值，比如密鑰、服務連接埠等。Spring Boot的屬性設定檔中可以通過${random}來產生int值、long值或者string字串，來支援屬性的隨機值。

12345678910

# 隨機字串com.didispace.blog.value=${random.value}# 隨機intcom.didispace.blog.number=${random.int}# 隨機longcom.didispace.blog.bignumber=${random.long}# 10以內的隨機數com.didispace.blog.test1=${random.int(10)}# 10-20的隨機數com.didispace.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)。

多環境配置

我們在開發Spring Boot應用時，通常同一套程式會被應用和安裝到幾個不同的環境，比如：開發、測試、生產等。其中每個環境的資料庫地址、伺服器連接埠等等配置都會不同，如果在為不同環境打包時都要頻繁修改設定檔的話，那必將是個非常繁瑣且容易發生錯誤的事。

對於多環境的配置，各種項目構建工具或是架構的基本思路是一致的，通過配置多份不同環境的設定檔，再通過打包命令指定需要打包的內容之後進行區分打包，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環境設定

• 測試不同配置的載入

  • 執行java -jar xxx.jar，可以觀察到服務連接埠被設定為1111，也就是預設的開發環境（dev）
  • 執行java -jar xxx.jar --spring.profiles.active=test，可以觀察到服務連接埠被設定為2222，也就是測試環境的配置（test）
  • 執行java -jar xxx.jar --spring.profiles.active=prod，可以觀察到服務連接埠被設定為3333，也就是生產環境的配置（prod）

按照上面的實驗，可以如下總結多環境的配置思路：

• application.properties中配置通用內容，並設定spring.profiles.active=dev，以開發環境為預設配置
• application-{profile}.properties中配置各個環境不同的內容
• 通過命令列方式去啟用不同環境的配置

完整樣本chapter2-1-1

spring-boot實戰【08】【轉】：Spring Boot屬性設定檔詳解