SpringBoot中@ConditionalOnProperty注解的使用方法详解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    // NAME和VALUE的互为别名，在使用时是互斥的
    String[] value() default {};
    String[] name() default {};
	// 配置项前缀，如果完整配置为：servicex.swagger.config.enabled，则prefix为：servicex.swagger.config
    String prefix() default ""; 
	// 用havingValue与配置项的值进行对比，一致返回TRUE，不一致返回FALSE.
    String havingValue() default "";
	// 如果配置文件中, 没有该配置项, 判断是否加载BEAN, 默认为false。
    boolean matchIfMissing() default false;
}

// 假设YML中的配置如下：
servicex.swagger.config.enabled=true

// 即使配置文件中没有"servicex.swagger.config.enabled"该配置，
// 依然加载SwaggerAutoConfiguration，因为matchIfMissing = true。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled", matchIfMissing = true)
public class SwaggerAutoConfiguration {
}

// 既指定prefix也指定name，因为配置项为true，所以会加载SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(prefix = "servicex.swagger.config", name = "enabled")
public class SwaggerAutoConfiguration {
}

// 只指定name或者value，因为配置项为true，所以会加载SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled")
public class SwaggerAutoConfiguration {
}

// 只指定name或者value，因为配置项为true，havingValue也为true，所以会加载SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled", havingValue = "true")
public class SwaggerAutoConfiguration {
}

// 只指定name或者value，因为配置项为true，havingValue为false，所以不会加载SwaggerAutoConfiguration。
@Configuration
@EnableAutoConfiguration
@ConditionalOnProperty(name = "servicex.swagger.config.enabled", havingValue = "false")
public class SwaggerAutoConfiguration {
}

ConditionalOnProperty
ConditionalOnResource
// 当某个Bean在应用上下文存在时，才会加载
ConditionalOnBean
@ConditionalOnBean(MyAutoConfiguration.class)
public class SwaggerAutoConfiguration {
}
// 当某个Bean在应用上下文不存在时，才会加载
ConditionalOnMissingBean
// 当某个Bean在CLASS-PATH存在时，才会加载
ConditionalOnClass
// 当某个Bean在CLASS-PATH不存在时，才会加载
ConditionalOnMissingClass
// 当表达式的返回值为TRUE时，才会加载
ConditionalOnExpression
@ConditionalOnExpression("${servicex.swagger.config.enabled:true} and ${swagger.config.enabled:true}")
public class SwaggerAutoConfiguration {
}
// 指定资源在CLASS-PATH存在时，才会加载
ConditionalOnResource
@ConditionalOnResource(resources = "/banner.txt")
public class SwaggerAutoConfiguration {
}