Spring实战之有条件的加载bean/按某个条件加载bean

假设我们希望一个或多个bean只有在应用的类路径下包含特定的库时才创建，或者我们希望某个bean只有另外某个特定的bean也声明了之后才会创建，或者我们可能要求某个特定的环境变量设置之后，才会创建某个bean。

@Conditional注解

Spring提供了@Conditional注解，它可以用到带有@Bean注解的方法上。作用是按照给定的条件计算，如果结果为true，则创建这个bean，结果为false，这个bean就会被忽略。

例，现有一个类MagicBean，我们希望只有设置了magic环境属性的时候，Spring才会实例化这个类。如果环境中没有这个属性，那么MagicBean将会被忽略，可以使用@Conditional注解，代码如下：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;

public class MagicBean {
    @Bean
    @Conditional(MagicExistsCondition.class)//条件化地创建bean
    public MagicBean magicBean(){
        return new MagicBean();
    }
}
1
2
3
4
5
6
7
8
9
10

如上，@Conditional注解中给定了一个Class，它指明了条件–也就是MagicExistsCondition类。@Conditional将会通过Condition接口进行条件对比：

public interface Condition {
	boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}
1
2
3

设置给@Conditional的类可以是任意实现了Condition接口的实现类。如果实现类中的matches返回true，那么就会创建该bean，如果matches返回false，则不会创建该bean。
本例中，我们需要根据环境中是否存在magic属性来做出判断。MagicExistsCondition类代码如下：

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;

public class MagicExistsCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment env = context.getEnvironment();
        return env.containsProperty("magic");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

@Profile注解也使用了@Conditional注解

前面文章Spring实战之JavaConfig方式多环境与profile配置 讲的@Profile注解也使用了@Conditional注解。代码如下：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(ProfileCondition.class)
public @interface Profile {
	String[] value();
}
1
2
3
4
5
6
7

@Conditional注解引用ProfileCondition类，代码如下：

class ProfileCondition implements Condition {

	@Override
	public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
		if (context.getEnvironment() != null) {
			MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
			if (attrs != null) {
				for (Object value : attrs.get("value")) {
					if (context.getEnvironment().acceptsProfiles(((String[]) value))) {
						return true;
					}
				}
				return false;
			}
		}
		return true;
	}

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

可以看到，ProfileCondition 类通过AnnotatedTypeMetadata 得到了用于@Profile注解的所有属性。借助该信息，它会明确的检查value属性，该属性包含了bean的profile名称。然后，它根据ConditionContext 得到Environment来检查[借助acceptsProfiles()方法]该profile是否处于激活状态。