SpringBoot中condition注解的使用方式
作者：刀不封
这篇文章主要介绍了SpringBoot中condition注解的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
在项目中，有时会遇到我们的Configuration、Bean、Service等等的bean组件需要依条件按需加载的情况。
springboot中提供了一系列@Condition* 注解来处理有条件注入的情况。
说明
Spring4中增加了@Condition annotation， 使用该Annotation之后，在做依赖注入的时候，会检测是否满足某个条件来决定是否注入某个类。
springboot基于spring4的这个注解实现了多个用于判断的条件注解，如果我们在使用中这些注解无法满足我们的要求还可以使用@Conditional自定义条件注解
常用的条件注解
| 条件注解 | 对应的Condition 处理类 | 处理逻辑 |
|---|---|---|
| @ConditionalOnBean | OnBeanCondition | Spring容器中是否存在对应的实例。可以通过实例的类型、类名、注解、昵称去容器中查找(可以配置从当前容器中查找或者父容器中查找或者两者一起查找) |
| @ConditionalOnClass | OnClassCondition | 类加载器中是否存在对应的类。可以通过Class指定(value属性)或者Class的全名指定(name属性)如果是多个类或者多个类名的话，关系是”与”关系，也就是说这些类或者类名都必须同时在类加载器中存在 |
| @ConditionalOnExpression | OnExpressionCondition | 判断SpEL 表达式是否成立 |
| @ConditionalOnMissingBean | OnBeanCondition | Spring容器中是否缺少对应的实例。可以通过实例的类型、类名、注解、昵称去容器中查找(可以配置从当前容器中查找或者父容器中查找或者两者一起查找) |
| @ConditionalOnMissingClass | OnClassCondition | 跟ConditionalOnClass的处理逻辑一样，只是条件相反，在类加载器中不存在对应的类 |
| @ConditionalOnProperty | OnPropertyCondition | 应用环境中的屬性是否存在。提供prefix、name、havingValue以及matchIfMissing属性。prefix表示属性名的前缀，name是属性名，havingValue是具体的属性值，matchIfMissing是个boolean值，如果属性不存在，这个matchIfMissing为true的话，会继续验证下去，否则属性不存在的话直接就相当于匹配不成功 |
| @ConditionalOnResource | OnResourceCondition | 是否存在指定的资源文件。只有一个属性resources，是个String数组。会从类加载器中去查询对应的资源文件是否存在 |
| @ConditionalOnSingleCandidate | OnBeanCondition | Spring容器中是否存在且只存在一个对应的实例。只有3个属性value、type、search。跟ConditionalOnBean中的这3种属性值意义一样 |
| @ConditionalOnWebApplication | OnWebApplicationCondition | 应用程序是否是Web程序，没有提供属性，只是一个标识。会从判断Web程序特有的类是否存在，环境是否是Servlet环境，容器是否是Web容器等 |
举例
| 例子 | 说明 |
|---|---|
| @ConditionalOnBean(javax.sql.DataSource.class) | Spring容器或者所有父容器中需要存在至少一个javax.sql.DataSource类的实例 |
| @ConditionalOnClass({ Configuration.class,FreeMarkerConfigurationFactory.class }) | 类加载器中必须存在Configuration和FreeMarkerConfigurationFactory这两个类 |
| @ConditionalOnExpression(“’${server.host}’==’localhost’”) | server.host配置项的值需要是localhost |
| ConditionalOnJava(JavaVersion.EIGHT) | Java版本至少是8 |
| @ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT) | Spring当前容器中不存在ErrorController类型的bean |
| @ConditionalOnMissingClass(“GenericObjectPool”) | 类加载器中不能存在GenericObjectPool这个类 |
| @ConditionalOnNotWebApplication | 必须在非Web应用下才会生效 |
| @ConditionalOnProperty(prefix = “spring.aop”, name = “auto”, havingValue = “true”, matchIfMissing = true) | 应用程序的环境中必须有spring.aop.auto这项配置，且它的值是true或者环境中不存在spring.aop.auto配置(matchIfMissing为true) |
| @ConditionalOnResource(resources=”mybatis.xml”) | 类加载路径中必须存在mybatis.xml文件 |
| @ConditionalOnSingleCandidate(PlatformTransactionManager.class) | Spring当前或父容器中必须存在PlatformTransactionManager这个类型的实例，且只有一个实例 |
| @ConditionalOnWebApplication | 必须在Web应用下才会生效 |
自定义条件注解
实现条件化注解我们需要两个类
- 自定义注解类
- 定义注解，指定判断用的条件类
- 条件类
- 实现org.springframework.context.annotation.Condition接口，定义判断条件
举例说明
1.定义注解类MyConditionalOnProperty
要使用注解@Conditional(MyOnPropertyCondition.class),MyOnPropertyCondition为我们要定义的条件类
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(MyOnPropertyCondition.class)
public @interface MyConditionalOnProperty {
String value();
String prefix() default "";
String havingValue() default "";
boolean matchIfMissing() default false;
boolean relaxedNames() default true;
//TODO ADD ONE PROPERTY
String havingValue() default "";
}
2.定义条件类：
public class MyOnPropertyCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(MyConditionalOnProperty.class.getName());
String propertyName = (String) annotationAttributes.get("value");
String value = annotationAttributes.get("havingValue");
String propertyValue = context.getEnvironment().getProperty(propertyName);
if (propertyValue.equalsIgnoreCase(value)) {
return true;
}
return false;
}
}
3.调用
@Configuration
public class MyConfig {
@Bean
@MyConditionalOnProperty(value = "env",havingValue = "dev")
public Person person(){
log.info("创建Bean");
return new Person();
}
}
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。