您好,登錄后才能下訂單哦!
本文小編為大家詳細(xì)介紹“Spring Boot條件注解怎么用”,內(nèi)容詳細(xì),步驟清晰,細(xì)節(jié)處理妥當(dāng),希望這篇“Spring Boot條件注解怎么用”文章能幫助大家解決疑惑,下面跟著小編的思路慢慢深入,一起來學(xué)習(xí)新知識吧。
前言:
SpringBoot條件注解@Conditional,可用于根據(jù)某個特定的條件來判斷是否需要創(chuàng)建某個特定的Bean。SpringBoot自動配置功能里面就大量的使用了條件注解。接下來我們就對@Conditional的使用做一個簡單的介紹。
@Conditional注解需要和Condition接口搭配一起使用。通過對應(yīng)Condition接口來告知是否滿足匹配條件。
@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Conditional { /** * 所有用于匹配的Condition接口(實現(xiàn)該接口的類),只有這些類都返回true才認(rèn)為是滿足條件 */ Class<? extends Condition>[] value(); }
@Conditional注解可以添加在@Configuration、@Component、@Service等修飾的類上用于控制對應(yīng)的Bean是否需要創(chuàng)建,或者添加在@Bean修飾的方法上用于控制方法對應(yīng)的Bean是否需要創(chuàng)建。
@Conditional添加在@Configuration修飾的類上,用于控制該類和該類里面所有添加的@Bean方法對應(yīng)的Bean是否需要創(chuàng)建。
為了方便我們的使用Spring Boot對@Conditional條件注解做了一些擴展,提供了一些很實用的擴展性條件注解。
上面的擴展注解我們可以簡單的分為以下幾類:
Bean作為條件:@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnSingleCandidate。
類作為條件:@ConditionalOnClass、@ConditionalOnMissingClass。
SpEL表達(dá)式作為條件:@ConditionalOnExpression。
JAVA版本作為條件: @ConditionalOnJava
配置屬性作為條件:@ConditionalOnProperty。
資源文件作為條件:@ConditionalOnResource。
是否Web應(yīng)用作為判斷條件:@ConditionalOnWebApplication、@ConditionalOnNotWebApplication。
@ConditionalOnBean對應(yīng)的Condition處理類是OnBeanCondition。如果Spring容器里面存在指定的Bean則生效。
@ConditionalOnBean配置參數(shù)
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnBeanCondition.class) public @interface ConditionalOnBean { /** * 需要作為條件的類的Class對象數(shù)組 */ Class<?>[] value() default {}; /** * 需要作為條件的類的Name, Class.getName() */ String[] type() default {}; /** * (用于指定注解修飾的Bean)條件所需的注解類 */ Class<? extends Annotation>[] annotation() default {}; /** * Spring容器中Bean的名字 */ String[] name() default {}; /** * 搜索容器層級,當(dāng)前容器,父容器 */ SearchStrategy search() default SearchStrategy.ALL; /** * 可能在其泛型參數(shù)中包含指定Bean類型的其他類 */ Class<?>[] parameterizedContainer() default {}; }
@ConditionalOnMissingBean對應(yīng)的Condition實現(xiàn)類是OnBeanCondition。如果Spring容器里面不存在指定的Bean則生效。
@ConditionalOnMissingBean配置參數(shù)
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnBeanCondition.class) public @interface ConditionalOnMissingBean { /** * 需要作為條件的類的Class對象數(shù)組 */ Class<?>[] value() default {}; /** * 需要作為條件的類的Name, Class.getName() */ String[] type() default {}; /** * 匹配Bean的時候需要忽視的Class對象數(shù)組,一般是父類 * @ConditionalOnMissingBean(value = JdbcFactory.class, ignored = MySqlDefaultFactory.class) */ Class<?>[] ignored() default {}; /** * 匹配Bean的時候需要忽視的類的Name, Class.getName() */ String[] ignoredType() default {}; /** * (用于指定注解修飾的Bean)條件所需的注解類 */ Class<? extends Annotation>[] annotation() default {}; /** * Spring容器中Bean的名字 */ String[] name() default {}; /** * 搜索容器層級,當(dāng)前容器,父容器 */ SearchStrategy search() default SearchStrategy.ALL; /** * 可能在其泛型參數(shù)中包含指定Bean類型的其他類 */ Class<?>[] parameterizedContainer() default {}; }
比如如下的實例,當(dāng)容器里面不存在redisTemplate對應(yīng)的Bean的時候,就會創(chuàng)建一個RedisTemplate添加到容器里面去。
@Bean @ConditionalOnMissingBean(name = "redisTemplate") public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException { RedisTemplate<Object, Object> template = new RedisTemplate<>(); template.setConnectionFactory(redisConnectionFactory); return template; }
@ConditionalOnSingleCandidate對應(yīng)的Condition處理類是OnBeanCondition。如果當(dāng)指定Bean在容器中只有一個,或者雖然有多個但是指定首選Bean的時候則生效。
@ConditionalOnSingleCandidate配置參數(shù)
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnBeanCondition.class) public @interface ConditionalOnSingleCandidate { /** * 需要作為條件的類的Class對象 */ Class<?> value() default Object.class; /** * 需要作為條件的類的Name, Class.getName() */ String type() default ""; /** * 搜索容器層級,當(dāng)前容器,父容器 */ SearchStrategy search() default SearchStrategy.ALL; }
@ConditionalOnClass對應(yīng)的Condition處理類是OnClassCondition。如果當(dāng)前類路徑下面有指定的類的時候則生效。
@ConditionalOnClass配置屬性介紹
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnClassCondition.class) public @interface ConditionalOnClass { /** * 需要作為條件的類的Class對象數(shù)組 */ Class<?>[] value() default {}; /** * 需要作為條件的類的Name, Class.getName() */ String[] name() default {}; }
@ConditionalOnMissingClass對應(yīng)的Condition處理類是OnClassCondition。如果當(dāng)前類路徑下面沒有指定的類的時候則生效。
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnClassCondition.class) public @interface ConditionalOnMissingClass { /** * 需要作為條件的類的Name, Class.getName() */ String[] value() default {}; }
@ConditionalOnExpression對應(yīng)的Condition處理類是OnExpressionCondition。只有當(dāng)SpEL表達(dá)式滿足條件的時候則生效。
@Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.TYPE, ElementType.METHOD }) @Documented @Conditional(OnExpressionCondition.class) public @interface ConditionalOnExpression { /** * 要作為條件的SpEL表達(dá)式 */ String value() default "true"; }
例如@ConditionalOnExpression("${test.enabled:true}"),只有當(dāng)配置文件里面存在test.enabled: true的時候則生效。
更加詳細(xì)的用法可以去看下SpEL表達(dá)式的使用。
@ConditionalOnJava對應(yīng)的Condition處理類是OnJavaCondition。只有當(dāng)指定的JAVA版本條件滿足的時候,才會創(chuàng)建對應(yīng)的Bean。
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnJavaCondition.class) public @interface ConditionalOnJava { /** * 比較方式,Range.EQUAL_OR_NEWER:當(dāng)前版本等于或高于、Range.OLDER_THAN:當(dāng)前版本老于,越早的版本越老 */ Range range() default Range.EQUAL_OR_NEWER; /** * 指定JAVA版本 */ JavaVersion value(); /** * Range options. */ enum Range { /** * Equal to, or newer than the specified {@link JavaVersion}. */ EQUAL_OR_NEWER, /** * Older than the specified {@link JavaVersion}. */ OLDER_THAN } }
@ConditionalOnProperty對應(yīng)的Condition實現(xiàn)類OnPropertyCondition。只有當(dāng)對應(yīng)的配置屬性和給定條件的值相等的時候則生效。
@Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.TYPE, ElementType.METHOD }) @Documented @Conditional(OnPropertyCondition.class) public @interface ConditionalOnProperty { /** * 對應(yīng)property名稱的值 */ String[] value() default {}; String[] name() default {}; /** * property名稱的前綴,可有可無 */ String prefix() default ""; /** * 與name組合使用,比較獲取到的屬性值與havingValue給定的值是否相同,相同才加載配置 */ String havingValue() default ""; /** * 缺少該property時是否可以加載。如果為true,沒有該property也會正常加載;反之報錯 */ boolean matchIfMissing() default false; }
@ConditionalOnProperty(prefix = “spring.aop”, name = “auto”, havingValue = “true”)表示當(dāng)配置文件里面spring.aop.auto=true的時候才會加載對應(yīng)的Bean。
@ConditionalOnResource對應(yīng)的Condition處理類OnResourceCondition。只有當(dāng)指定的資源文件出現(xiàn)在classpath中則生效。
@ConditionalOnResource配置屬性
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnResourceCondition.class) public @interface ConditionalOnResource { /** * 要作為判斷條件的資源文件名稱 @ConditionalOnResource(resources=”mybatis.xml”) */ String[] resources() default {}; }
@ConditionalOnWebApplication對應(yīng)的Condition處理類是OnWebApplicationCondition。只有當(dāng)當(dāng)前項目是Web項目的時候則生效。
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnWebApplicationCondition.class) public @interface ConditionalOnWebApplication { /** * 需要作為條件的Web應(yīng)用程序的必需類型 */ Type type() default Type.ANY; /** * Available application types. */ enum Type { /** * 任何web應(yīng)用都將匹配 */ ANY, /** * 僅基于servlet的Web應(yīng)用程序?qū)⑵ヅ? */ SERVLET, /** * 僅基于反應(yīng)式的Web應(yīng)用程序?qū)⑵ヅ? */ REACTIVE } }
@ConditionalOnNotWebApplication對應(yīng)的Condition處理類是OnWebApplicationCondition。只有當(dāng)當(dāng)前項目不是Web項目的時候則生效。
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnWebApplicationCondition.class) public @interface ConditionalOnNotWebApplication { }
上面介紹每個擴展注解的時候都特意提到了每個注解對應(yīng)的Condition實現(xiàn)類。其實我們可以仿照這些Condition實現(xiàn)類來實現(xiàn)我們自己的@Conditional注解。下面我們同個兩個簡單的實例來看下怎么實現(xiàn)自己的@Conditional擴展注解。
注意:和@ConditionalOnProperty不一樣哦,@ConditionalOnProperty是判斷是否有屬性并且判斷值是否等于我們指定的值。我們要實現(xiàn)的注解只判斷有沒有配置屬性,不管屬性對應(yīng)的值。
擴展注解ConditionalOnPropertyExist。指定我們的Condition實現(xiàn)類OnPropertyExistCondition。并且指定兩個參數(shù)。一個是參數(shù)name用于指定屬性。另一個參數(shù)exist用于指定是判斷存在還是不存在。
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.METHOD}) @Documented @Conditional(OnPropertyExistCondition.class) public @interface ConditionalOnPropertyExist { /** * 配置文件里面對應(yīng)的key */ String name() default ""; /** * 是否有配置的時候判斷通過 */ boolean exist() default true; }
OnPropertyExistCondition類就是簡單的判斷下屬性存在與否。
public class OnPropertyExistCondition implements Condition { @Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { Map<String, Object> annotationAttributes = annotatedTypeMetadata.getAnnotationAttributes(ConditionalOnPropertyExist.class.getName()); if (annotationAttributes == null) { return false; } String propertyName = (String) annotationAttributes.get("name"); boolean values = (boolean) annotationAttributes.get("exist"); String propertyValue = conditionContext.getEnvironment().getProperty(propertyName); if(values) { return !StringUtils.isEmpty(propertyValue); } else { return StringUtils.isEmpty(propertyValue); } } }
我們簡單實現(xiàn)這樣一個功能,根據(jù)指定的系統(tǒng)加載不同的Bean。
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.METHOD}) @Documented @Conditional(OnSystemCondition.class) public @interface ConditionalOnSystem { /** * 指定系統(tǒng) */ SystemType type() default SystemType.WINDOWS; /** * 系統(tǒng)類型 */ enum SystemType { /** * windows系統(tǒng) */ WINDOWS, /** * linux系統(tǒng) */ LINUX, /** * mac系統(tǒng) */ MAC } }
public class OnSystemCondition implements Condition { @Override public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(ConditionalOnSystem.class.getName()); if (annotationAttributes == null) { return false; } ConditionalOnSystem.SystemType systemType = (ConditionalOnSystem.SystemType) annotationAttributes.get("type"); switch (systemType) { case WINDOWS: return context.getEnvironment().getProperty("os.name").contains("Windows"); case LINUX: return context.getEnvironment().getProperty("os.name").contains("Linux "); case MAC: return context.getEnvironment().getProperty("os.name").contains("Mac "); } return false; } }
讀到這里,這篇“Spring Boot條件注解怎么用”文章已經(jīng)介紹完畢,想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領(lǐng)會,如果想了解更多相關(guān)內(nèi)容的文章,歡迎關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。