Spring Boot @Conditional注解使用示例詳解

更新時間：2024年12月31日 11:16:05 作者：山高自有客行路

在SpringBoot中,@Conditional注解用于條件性地注冊bean,根據(jù)某些條件決定是否創(chuàng)建特定bean,可以實現(xiàn)Condition接口并重寫matches方法來定義條件,本文介紹Spring Boot @Conditional注解的相關(guān)知識,感興趣的朋友一起看看吧

在Spring Boot中，@Conditional 注解用于條件性地注冊bean。這意味著它可以根據(jù)某些條件來決定是否應(yīng)該創(chuàng)建一個特定的bean。這個注解可以放在配置類或方法上，并且它會根據(jù)提供的一組條件來判斷是否應(yīng)該實例化對應(yīng)的組件。

要使用 @Conditional注解時，需要實現(xiàn) Condition 接口并重寫 matches 方法。此方法將返回一個布爾值以指示條件是否匹配。如果條件為真，則創(chuàng)建bean；否則跳過該bean的創(chuàng)建。

以下是一個簡單的例子，展示了如何使用自定義條件：

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class MyCustomCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 在這里添加你的條件邏輯
        // 例如，檢查系統(tǒng)屬性、環(huán)境變量、已經(jīng)存在的beans等
        return false; // 根據(jù)條件邏輯返回true或false
    }
}

ConditionContext：提供了對當(dāng)前解析上下文的訪問，包括：
- Environment：可以用來獲取環(huán)境變量、系統(tǒng)屬性等。
- BeanFactory：如果可用的話，可以通過它訪問已經(jīng)注冊的bean。
- ClassLoader：可以用來檢查類路徑上的類是否存在。
- EvaluationContext：可以用來評估SpEL表達(dá)式。
AnnotatedTypeMetadata 提供了對帶有注解的方法或類元數(shù)據(jù)的訪問，例如注解屬性值。

自定義條件類

假設(shè)我們有一個應(yīng)用程序，它應(yīng)該根據(jù)操作系統(tǒng)的不同來決定是否加載特定的bean。我們可以創(chuàng)建一個名為 OnWindowsCondition 的條件類：

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class OnWindowsCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return "win".equals(context.getEnvironment().getProperty("os.name").toLowerCase().substring(0, 3));
    }
}

然后在配置類中使用：

@Configuration
public class MyConfig {
    @Bean
    @Conditional(OnWindowsCondition.class)
    public WindowsSpecificService windowsSpecificService() {
        return new WindowsSpecificServiceImpl();
    }
}

Spring Boot提供內(nèi)置條件注解

@ConditionalOnProperty

當(dāng)你希望基于配置文件中的屬性是否存在或者具有特定值來創(chuàng)建bean時，可以使用 @ConditionalOnProperty 注解。例如：

@Configuration
public class MyConfig {
    @Bean
    @ConditionalOnProperty(name = "my.feature.enabled", havingValue = "true")
    public MyFeature myFeature() {
        return new MyFeature();
    }
}

在這個例子中，只有當(dāng)配置文件中存在名為 my.feature.enabled 的屬性且其值為 true 時，才會創(chuàng)建 MyFeature bean。

更多用法

prefix：指定屬性名前綴。
name：指定屬性名（可以是數(shù)組，表示多個屬性）。
havingValue：指定屬性必須具有的值，默認(rèn)為空字符串。
matchIfMissing：如果未找到屬性，則默認(rèn)匹配與否，默認(rèn)為 false。

例如，你可以這樣配置：

@Bean
@ConditionalOnProperty(prefix = "app", name = "feature.enabled", havingValue = "true", matchIfMissing = false)
public FeatureService featureService() {
    return new FeatureServiceImpl();
}

這將確保只有在 app.feature.enabled=true 時才會創(chuàng)建 FeatureService bean；如果沒有設(shè)置該屬性且 matchIfMissing=false，則不會創(chuàng)建。

@ConditionalOnClass 和 @ConditionalOnMissingClass

這兩個注解用于檢查類路徑下是否存在或不存在某些類。這在集成第三方庫時非常有用，因為你可以有條件地注冊與這些庫相關(guān)的bean。例如：

@Configuration
@ConditionalOnClass(name = "com.example.ExternalLibraryClass")
public class ExternalLibraryConfig {
    // ...
}

如果類路徑中存在 ExternalLibraryClass 類，則會應(yīng)用此配置。

@ConditionalOnBean 和 @ConditionalOnMissingBean

這些注解用于根據(jù)上下文中是否存在指定類型的bean來決定是否創(chuàng)建新的bean。這對于確保不會重復(fù)注冊相同功能的bean非常有用。

@Bean
@ConditionalOnMissingBean(MyService.class)
public MyService myService() {
    return new MyServiceImpl();
}

這里的意思是：如果上下文中還沒有類型為 MyService 的bean，則創(chuàng)建一個新的 MyServiceImpl 實例并注冊為bean。

使用 SpEL 表達(dá)式的 @ConditionalOnExpression

可以通過 @ConditionalOnExpression 來編寫復(fù)雜的條件表達(dá)式。例如，基于多個屬性組合或者環(huán)境變量來決定是否創(chuàng)建bean。

@Bean
@ConditionalOnExpression("${spring.application.name:'default'} == 'myapp' && ${env:dev} == 'prod'")
public ProdSpecificBean prodSpecificBean() {
    return new ProdSpecificBean();
}

