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

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

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

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

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

自定義條件類

假設我們有一個應用程序，它應該根據操作系統的不同來決定是否加載特定的bean。我們可以創建一個名為 OnWindowsCondition 的條件類：

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;public class OnWindowsCondition implements Condition {@Overridepublic 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提供內置條件注解

@ConditionalOnProperty

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

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

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

更多用法

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

例如，你可以這樣配置：

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

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

@ConditionalOnClass 和 @ConditionalOnMissingClass

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

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

如果類路徑中存在 ExternalLibraryClass 類，則會應用此配置。

@ConditionalOnBean 和 @ConditionalOnMissingBean

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

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

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

使用 SpEL 表達式的 @ConditionalOnExpression

可以通過 @ConditionalOnExpression 來編寫復雜的條件表達式。例如，基于多個屬性組合或者環境變量來決定是否創建bean。

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

這段代碼意味著只有當應用程序名稱為 'myapp' 并且環境變量 env 設置為 'prod' 時，才會創建 ProdSpecificBean。

使用場景

動態條件評估

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

@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();}// 模擬外部觸發更新條件狀態的方法public void updateCondition(boolean value) {shouldCreateBean.set(value);}
}

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

條件化的AOP切面

你還可以將條件應用于AOP切面，以實現更加靈活的橫切關注點管理。例如：

@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;}
}

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

使用?@Profile?和?@Conditional?結合

有時候，你可能想要結合 @Profile 和 @Conditional 來創建更精細的條件邏輯。例如：

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

這里的意思是：僅在開發環境（dev profile）并且 feature.x.enabled=true 時才創建 FeatureX bean。

條件化代理

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

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

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

調試技巧

使用?@PostConstruct?和?@PreDestroy?監控bean生命周期

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

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

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

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

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

spring.main.banner-mode=off

常見問題

環境屬性未正確加載

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

類路徑沖突

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

• Maven:

  mvn dependency:tree

• Gradle:

  gradle dependencies

條件邏輯錯誤

仔細審查你的條件邏輯，確保它們符合預期。可以通過單元測試驗證每個條件的行為。例如：

@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));
}

注意事項

• 條件注解只適用于Spring的配置階段，因此它們不能用于運行時決策。
• 當使用?@Conditional?或其他條件注解時，請確保你的條件邏輯不會導致循環依賴或意外的行為。
• 在編寫條件邏輯時，考慮到性能影響，盡量使條件判斷輕量級。