ianhuang筆記THE ADVENTURER'S JOURNAL
知識世界・持續探索中

ADVENTURE JOURNAL · 探索筆記

ConditionalOnProperty:條件式 Bean 與測試

任務導覽 TABLE OF CONTENTS

清除 TODO 與過時註解屬性,完整示範存在、false、true 和缺值的行為。

適用:保留原 Spring/Spring Boot 歷史筆記;可重現練習統一採 Spring Boot 3.5.16、JDK 25 與 Maven,使用 jakarta 套件。編譯目標為 Java 25;上線仍需核對依賴及部署環境。

先備:先依 共用 Spring Boot 練習專案 建立 pom.xml 與 NoteApplication,再加入本文檔案。

最小配置

先建立 共用Spring專案 。新增src/main/java/notes/DemoConfig.java:

package notes;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@Configuration
public class DemoConfig {
    @Bean
    @ConditionalOnProperty(prefix = "notes", name = "demo", havingValue = "true", matchIfMissing = false)
    public String demoMessage() { return "demo enabled"; }
}

application.properties設notes.demo=true時bean存在;false或缺值時不存在,並非自動報錯。只有另一個bean強制依賴它且沒有替代才可能導致啟動失敗。

可執行測試

src/test/java/notes/DemoConfigTest.java:

package notes;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import static org.assertj.core.api.Assertions.assertThat;
class DemoConfigTest {
    private final ApplicationContextRunner runner = new ApplicationContextRunner().withUserConfiguration(DemoConfig.class);
    @Test void enabled() {
        runner.withPropertyValues("notes.demo=true").run(context -> assertThat(context).hasBean("demoMessage"));
    }
    @Test void disabled() {
        runner.withPropertyValues("notes.demo=false").run(context -> assertThat(context).doesNotHaveBean("demoMessage"));
    }
    @Test void missing() {
        runner.run(context -> assertThat(context).doesNotHaveBean("demoMessage"));
    }
}

mvn test -Dtest=DemoConfigTest應三個測試通過。

條件語意

沒指定havingValue時,預設屬性存在且值不是false才符合,不等於只能接受true。多個name需全部符合,prefix以點連線屬性名稱。集合屬性的索引不適合直接靠此條件推斷。舊範本的relaxedNames不是此練習版本可用屬性,已移除。

條件在建立context時判定,不是每次修改env就動態切換bean。用它控制示範資料或可選整合,避免把認證/授權的必要元件以易誤設旗標關掉。

參考資料

冒險者留言

comments powered by Disqus

搜尋筆記

輸入關鍵字,探索所有筆記。

ESC 關閉 · 搜尋標題、標籤與文章全文