Spring Boot 詳解配置文件
1. 前言
Spring Boot 可以在零配置的情況下使用，但是不代表 Spring Boot 完全不需要配置文件。
舉一個簡單的例子， Spring Boot 開發的 Web 項目默認的啟動端口是 8080 。如果我們想更換啟動端口，通過配置文件去修改是比較好的。如果放到代碼中，修改一個端口都要重新編譯下程序，豈不煩哉？
配置文件不是必須的，但是如果想實現一些個性化的功能，還是需要用到配置文件的。本篇就講下 Spring Boot 中使用配置文件的常用場景。
2. 構建演示 Web 項目
為了便于演示，我們先構建一個 Web 項目。
2.1 使用 Spring Initializr 構建一個 Spring Boot 應用
Spring Boot 版本選擇 2.2.5 ， Group 為 com.5axxw ， Artifact 為 spring-boot-profile ，生成項目后導入 Eclipse 開發環境。
2.2 修改 pom.xml
引入 Web 項目依賴，同時開啟熱部署便于修改測試。
實例：
<!-- 熱部署 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
<!-- web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
2.3 編寫控制器用于測試
實例：
@RestController // 標注為控制器，且返回值序列化為json
public class HelloController {
@GetMapping("/hello") // 響應get請求，匹配的請求路徑為/hello
public Map hello() {
Map<String, String> map = new HashMap<String, String>();
map.put("test", "content for test");
return map;
}
}
2.4 啟動項目
訪問 http://127.0.0.1:8080/hello ，效果如下：
3. 修改項目啟動配置
我們運行啟動類，啟動 spring-boot-profile 應用，控制臺會發現如下提示：
Tomcat started on port(s): 8080 (http) with context path ''
可以看出， Spring Boot 應用默認啟動端口是 8080 ，默認項目路徑是空。
我們可以通過修改 resources/application.properties 來自定義項目啟動配置:
實例：
# 啟動端口
server.port=8000
# 項目路徑
server.servlet.context-path=/spring-boot-profile
再次啟動應用，控制臺提示變為：
Tomcat started on port(s): 8000 (http) with context path '/spring-boot-profile'
此時項目對應的訪問路徑為： http://127.0.0.1:8000/spring-boot-profile , 使用瀏覽器訪問效果如下：
4. 配置文件格式
Spring Boot 支持兩種格式的配置文件，即 .properties 文件和 .yml 配置文件。
上面的配置使用 .yml 則為：
實例：
server:
port: 8000
servlet:
context-path: /spring-boot-profile
.properties 配置使用頓號分割語義，而 .yml 配置使用縮進分割語義。這兩種配置文件沒有本質區別，只是格式不同。
5. 自定義配置項
我們還可以在配置文件中使用自定義配置，例如我們開發了一個微信公眾號后臺應用，需要在程序中配置公眾號的 appid 和 secret 。
配置文件如下：
實例：
# 公眾號appid
wxmp.appid=111
# 公眾號secret
wxmp.secret=222
我們定義一個組件，通過 @Value 注解注入配置項的值。
實例：
/**
* 微信公眾號參數
*/
@Component//注冊為組件
public class WxMpParam {
@Value("${wxmp.appid}")//注入wxmp.appid配置項
private String appid;
@Value("${wxmp.secret}")//注入wxmp.secret配置項
private String secret;
//省略get set方法
}
通過控制器測試配置項是否注入成功。
實例：
@RestController
public class HelloController {
@Autowired
private WxMpParam wxMpParam;
@GetMapping("/hello")
public Map hello() {
Map<String, String> map = new HashMap<String, String>();
map.put("appid",wxMpParam.getAppid());
map.put("secret",wxMpParam.getSecret());
return map;
}
}
此時我們訪問 http://127.0.0.1:8000/spring-boot-profile/hello ，瀏覽器顯示如下，說明我們的配置注入成功。
6. 配置項自動注入對象
如果參數很多，一一指定對象屬性和配置項的關聯非常麻煩。可以通過設定對象與配置項的對應關系，來實現配置項的自動注入。
實例：
@Component // 注冊為組件
@EnableConfigurationProperties // 啟用配置自動注入功能
@ConfigurationProperties(prefix = "wxmp") // 指定類對應的配置項前綴
public class WxMpParam {
private String appid;// 對應到wxmp.appid
private String secret; // 對應到wxmp.secret
//省略 get set
}
在上面的代碼中，通過 prefix = "wxmp" 指定了關聯配置的前綴，屬性 appid 即關聯到前綴 + 屬性名為 wxmp.appid 的配置項。同理，屬性 secret 關聯到 wxmp.secret 配置項。
7. 在配置文件中使用隨機數
配置文件中使用隨機數也是比較常見的場景，尤其啟動多個客戶端時，希望指定一個啟動端口的范圍，例如 10 - 20 ，可配置如下：
實例：
# 配置端口為1-20間的隨機數
server.port=${random.int[10,20]}
這樣我可以連續啟動四個客戶端，啟動端口分別是 12 、 13 、 17 、 19 ，可見是隨機的，而且在我指定的范圍內波動。
8. 自定義配置文件
有時候參數太多，都放到一個配置文件中太亂了，我們會希望將配置分到不同文件中，然后每個文件保存不同配置。
例如上面微信公眾號配置，我們單獨建立一個 wxmp.properties 文件，內容如下：
實例：
# wxmp.properties配置文件
# 公眾號的appid
wxmp.appid=111
# 公眾號的secret
wxmp.secret=222
WxMpParam 代碼如下：
實例：
/**
* 微信公眾號參數
*/
@Component // 注冊為組件
@PropertySource(value = "classpath:wxmp.properties", encoding = "utf-8") // 指定配置文件及編碼
public class WxMpParam {
@Value("${wxmp.appid}")
private String appid;
@Value("${wxmp.secret}")
private String secret;
}
9. 配置項引用
Spring Boot 配置項是可以引用其他配置項的值的，這個稍微提一下，例如：
實例：
# wxmp.properties
# 公眾號的appid
wxmp.appid=111
# 公眾號的secret,值為111222
wxmp.secret=${wxmp.appid}222
10. 小結
對一個 Spring Boot 應用而言。
-
如果配置項比較少，直接全部寫在
application.properties。 -
如果配置項很多，可以劃分為若干配置文件。
-
如果很多自定義配置擁有相同的前綴，可以指定前綴，讓配置項自動注入對象中。
-
Spring Boot 提供了多變的配置文件使用機制，我們根據具體場景靈活使用即可。
如果配置項比較少，直接全部寫在 application.properties 。
如果配置項很多，可以劃分為若干配置文件。
如果很多自定義配置擁有相同的前綴，可以指定前綴，讓配置項自動注入對象中。
Spring Boot 提供了多變的配置文件使用機制，我們根據具體場景靈活使用即可。
