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) 然后增加這兩個屬性。
測試成功
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持好吧啦網。
相關文章: