Spring Boot条件注解怎么用(spring boot,开发技术)

前言：

SpringBoot条件注解@Conditional，可用于根据某个特定的条件来判断是否需要创建某个特定的Bean。SpringBoot自动配置功能里面就大量的使用了条件注解。接下来我们就对@Conditional的使用做一个简单的介绍。

@Conditional注解需要和Condition接口搭配一起使用。通过对应Condition接口来告知是否满足匹配条件。

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceConditional{/***所有用于匹配的Condition接口(实现该接口的类)，只有这些类都返回true才认为是满足条件*/Class<?extendsCondition>[]value();}

@Conditional注解可以添加在@Configuration、@Component、@Service等修饰的类上用于控制对应的Bean是否需要创建，或者添加在@Bean修饰的方法上用于控制方法对应的Bean是否需要创建。

@Conditional添加在@Configuration修饰的类上，用于控制该类和该类里面所有添加的@Bean方法对应的Bean是否需要创建。

一 @Conditional扩展注解

为了方便我们的使用Spring Boot对@Conditional条件注解做了一些扩展，提供了一些很实用的扩展性条件注解。

上面的扩展注解我们可以简单的分为以下几类：

• Bean作为条件：@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnSingleCandidate。

• 类作为条件：@ConditionalOnClass、@ConditionalOnMissingClass。

• SpEL表达式作为条件：@ConditionalOnExpression。

• JAVA版本作为条件: @ConditionalOnJava

• 配置属性作为条件：@ConditionalOnProperty。

• 资源文件作为条件：@ConditionalOnResource。

• 是否Web应用作为判断条件：@ConditionalOnWebApplication、@ConditionalOnNotWebApplication。

1.1 Bean作为条件

1.1.1 @ConditionalOnBean

@ConditionalOnBean对应的Condition处理类是OnBeanCondition。如果Spring容器里面存在指定的Bean则生效。

@ConditionalOnBean配置参数

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnBeanCondition.class)public@interfaceConditionalOnBean{/***需要作为条件的类的Class对象数组*/Class<?>[]value()default{};/***需要作为条件的类的Name,Class.getName()*/String[]type()default{};/***(用于指定注解修饰的Bean)条件所需的注解类*/Class<?extendsAnnotation>[]annotation()default{};/***Spring容器中Bean的名字*/String[]name()default{};/***搜索容器层级，当前容器，父容器*/SearchStrategysearch()defaultSearchStrategy.ALL;/***可能在其泛型参数中包含指定Bean类型的其他类*/Class<?>[]parameterizedContainer()default{};}

1.1.2 @ConditionalOnMissingBean

@ConditionalOnMissingBean对应的Condition实现类是OnBeanCondition。如果Spring容器里面不存在指定的Bean则生效。

@ConditionalOnMissingBean配置参数

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnBeanCondition.class)public@interfaceConditionalOnMissingBean{/***需要作为条件的类的Class对象数组*/Class<?>[]value()default{};/***需要作为条件的类的Name,Class.getName()*/String[]type()default{};/***匹配Bean的时候需要忽视的Class对象数组，一般是父类*@ConditionalOnMissingBean(value=JdbcFactory.class,ignored=MySqlDefaultFactory.class)*/Class<?>[]ignored()default{};/***匹配Bean的时候需要忽视的类的Name,Class.getName()*/String[]ignoredType()default{};/***(用于指定注解修饰的Bean)条件所需的注解类*/Class<?extendsAnnotation>[]annotation()default{};/***Spring容器中Bean的名字*/String[]name()default{};/***搜索容器层级，当前容器，父容器*/SearchStrategysearch()defaultSearchStrategy.ALL;/***可能在其泛型参数中包含指定Bean类型的其他类*/Class<?>[]parameterizedContainer()default{};}

比如如下的实例，当容器里面不存在redisTemplate对应的Bean的时候，就会创建一个RedisTemplate添加到容器里面去。

@Bean@ConditionalOnMissingBean(name="redisTemplate")publicRedisTemplate<Object,Object>redisTemplate(RedisConnectionFactoryredisConnectionFactory)throwsUnknownHostException{RedisTemplate<Object,Object>template=newRedisTemplate<>();template.setConnectionFactory(redisConnectionFactory);returntemplate;}

