自定义Conditional

常用的内置Conditional注解：

       @ConditionalOnClass：当classpath下有指定的类的条件下

       @ConditionalOnMissingClass：当classpath下没有指定的类的条件下

       @ConditionalOnBean：当容器中有指定的Bean的条件下

       @ConditionalOnMissingBean：当容器中没有指定Bean的条件下

       @ConditionalOnProperty(prefix = “example.service”, value = “enabled”, matchIfMissing = true)，当配置文件中example.service.enabled=true时进行自动配置，如果没有设置此值就默认使用matchIfMissing对应的值

       @ConditionalOnExpression：基于SpEL表达式作为判断条件

       @ConditionalOnJava：基于JVM版本作为判断条件

       @ConditionalOnJndi：在JNDI存在的条件下

       @ConditionalOnNotWebApplication：当前不是Web环境

       @ConditionalOnWebApplication：当前是Web环境

       @ConditionalOnResource：当类路径下有指定的资源

       @ConditionalOnSingleCandidate：当指定的Bean在容器中只有一个，或者在有多个Bean的情况下，用来指定首选的Bean

 

其他注解：

       @AutoConfigureBefore         用在自动配置类上，在加载参数类之前先加载当前类

       @AutoConfigureAfter            用在自动配置类上，在加载参数类之后再加载当前类

               比如： @AutoConfigureAfter(DataSourceAutoConfiguration.class)

 

@Conditional注解类：

       用来标识一个Spring Bean或者Configuration配置文件，当满足指定的条件才开启配置。

       范例：

             @Conditional(OnClassCondition.class)

             @Conditional(OnMyPropertiesCondition.class)

 

自定义Conditional需要同时创建自定义注解类和Condition的实现类。

自定义Conditional可以实现Condition接口，也可以继承SpringBootCondition抽象类。

 

Condition的实现类：

public class OnMyPropertiesCondition extends SpringBootCondition {
	public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
		Object propertiesName = metadata.getAnnotationAttributes(ConditionalOnMyProperties.class.getName()).get("name");
		if (propertiesName != null) {
			String value = context.getEnvironment().getProperty(propertiesName.toString());
			if (value != null) {
				return new ConditionOutcome(true, "get properties");
//return ConditionOutcome.match("get properties");
			}
		}
		return new ConditionOutcome(false, "non get properties");
//return ConditionOutcome.noMatch("non get properties");
} }

 

自定义注解类：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnMyPropertiesCondition.class)
public @interface ConditionalOnMyProperties {
	String name();
}

 

自定义注解需要配合Configuration注解才能生效

@Configuration
@ConditionalOnMyProperties(name = "message")
public class ConditionClass {
	@Bean
	public HelloWorld helloWorld() {
		return new HelloWorld();
	}
}