技巧！Spring Boot 動態刷新及實時監控配置文件的變化
環境：SpringBoot2.7.18 + SpringCloud2021.0.7
1. 簡介
在Spring Cloud微服務架構中，配置管理是至關重要的。隨著業務的發展和服務的不斷擴展，配置信息經常需要調整。如何動態地獲取這些變化，使服務能夠實時響應配置的更新，成為了關鍵問題。Spring Cloud提供了多種機制來實現配置的動態更新，使得開發人員能夠輕松地管理和應用這些變化。
本篇文章不會結合Nacos講解，將通過其它的方式手動的刷新配置及監聽配置文件的變化。
2. 實戰案例
2.1 依賴管理
<spring-cloud.version>2021.0.7</spring-cloud.version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>項目中主要是需要引入spring-cloud-context包，所以你可以根據需要隨便引入openfeign或者loadbalancer相應的包即可，只要環境中存在spring-cloud-context包就行了。本示例引入的是：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter</artifactId>
</dependency>該依賴中會自動引入commons和context。
2.2 開啟bootstrap配置
要啟動bootstrap配置（也就是默認的bootstrap.yml配置生效）有以下2中方式：
第一種：
引入下面依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>第二種：
啟動應用程序時添加如下參數
-Dspring.cloud.bootstrap.enabled=truebootstrap.yml配置文件生效關鍵是BootstrapApplicationListener監聽器。
部分代碼
public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
ConfigurableEnvironment environment = event.getEnvironment();
if (!bootstrapEnabled(environment) && !useLegacyProcessing(environment)) {
return;
}
// ...
}推薦第一種方式。
2.3 初始配置
bootstrap.yml配置內容如下
pack:
name: ooxx對應的屬性配置類
@Component("pp")
@ConfigurationProperties(prefix = "pack")
public class PackProperties {
private String name ;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}測試接口
@RestController
@RequestMapping("/pack")
public class PackController {
@Resource(name = "pp")
private PackProperties props ;
@GetMapping("")
public PackProperties p() {
return props ;
}
}
圖片
正確顯示配置信息。
如果你修改配置文件pack.name默認情況下是不會有任何變化的。要正確的使得配置文件實時更新，我們可以手動的觸發配置刷新動作。
觸發刷新動作
@Resource
private ContextRefresher contextRefresher ;
@GetMapping("/refresh")
public Object refresh() {
return this.contextRefresher.refresh() ;
}通過ContextRefresher#refresh方法會觸發2個核心動作：
- 重新初始化refresh作用域的bean對象
- @ConfigurationProperties注解的類（或方法@Bean）會重新初始化觸發EnvironmentChangeEvent事件。
修改配置文件內容如下：
pack:
name: ooxx調用上面/refresh接口后，無需重啟服務，配置信息已經動態刷新
圖片
上面的示例是需要對@ConfigurationProperties進行重寫綁定，所以我們可以通過監聽EnvironmentChangeEvent事件在程序中監聽配置的變化。
@Component
public class PackApplicationEventListener implements ApplicationListener<EnvironmentChangeEvent> {
@Resource
private Environment env ;
@Override
public void onApplicationEvent(EnvironmentChangeEvent event) {
System.out.println(event.getKeys()) ;
System.out.println(env.getProperty("pack.name")) ;
}
}當配置發生變化后，上面的監聽程序將被觸發。
控制臺輸出
[pack.name]
xxxooo