1.1.3 @ConditionalOnSingleCandidate

@ConditionalOnSingleCandidate对应的Condition处理类是OnBeanCondition。如果当指定Bean在容器中只有一个，或者虽然有多个但是指定首选Bean的时候则生效。

@ConditionalOnSingleCandidate配置参数

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnBeanCondition.class)public@interfaceConditionalOnSingleCandidate{/***需要作为条件的类的Class对象*/Class<?>value()defaultObject.class;/***需要作为条件的类的Name,Class.getName()*/Stringtype()default"";/***搜索容器层级，当前容器，父容器*/SearchStrategysearch()defaultSearchStrategy.ALL;}

1.2 类作为条件

1.2.1 @ConditionalOnClass

@ConditionalOnClass对应的Condition处理类是OnClassCondition。如果当前类路径下面有指定的类的时候则生效。

@ConditionalOnClass配置属性介绍

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnClassCondition.class)public@interfaceConditionalOnClass{/***需要作为条件的类的Class对象数组*/Class<?>[]value()default{};/***需要作为条件的类的Name,Class.getName()*/String[]name()default{};}

1.2.2 @ConditionalOnMissingClass

@ConditionalOnMissingClass对应的Condition处理类是OnClassCondition。如果当前类路径下面没有指定的类的时候则生效。

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnClassCondition.class)public@interfaceConditionalOnMissingClass{/***需要作为条件的类的Name,Class.getName()*/String[]value()default{};}

1.3 SpEL表达式作为条件

@ConditionalOnExpression对应的Condition处理类是OnExpressionCondition。只有当SpEL表达式满足条件的时候则生效。

@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD})@Documented@Conditional(OnExpressionCondition.class)public@interfaceConditionalOnExpression{/***要作为条件的SpEL表达式*/Stringvalue()default"true";}

例如@ConditionalOnExpression("${test.enabled:true}")，只有当配置文件里面存在test.enabled: true的时候则生效。

更加详细的用法可以去看下SpEL表达式的使用。

1.4 JAVA版本作为判断条件

@ConditionalOnJava对应的Condition处理类是OnJavaCondition。只有当指定的JAVA版本条件满足的时候，才会创建对应的Bean。

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnJavaCondition.class)public@interfaceConditionalOnJava{/***比较方式，Range.EQUAL_OR_NEWER:当前版本等于或高于、Range.OLDER_THAN:当前版本老于，越早的版本越老*/Rangerange()defaultRange.EQUAL_OR_NEWER;/***指定JAVA版本*/JavaVersionvalue();/***Rangeoptions.*/enumRange{/***Equalto,ornewerthanthespecified{@linkJavaVersion}.*/EQUAL_OR_NEWER,/***Olderthanthespecified{@linkJavaVersion}.*/OLDER_THAN}}

1.5 配置属性作为判断条件

@ConditionalOnProperty对应的Condition实现类OnPropertyCondition。只有当对应的配置属性和给定条件的值相等的时候则生效。

@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD})@Documented@Conditional(OnPropertyCondition.class)public@interfaceConditionalOnProperty{/***对应property名称的值*/String[]value()default{};String[]name()default{};/***property名称的前缀，可有可无*/Stringprefix()default"";/***与name组合使用，比较获取到的属性值与havingValue给定的值是否相同，相同才加载配置*/StringhavingValue()default"";/***缺少该property时是否可以加载。如果为true，没有该property也会正常加载；反之报错*/booleanmatchIfMissing()defaultfalse;}

@ConditionalOnProperty(prefix = “spring.aop”, name = “auto”, havingValue = “true”)表示当配置文件里面spring.aop.auto=true的时候才会加载对应的Bean。

1.6 资源文件是否存在作为判断条件

@ConditionalOnResource对应的Condition处理类OnResourceCondition。只有当指定的资源文件出现在classpath中则生效。

