Spring高级装配--条件化的bean

条件化的bean

假设你希望一个或多个bean只有在应用的类路径下包含特定的库时才创建。或者我们希望某个bean只有当另外某个特定的bean也声明之后才会创建。我们还可能要求只有某个特定的环境变量设置之后，才会创建某个bean。
在Spring4之前，很难实现这种级别的条件化配置，但是Spring4引入了一个新的@Conditional注解，它可以用到@Bean注解的方法上。如果给定的条件计算结果为true，就会创建这个bean，否则的话，这个bean会被忽略。

//MagicBean.java

@Bean
@Conditional(MagicExistsCondition.class)
public MagicBean magicBean(){
    return new MagicBean();
}

上面是一个名为MagicBean的类，我们希望只有设置了magic环境属性的时候，Spring才会实例化这个类。如果环境中没有这个属性，那么MagicBean将会被忽略。
可以看到，@Conditional中给定了一个Class，它指明了条件–在本例中，也就是MagicExistsCondition。@Conditional将会通过Condition接口进行条件对比：

public interface Condition {
    boolean matches(ConditionContext ctxt,AnnotatedTypeMetadata metadata);
}

设置给@Conditional的类可以是任意实现了Condition接口的类型。可以看出来，这个接口实现起来很简单直接，只需要提供matches()方法的实现即可。如果matches()方法返回true，那么就会创建带有@Conditional注解的bean。若返回false，将不会创建这些bean。
下面展现了MagicExistsCondition，这时完成该功能的Condition实现类：

public class MagicExistsCondition implements Condition {
    pulic boolean matches(ConditionContext context,AnnotatedTypeMetadata metadata) {
        Environment env = context.getEnvironment();
        return env.containsProperty("magic");
    }
}

在上面的程序清单中，matches()方法很简单但功能强大。它用过给定的ConditionContext对象进而得到Environment对象，并使用这个对象检查环境中是否存在名为magic的环境属性。在本例中，属性的值是什么无所谓，只要属性存在即可满足需求。如果满足这个条件的话，matches()方法就会返回true。所带来的结果就是条件能够得到满足，所有@Conditional注解上引用MagicExistsCondition的bean都会被创建。
话说回来，如果这个属性不存在的话，就无法满足条件，matches（）方法会返回false，这些bean都不会被创建。
MagicExistsCondition中只是使用了ConditionContext得到的Environment，但Condition实现的考量因素可能会比这更多。matches（）方法会得到ConditionContext和AnnotatedTypemetadata对象来做出决策。

//ConditionContext
public interface ConditionContext {
    BeanDefinitionRegistry getRegistry();
    ConfigurableListableBeanFactory getBeanFactory();
    Environment getEnvironment();
    ResourcesLoader getResourceLoader();
    ClassLoader getClassLoader();
}

  通过ConditionContext，我们可以做到以下几点：

• 借助getRegistry()返回的BeanDefinitionRegistry检查bean定义；
• 借助getBeanFactory()返回的ConfigurableListableBeanFactory 检查bean是否存在，甚至探查bean的属性；
• 借助getEnvironment()返回的Environment检查环境变量是否存在以及它的值是什么；
• 读取并探查getResourceLoader()返回的ResourcesLoader 所加载的资源；
• 借助getClassLoader()返回的ClassLoader加载并检查类是否存在。

AnnotatedTypeMetadata则能够让我们检查带有@Bean注解的方法上还有什么其他的注解，像ConditionContext一样，AnnotatedTypeMetadata也是一个接口。

public interface AnnotatedTypeMetadata {
    boolean isAnnotated(String annotationType);
    Map<String,Object> getAnnotationAttributes(String annotationType);
    Map<String,Object> getAnnotationAttributes(String annotationType,boolean classValuesAsString);
    MultiValueMap<String,Object> getAllAnnotationAttributes(String annotaionType);
    MultiValueMap<String,Object> getAllAnnotationAttributes(String annotaionType,boolean classValuesAsString);
}

借助isAnnotated方法，我们能够判断带有@Bean注解的方法是不是还有其他特定的注解。
非常有意思的是，从Spring4开始，@Profile注解就行了重构，使其基于@Condition和Condition实现。详细可以参考@Profile的源码。