Spring Boot conditional註解用法詳解
1、conditional註解介紹
含義: 基於條件的註解
作用: 根據是否滿足某一個特定條件來決定是否建立某個特定的bean
意義: Springboot實現自動配置的關鍵基礎能力
2、常見conditional註解
@ConditionalOnBean 框架中存在某個Bean時生效
@ConditionalOnMissingBean 在Bean不存在時生效
@ConditionalOnClass框架中存在某個Class時生效
@ConditionalOnMissingClass在Class不存在時生效
@ConditionalOnWebApplication 當前是web環境
@ConditionalOnNotWebApplication 當前不是web環境
@ConditionalOnProperty 當前框架中是否包含特定的屬性
@ConditionalOnJava 當前是否存在某個Java版本
3、Conditional的使用
1) 建立A.java,增加註解ConditionalOnProperty,表示系統中有這個屬性才例項化A
@Component @ConditionalOnProperty("com.example.condition") public class A { }
2) 建立測試類
@RunWith(SpringRunner.class) @SpringBootTest @Import(MyBeanImport.class) public class ConditionTest implements ApplicationContextAware { private ApplicationContext applicationContext; @Test public void testA() { System.out.println(applicationContext.getBean(A.class)); } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } }
3、執行測試類
丟擲異常,表示沒有找到A這個類。
然後在application.properties檔案中增加屬性
再次執行測試。成功。
4、A類中有個註解ConditionOnProperty
1) 進入註解ConditionOnProperty。裡面有一個@Conditional註解
2) 進入@Conditional註解。裡面的value是Class型別,並且繼承自Condition介面
3) 進入Condition介面。裡面只有一個方法。當這個方法返回true時,這個bean才會注入到容器當中。
5、自定義Conditional 註解
1) 建立MyCondition類。實現Condition介面重寫matches方法,符合條件返回true
public class MyCondition implements Condition { @Override public boolean matches(ConditionContext context,AnnotatedTypeMetadata metadata) { String[] properties = (String[]) metadata .getAnnotationAttributes("com.example.demo.condi.MyConditionAnnotation") .get("value"); for(String property : properties){ if(StringUtils.isEmpty(context.getEnvironment().getProperty(property))){ return false; } } return true; } }
2) 建立註解MyConditionAnnotation ,並且引入Conditional註解,引入MyCondition類
@Target({ElementType.TYPE,ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional({MyCondition.class}) public @interface MyConditionAnnotation { String[] value() default {}; }
3) 建立類AA使用註解MyConditionAnnotation
@Component @MyConditionAnnotation({"com.example.condition1","com.example.condition2"}) public class AA { }
4) 測試
a) 此時並沒有com.example.condition1和com.example.condition2這兩個屬性值,所有測試失敗
b) 然後增加這兩個屬性。
測試成功
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。