Conditional spring bean creation

Question

I have a question about Spring annotation configurations. I have a bean:

@Bean 
public ObservationWebSocketClient observationWebSocketClient(){
    log.info("creating web socket connection...");
    return new ObservationWebSocketClient();
}

and I have a property file:

@Autowired
Environment env;

In the property file I want to have a special boolean property

createWebsocket=true/false

which signs whether a bean ObservationWebSocketClient should be created. If property value is false I don't want to establish web socket connection at all.

Is there any technical possibility to realize this?

Answer 1

Though I've not used this functionality, it appears that you can do this with spring 4's @Conditional annotation.

First, create a Condition class, in which the ConditionContext has access to the Environment:

public class MyCondition implements Condition {     @Override     public boolean matches(ConditionContext context,                             AnnotatedTypeMetadata metadata) {         Environment env = context.getEnvironment();         return null != env                 && "true".equals(env.getProperty("createWebSocket"));     } } 

Then annotate your bean:

@Bean @Conditional(MyCondition.class) public ObservationWebSocketClient observationWebSocketClient(){     log.info("creating web socket connection...");     return new ObservationWebSocketClient(); } 

edit The spring-boot annotation @ConditionalOnProperty has implemented this generically; the source code for the Condition used to evaluate it is available on github here for those interested. If you find yourself often needing this funcitonality, using a similar implementation would be advisable rather than making lots of custom Condition implementations.

Answer 2

Annotate your bean method with @ConditionalOnProperty("createWebSocket").

Note that Spring Boot offers a number of useful conditions prepackaged.

Answer 3

For Spring Boot 2+ you can simply use:

@Profile("prod")
or
@Profile({"prod","stg"})

That will allow you to filter the desired profile/profiles, for production or staging and for the underlying Bean using that annotation it only will be loaded by Springboot when you set the variable spring.profiles.active is equals to "prod" and ("prod" or "stg"). That variable can be set on O.S. environment variables or using command line, such as -Dspring.profiles.active=prod.