Spring Boot 配置檔案詳解:自定義屬性、隨機數、多環境配置等
相信很多人選擇Spring Boot主要是考慮到它既能兼顧Spring的強大功能,還能實現快速開發的便捷。我們在Spring Boot使用過程中,最直觀的感受就是沒有了原來自己整合Spring應用時繁多的XML配置內容,替代它的是在pom.xml
中引入模組化的Starter POMs
,其中各個模組都有自己的預設配置,所以如果不是特殊應用場景,就只需要在application.properties
中完成一些屬性配置就能開啟各模組的應用。
自定義屬性與載入
我們在使用Spring Boot的時候,通常也需要定義一些自己使用的屬性,我們可以如下方式直接定義:
czc.company.name=hangzhoucezhicheng
czc.employee.name=hly
然後通過@Value("${屬性名}")
註解來載入對應的配置屬性,具體如下:
@Data // lombok 實現get、set、toString等方法
@Component // 宣告為Spring管理的Bean
public class ConfigrationProperties {
@Value(value = "${czc.company.name}") //配置檔案的key
private String companyName;
@Value(value = "${czc.employee.name}") //配置檔案的keyprivate String employeeName;
}
通過單元測試來驗證BlogProperties中的屬性是否已經根據配置檔案載入了。
@SpringBootTest
@RunWith(SpringRunner.class)
public class ConfigrationPropertiesTest {
@Autowired
private ConfigrationProperties configrationProperties;
@Test
public void outProperties(){
System.out.println(configrationProperties.getCompanyName());
System.out.println( configrationProperties.getEmployeeName());
}
}
輸出:
引數間的引用
在application.properties
中的各個引數之間也可以直接引用來使用,就像下面的設定:
czc.company.name=hangzhoucezhicheng
czc.employee.name=hly
czc.all.names=${czc.company.name}公司的員工有${czc.employee.name}
czc.all.names引數引用了上文中定義的company.name和employee.name屬性,最後該屬性的值就是hangzhoucezhicheng公司的員工有hly
使用隨機數
在一些情況下,有些引數我們需要希望它不是一個固定的值,比如金鑰、服務埠等。Spring Boot的屬性配置檔案中可以通過${random}
來產生int值、long值或者string字串,來支援屬性的隨機值
如果配置檔案中的漢子出現亂碼:
File -> Settings -> Editor -> File Encodings
將Properties Files (*.properties)下的Default encoding for properties files設定為UTF-8,將Transparent native-to-ascii conversion前的勾選上。
@ConfigurationProperties(prefix = "XXX")使用
@Data
@Component
@ConfigurationProperties(prefix = "home") //配置檔案字首
public class ConfigrationProperties {
private String address;
private String employee;
}
application.properties
home.address=hz
home.employee=hly
通過命令列設定屬性值
相信使用過一段時間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
中配置各個環境不同的內容- 通過命令列方式去啟用不同環境的配置