3.2 条件化的bean

发表于 2024-8-12 11:48:06

在Spring 4之前，很难实现这种级别的条件化配置，但是Spring 4引入了一个新的@Conditional注解，它可以用到带有@Bean注解的方法上。如果给定的条件计算结果为true，就会创建这个bean，否则的话，这个bean会被忽略。例如，假设有一个名为MagicBean的类，我们希望只有设置了magic环境属性的时候，Spring才会实例化这个类。如果环境中没有这个属性，那么MagicBean将会被忽略。在程序清单3.4所展现的配置中，使用@Conditional注解条件化地配置了MagicBean。程序清单3.4　条件化地配置bean

可以看到，@Conditional中给定了一个Class，它指明了条件——在本例中，也就是MagicExistsCondition。@Conditional将会通过Condition接口进行条件对比：

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

设置给@Conditional的类可以是任意实现了Condition接口的类型。可以看出来，这个接口实现起来很简单直接，只需提供matches()方法的实现即可。如果matches()方法返回true，那么就会创建带有@Conditional注解的bean。如果matches()方法返回false，将不会创建这些bean。在本例中，我们需要创建Condition的实现并根据环境中是否存在magic属性来做出决策。程序清单3.5展现了MagicExistsCondition，这是完成该功能的Condition实现类：程序清单3.5　在Condition中检查是否存在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();
　 ResourceLoader getResourceLoader();
　 ClassLoader getClassLoader();
}

通过ConditionContext，我们可以做到如下几点： ·借助getRegistry()返回的BeanDefinitionRegistry检查bean定义； ·借助getBeanFactory()返回的ConfigurableListableBeanFactory检查bean是否存在，甚至探查bean的属性； ·借助getEnvironment()返回的Environment检查环境变量是否存在以及它的值是什么； ·读取并探查getResourceLoader()返回的ResourceLoader所加载的资源； ·借助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 annotationType);
　 MultiValueMap<String, Object> getAllAnnotationAttributes(
　　　　　 String annotationType, boolean classValuesAsString);
}

借助isAnnotated()方法，我们能够判断带有@Bean注解的方法是不是还有其他特定的注解。借助其他的那些方法，我们能够检查@Bean注解的方法上其他注解的属性。非常有意思的是，从Spring 4开始，@Profile注解进行了重构，使其基于@Conditional和Condition实现。作为如何使用@Conditional和Condition的例子，我们来看一下在Spring 4中，@Profile是如何实现的。 @Profile注解如下所示：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(ProfileCondition.class)
public @interface Profile {
　 String[] value();
}

注意： @Profile本身也使用了@Conditional注解，并且引用ProfileCondition作为Condition实现。如下所示，ProfileCondition实现了Condition接口，并且在做出决策的过程中，考虑到了ConditionContext和AnnotatedTypeMetadata中的多个因素。程序清单3.6　ProfileCondition检查某个bean profile是否可用

class ProfileCondition implements Condition {
　 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;
　 }
}

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

3.2 条件化的bean

biuupv