Spring @ConditionalOnProperty havingValue = "value1" or "value2"

MLS picture MLS · Jul 10, 2018 · Viewed 22.7k times · Source

I am looking for configurationOnProperty usage where I can specify to consider more than one value as shown below

Eg: @ConditionalOnProperty(value = "test.configname", havingValue = "value1" or "value2")

OR

I would like to know if it is possible to specify confiugrationOnProperty with condition of havingValue != "value3"

Eg: @ConditionalOnProperty(value = "test.configname", havingValue != "value3")

Please let me know if there is a way to achieve any one of the above in spring boot configuration.

Answer

Andy Wilkinson picture Andy Wilkinson · Jul 10, 2018

Spring Boot provides AnyNestedCondition for created a condition that will match when any nested condition matches. It also provides AllNestedConditions and NoneNestedConditions for matching when all nested conditions or no nested conditions match respectively.

For your specific case where you want to match a value of value1 or value2 you would create an AnyNestedCondition like this:

class ConfigNameCondition extends AnyNestedCondition {

    public ConfigNameCondition() {
        super(ConfigurationPhase.PARSE_CONFIGURATION);
    }

    @ConditionalOnProperty(name = "test.configname", havingValue = "value1")
    static class Value1Condition {

    }

    @ConditionalOnProperty(name = "test.configname", havingValue = "value2")
    static class Value2Condition {

    }

}

And then use it with @Conditional, like this for example:

@Bean
@Conditional(ConfigNameCondition.class)
public SomeBean someBean() {
    return new SomeBean();
}

As shown in the javadoc for the nested condition annotations (linked to above) the nested conditions can be of any type. There's no need for them to all be of the same type as they are in this particular case.