从Spring4开始,引入一个@Conditional注解。他可以用到带有@Bean注解的方法上。如果给定的条件计算结果为true,则创建bean,否则这个bean就会被忽略。
假如,有一个名为MagicBean的类,我们只希望设置了magic环境属性的时候,Spring才实例化这个类,如果环境没有这个属性,那么MagicBean将会被忽略。
如下使用@Conditional条件华地配置MagicBean。
@Bean
@Conditional(MagicExistsCondition.class) //条件化的创建bean
public MagicBean magicBean(){
return new MagicBean();
}
在接口Conditional中,只要实现matcher()方法,如果返回true,则创建bean,反之false则忽略bean.
public class MagicExistsCondition implements Condition{
public boolean matcher(ConditionContext context, AnnotatedTypeMetadata metadata){
Environment env = context.getEnvironment();
return env.containsProperty("magic"); //检查magic属性
}
}
在上面的程序中,matcher()方法很简单,但功能很强大,她通过ConditionContext对象获得Environment对象,并使用这个对象检查环境中是否存在magic的环境属性。如果存在,则返回true,MagicBean对象将被实例化,反之则忽略MagicBean。
ConditionContext
ConditionContext是一个大接口,通过ConditionContext,我们可以从它的方法
1、getRegistry()返回的BeanDefinitionRegistry检查bean定义。
2、getBeanFactory()返回的ConfigurableListableBeanFactory检查bean是否存在,设置探查bean的属性。
3、getEnvironment()返回的Environment对象,可以检查环境变量是否存在以及它的值是什么
4、getClassLoader()返回的ClassLoader加载并检查类是否存在。
AnnotatedTypeMetadata
AnnotatedTypeMetadata也是一个接口,借助它的isAnnotated()方法,我们能够判断带有@Bean注解的方法是不是还有其他特定的注解。借助其他的那些方法,我们能够检查@Bean注解方法上其他注解的属性。
@Profile简单源码解析
Spring4开始,@Profile注解进行了重构,基于@Conditional和Condition实现,@Profile本事也使用了@Conditional注解,并且引用PeofileCondition作为Condition实现类
//Spring源码
class ProfileCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
if (attrs != null) {
for (Object value : attrs.get("value")) {
if (context.getEnvironment().acceptsProfiles(Profiles.of((String[]) value))) {
return true;
}
}
return false;
}
return true;
}
}
我们可以看到,ProfileCondition通过AnnotatedTypeMetadata得到@Profile注解的所有属性,借助该信息,它会明确的检查value属性,该属性包含bean的profile名称,然后它通过ConditionContext得到Environment来检查【借助acceptsProfiles()方法】该profile是否处于激活状态。