這段代碼意味著只有當(dāng)應(yīng)用程序名稱為 'myapp' 并且環(huán)境變量 env 設(shè)置為 'prod' 時，才會創(chuàng)建 ProdSpecificBean。

使用場景

動態(tài)條件評估

有時你可能需要在應(yīng)用啟動后根據(jù)某些變化（如用戶輸入或外部服務(wù)的狀態(tài)）來動態(tài)調(diào)整bean的行為。雖然 @Conditional 主要用于啟動時的靜態(tài)條件判斷，但你可以通過結(jié)合其他機(jī)制（如事件監(jiān)聽器、定時任務(wù)等）來實現(xiàn)類似的效果。

@Configuration
public class DynamicConditionConfig {
    private final AtomicBoolean shouldCreateBean = new AtomicBoolean(false);
    @Bean
    @ConditionalOnProperty(name = "dynamic.bean.enabled", havingValue = "true")
    public MyDynamicBean myDynamicBean() {
        return () -> shouldCreateBean.get();
    }
    // 模擬外部觸發(fā)更新條件狀態(tài)的方法
    public void updateCondition(boolean value) {
        shouldCreateBean.set(value);
    }
}

在這個例子中，MyDynamicBean 的行為依賴于一個原子布爾變量 shouldCreateBean，該變量可以在運(yùn)行時被更改，從而影響bean的行為。

條件化的AOP切面

你還可以將條件應(yīng)用于AOP切面，以實現(xiàn)更加靈活的橫切關(guān)注點管理。例如：

@Aspect
@ConditionalOnProperty(name = "app.logging.enabled", havingValue = "true")
public class LoggingAspect {
    @Around("execution(* com.example.service.*.*(..))")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();
        Object proceed = joinPoint.proceed();
        long executionTime = System.currentTimeMillis() - start;
        System.out.println(joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + " executed in " + executionTime + "ms");
        return proceed;
    }
}

這段代碼表示只有當(dāng) app.logging.enabled=true 時才會激活日志記錄切面。

使用 @Profile 和 @Conditional 結(jié)合

有時候，你可能想要結(jié)合 @Profile 和 @Conditional 來創(chuàng)建更精細(xì)的條件邏輯。例如：

@Configuration
@Profile("dev")
public class DevConfig {
    @Bean
    @ConditionalOnProperty(name = "feature.x.enabled", havingValue = "true")
    public FeatureX featureX() {
        return new FeatureXImpl();
    }
}

這里的意思是：僅在開發(fā)環(huán)境（dev profile）并且 feature.x.enabled=true 時才創(chuàng)建 FeatureX bean。

條件化代理

對于那些需要延遲初始化或者懶加載的bean，可以考慮使用 @Scope("proxy") 和 @Lazy 注解，結(jié)合 @Conditional 來實現(xiàn)條件化代理。

@Bean
@Scope(proxyMode = ScopedProxyMode.TARGET_CLASS)
@Lazy
@ConditionalOnProperty(name = "lazy.init.feature", havingValue = "true")
public LazyInitFeature lazyInitFeature() {
    return new LazyInitFeatureImpl();
}

這確保了只有在滿足條件且首次訪問 lazyInitFeature bean時才會實例化它。

調(diào)試技巧

使用 @PostConstruct 和 @PreDestroy 監(jiān)控bean生命周期

為了更好地理解哪些bean被創(chuàng)建或銷毀，可以在bean類中添加 @PostConstruct 和 @PreDestroy 方法，并輸出日志信息。

@Component
@ConditionalOnProperty(name = "feature.y.enabled", havingValue = "true")
public class FeatureY {
    @PostConstruct
    public void init() {
        System.out.println("FeatureY initialized.");
    }
    @PreDestroy
    public void destroy() {
        System.out.println("FeatureY destroyed.");
    }
}

這種方法有助于跟蹤bean的生命周期，并確認(rèn)條件是否按預(yù)期工作。

使用 spring.main.banner-mode=off 減少干擾

當(dāng)你專注于調(diào)試條件邏輯時，關(guān)閉Spring Boot啟動橫幅可以幫助減少不必要的輸出，使日志更加清晰。

spring.main.banner-mode=off

常見問題

環(huán)境屬性未正確加載

如果發(fā)現(xiàn)條件注解沒有按照預(yù)期工作，請檢查是否正確加載了環(huán)境屬性文件（如 application.properties 或 application.yml）。確保這些文件位于正確的路徑下，并且包含所需的屬性定義。

類路徑?jīng)_突

當(dāng)遇到條件注解不起作用的問題時，類路徑?jīng)_突是一個常見的原因。特別是當(dāng)你使用 @ConditionalOnClass 或 @ConditionalOnMissingClass 時，確保項目中不存在重復(fù)的依賴項。你可以使用Maven或Gradle命令來分析依賴樹：

Maven:

mvn dependency:tree

Gradle:

gradle dependencies

條件邏輯錯誤

仔細(xì)審查你的條件邏輯，確保它們符合預(yù)期?？梢酝ㄟ^單元測試驗證每個條件的行為。例如：

@Test
void testFeatureYEnabled() {
    ApplicationContextRunner runner = new ApplicationContextRunner()
        .withPropertyValues("feature.y.enabled=true");
    runner.run(context -> assertThat(context).hasSingleBean(FeatureY.class));
}
@Test
void testFeatureYDisabled() {
    ApplicationContextRunner runner = new ApplicationContextRunner()
        .withPropertyValues("feature.y.enabled=false");
    runner.run(context -> assertThat(context).doesNotHaveBean(FeatureY.class));
}