Spring高级装配之条件化创建Bean
上节介绍了profile机制条件化创建Bean的具体步骤，假如你想一个或多个Bean只有在应用的路径下包含特定的库时才创建，那么使用这节我们所要介绍的Spring 4和@Conditional注解定义条件化的Bean就再适合不过了。
要实现这种级别的条件化配置是挺不容易的，但是强大的Spring 4为我们提供了@Conditional注解,下面我们就介绍一下具体怎样使用@Conditional实现条件化配置Bean。
下面我们就根据环境变量中有没有magic变量来决定是否创建MagicBean:
package com.cache.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import com.cache.conditional.MagicExistsConditional;
import com.cache.service.MagicBean;
/**
* <dl>
* <dd>Description:study @Conditional</dd>
* <dd>Company: 黑科技</dd>
* <dd>@date：2016年8月23日 下午7:55:37</dd>
* <dd>@author：Kong</dd>
* </dl>
*/
@Configuration
public class ConditionalConfig {
@Bean
@Conditional(MagicExistsConditional.class) //条件化的创建bean
public MagicBean magicBean() {
return new MagicBean();
}
}
可以看到MagicBean是否创建取决于@Conditional(MagicExistsConditional.class)中的情况，那么给@Conditional中的参数又是什么类型的呢，请看：
package com.cache.conditional;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
/**
* <dl>
* <dd>Description:是否创建Bean的条件类</dd>
* <dd>Company: 黑科技</dd>
* <dd>@date：2016年8月23日 下午7:59:15</dd>
* <dd>@author：Kong</dd>
* </dl>
*/
public class MagicExistsConditional implements Condition{
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
Environment evn = context.getEnvironment();
return evn.containsProperty("magic");
}
}
如你所见，设置给@Conditional的类可以是任意实现了Condition接口的的类型。而实现这个接口只需要实现matches方法，如果matches方法返回true就创建该bean，如果返回false则不创建bean，上例中我们就是根据环境变量中是否存在magic变量，来决定matches的返回值，进而决定是否创建MagicBean的。
上例中我们只是使用到了ConditionContext的到Environment,但Condition实现的考量因素可能会比这多的多。maches()方法会得到ConditionContext和AnnotatedTypeMetadata对象用来做决策。
其实ConditionContext是一个接口：
package org.springframework.context.annotation;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;
/**
* Context information for use by {@link Condition}s.
*
* @author Phillip Webb
* @since 4.0
*/
public interface ConditionContext {
BeanDefinitionRegistry getRegistry();
ConfigurableListableBeanFactory getBeanFactory();
Environment getEnvironment();
ResourceLoader getResourceLoader();
ClassLoader getClassLoader();
}
通过ConditionContext，我们可以做到如下几点：
| 方法 | 作用 |
|---|---|
| getRegistry() | 借助返回的BeanDefinitionRegistry检查bean的定义 |
| getBeanFactory() | 借助返回的ConfigrableListableBeanFactory检查是否存在，甚至检查bean的属性 |
| getEnvironment() | 借助返回Environment检查环境变量是否存在以及读取它的值是什么 |
| getResourceLoader() | 读取并检查它返回的ResourceLoader所加载的资源 |
| getClassLoader() | 借助它的返回的ClassLoader加载并检查类是否存在 |
AnnotatedTypeMetadata则能够让我们检查带有@Bean注解的方法上是否有其他注解：
package org.springframework.core.type;
import java.util.Map;
import org.springframework.util.MultiValueMap;
/**
* Defines access to the annotations of a specific type ({@link AnnotationMetadata class}
* or {@link MethodMetadata method}), in a form that does not necessarily require the
* class-loading.
*
* @author Juergen Hoeller
* @author Mark Fisher
* @author Mark Pollack
* @author Chris Beams
* @author Phillip Webb
* @since 4.0
* @see AnnotationMetadata
* @see MethodMetadata
*/
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使用@Conditional对@Profile的重构：
package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.env.AbstractEnvironment;
import org.springframework.core.env.ConfigurableEnvironment;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(ProfileCondition.class)
public @interface Profile {
/**
* The set of profiles for which the annotated component should be registered.
*/
String[] value();
}
@Profile的实现定义使用了，@Conditional注解和Condition接口，如下，ProfileCondition实现了Condition，并在matches方法中做出了是否创建@Profile的决策：
package org.springframework.context.annotation;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.util.MultiValueMap;
/**
* {@link Condition} that matches based on the value of a {@link Profile @Profile}
* annotation.
*
* @author Chris Beams
* @author Phillip Webb
* @author Juergen Hoeller
* @since 4.0
*/
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;
}
}
我们可以看到，ProfileCondition通过AnnotatedTypeMetadata得到了用于@Profile注解的所有属性。借助该信息，他会明确地检查value属性，该属性包含了bean的profile名称。然后根据ConditionContext得到的Environment来检查【借助acceptsProfiles()方法】该profile是否处于激活状态。
待续，，，，