@ConditionalOnResource配置属性

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnResourceCondition.class)public@interfaceConditionalOnResource{/***要作为判断条件的资源文件名称@ConditionalOnResource(resources=”mybatis.xml”)*/String[]resources()default{};}

1.7 是否Web应用作为判断条件

1.7.1 @ConditionalOnWebApplication

@ConditionalOnWebApplication对应的Condition处理类是OnWebApplicationCondition。只有当当前项目是Web项目的时候则生效。

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnWebApplicationCondition.class)public@interfaceConditionalOnWebApplication{/***需要作为条件的Web应用程序的必需类型*/Typetype()defaultType.ANY;/***Availableapplicationtypes.*/enumType{/***任何web应用都将匹配*/ANY,/***仅基于servlet的Web应用程序将匹配*/SERVLET,/***仅基于反应式的Web应用程序将匹配*/REACTIVE}}

1.7.2 @ConditionalOnNotWebApplication

@ConditionalOnNotWebApplication对应的Condition处理类是OnWebApplicationCondition。只有当当前项目不是Web项目的时候则生效。

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnWebApplicationCondition.class)public@interfaceConditionalOnNotWebApplication{}

二 @Conditional自定义

上面介绍每个扩展注解的时候都特意提到了每个注解对应的Condition实现类。其实我们可以仿照这些Condition实现类来实现我们自己的@Conditional注解。下面我们同个两个简单的实例来看下怎么实现自己的@Conditional扩展注解。

2.1 判断是否配置指定属性

注意：和@ConditionalOnProperty不一样哦，@ConditionalOnProperty是判断是否有属性并且判断值是否等于我们指定的值。我们要实现的注解只判断有没有配置属性，不管属性对应的值。

扩展注解ConditionalOnPropertyExist。指定我们的Condition实现类OnPropertyExistCondition。并且指定两个参数。一个是参数name用于指定属性。另一个参数exist用于指定是判断存在还是不存在。

@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD})@Documented@Conditional(OnPropertyExistCondition.class)public@interfaceConditionalOnPropertyExist{/***配置文件里面对应的key*/Stringname()default"";/***是否有配置的时候判断通过*/booleanexist()defaulttrue;}

OnPropertyExistCondition类就是简单的判断下属性存在与否。

publicclassOnPropertyExistConditionimplementsCondition{@Overridepublicbooleanmatches(ConditionContextconditionContext,AnnotatedTypeMetadataannotatedTypeMetadata){Map<String,Object>annotationAttributes=annotatedTypeMetadata.getAnnotationAttributes(ConditionalOnPropertyExist.class.getName());if(annotationAttributes==null){returnfalse;}StringpropertyName=(String)annotationAttributes.get("name");booleanvalues=(boolean)annotationAttributes.get("exist");StringpropertyValue=conditionContext.getEnvironment().getProperty(propertyName);if(values){return!StringUtils.isEmpty(propertyValue);}else{returnStringUtils.isEmpty(propertyValue);}}}

2.1 判断是否配置指定属性

我们简单实现这样一个功能，根据指定的系统加载不同的Bean。

@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD})@Documented@Conditional(OnSystemCondition.class)public@interfaceConditionalOnSystem{/***指定系统*/SystemTypetype()defaultSystemType.WINDOWS;/***系统类型*/enumSystemType{/***windows系统*/WINDOWS,/***linux系统*/LINUX,/***mac系统*/MAC}}

publicclassOnSystemConditionimplementsCondition{@Overridepublicbooleanmatches(ConditionContextcontext,AnnotatedTypeMetadatametadata){Map<String,Object>annotationAttributes=metadata.getAnnotationAttributes(ConditionalOnSystem.class.getName());if(annotationAttributes==null){returnfalse;}ConditionalOnSystem.SystemTypesystemType=(ConditionalOnSystem.SystemType)annotationAttributes.get("type");switch(systemType){caseWINDOWS:returncontext.getEnvironment().getProperty("os.name").contains("Windows");caseLINUX:returncontext.getEnvironment().getProperty("os.name").contains("Linux");caseMAC:returncontext.getEnvironment().getProperty("os.name").contains("Mac");}returnfalse;}}