知識庫 / Spring / Spring Boot RSS 訂閱

通過使用此服務，我們可以在運行時以編程方式更新應用程序中的任何屬性。

3.4. 使用 <em>PropertyUpdaterService</em> 的替代策略

雖然通過控制器直接暴露屬性更新功能在測試目的上很方便，但在生產環境中通常不安全。 當使用控制器進行測試時，我們應該確保它得到充分的保護，防止未經授權的訪問。

在生產環境中，有幾種安全有效使用 <em>PropertyUpdaterService</em> 的替代策略：

• 定時任務 → 屬性可能會根據時間敏感條件或外部數據源的變化而改變
• 基於條件邏輯 → 對特定應用程序事件或觸發器做出響應，例如負載變化、用户活動或外部 API 響應
• 受限訪問工具 → 僅供授權人員訪問的安全管理工具
• 自定義 actuator 端點 → 自定義 actuator 提供了對暴露功能的更多控制，並可以包含額外的安全措施
• 應用程序事件監聽器 → 在雲環境中非常有用，其中實例可能需要根據基礎設施的變化或其他應用程序中的重大事件來調整設置

關於內置的 /actuator/refresh 端點，雖然它刷新了帶有 @RefreshScope 註解的 Bean，但它不會直接更新屬性。我們可以使用 <em>PropertyUpdaterService</em> 編程方式添加或修改屬性，然後觸發 /actuator/refresh 來在整個應用程序中應用這些更改。 但是，如果沒有 <em>PropertyUpdaterService</em>，這個 actuator 無法更新或添加新的屬性。

總而言之，我們選擇的方法應該與應用程序的特定要求、配置數據的敏感性和整體安全態勢相一致。

3.5. 使用控制器手動測試

這裏演示瞭如何使用一個簡單的控制器來測試 <em >PropertyUpdaterService</em> 的功能。

@RestController
@RequestMapping("/properties")
public class PropertyController {
    @Autowired
    private PropertyUpdaterService propertyUpdaterService;

    @Autowired
    private ExampleBean exampleBean;

    @PostMapping("/update")
    public String updateProperty(@RequestParam String key, @RequestParam String value) {
        propertyUpdaterService.updateProperty(key, value);
        return "Property updated. Remember to call the actuator /actuator/refresh";
    }

    @GetMapping("/customProperty")
    public String getCustomProperty() {
        return exampleBean.getCustomProperty();
    }
}

使用 curl 進行手動測試將允許我們驗證我們的實現是否正確：

$ curl "http://localhost:8080/properties/customProperty"
defaultValue

$ curl -X POST "http://localhost:8080/properties/update?key=my.custom.property&value=baeldungValue"
Property updated. Remember to call the actuator /actuator/refresh

$ curl -X POST http://localhost:8080/actuator/refresh -H "Content-Type: application/json"
[]

$ curl "http://localhost:8080/properties/customProperty"
baeldungValue

它按預期工作。但是，如果第一次嘗試失敗了，而且我們的應用程序非常複雜，我們應該再次嘗試最後一個命令，以便 Spring Cloud 有時間更新 Bean。

3.6. JUnit5 測試

自動化測試無疑很有幫助，但並非易事。由於 屬性更新操作是異步的，並且沒有 API 可以知道何時完成，因此我們需要使用超時機制，以避免阻塞 JUnit5。之所以是異步，是因為調用 /actuator/refresh 立即返回，而不會等待所有 Bean 真正被重新創建。

await 語句 能夠幫助我們避免使用複雜的邏輯來測試我們感興趣的 Bean 刷新。它允許我們避免不太優雅的設計，例如輪詢。

最後，為了使用 RestTemplate，我們需要按照 @SpringBootTest(…) 註解中指定的，請求啓動 Web 環境：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PropertyUpdaterServiceUnitTest {
    @Autowired
    private PropertyUpdaterService propertyUpdaterService;

    @Autowired
    private ExampleBean exampleBean;

    @LocalServerPort
    private int port;

    @Test
    @Timeout(5)
    public void whenUpdatingProperty_thenPropertyIsUpdatedAndRefreshed() throws InterruptedException {
        // Injects a new property into the test context
        propertyUpdaterService.updateProperty("my.custom.property", "newValue");

        // Trigger the refresh by calling the actuator endpoint
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        HttpEntity<String> entity = new HttpEntity<>(null, headers);
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.postForEntity("http://localhost:" + port + "/actuator/refresh", entity, String.class);

        // Awaitility to wait until the property is updated
        await().atMost(5, TimeUnit.SECONDS).until(() -> "newValue".equals(exampleBean.getCustomProperty()));
    }
}

當然，我們需要自定義測試，包括所有我們感興趣的屬性和 Bean。

4. 使用外部配置文件

在某些場景下，為了管理應用程序部署包之外的配置更新，以確保屬性的持久性更改，需要使用外部配置。 這樣做也允許我們將更改分發到多個應用程序。

在這種情況下，我們將使用相同的先前 Spring Cloud 設置來啓用 <em @RefreshScope</em> 和 <em /actuator/refresh</em> 支持，以及相同的示例控制器和 Bean。