关于SpringBoot中基于条件的自动装配

springboot通过@EnableAutoConfiguration实现自动装配;可以将标注了@Configuration的配置类“一股脑的”的添加到ApplicationContext中;实际上基于@EnableAutoConfiguration的自动装配拥有更强大的功能;通过配合比如基于条件的配置能力或者调整加载顺序,我们可以对自动装配进行更加细粒度的控制

1.基于条件的自动装配

1.1在springboot中我们可以使用@Conditional这个注解配合@Configuration或者@Bean等注解来控制一个配置或者一个Bean能否生效;其实的效果或者语义定义类似于如下伪代码:

if(符合@Conditional规定的条件){
	加载当前配置(enable current Conditional )或者注册当前bean
}
其具体代码简单实例实现如下:

两个配置筛选条件

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
 
 
public class MyConditional1 implements Condition{
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        //只有当返回值为true才执行
        return true;
    }
}
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
 
public class MyConditional2 implements Condition {
 
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        return false;
    }
}
Bean的配置
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyConfiguration {
 
    @Bean
    @Conditional(MyConditional1.class)//只有当条件为true时才加载
    public String test01(){
        System.out.println("hello");
        return "";
    }
    @Bean
    @Conditional(MyConditional2.class)
    public String  test02(){
        System.out.println("world");
     return "";
    }
}
  1. 启动springboot可见控制台如下输出:说明只加载了test01没有加载test02. hello。

1.2 可以说@Conditional使用非常简单;最重要的是@Conditional可以作为一个元注解(Meta Annotation)用来注解其他Annotation实现类;从而构建各色的复合Annotation;比如@ConditionalOnClass查看源码我们可以看见它被@Condition所注解。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnClassCondition.class})
public @interface ConditionalOnClass {
    Class<?>[] value() default {};
 
    String[] name() default {};
}
除了@ConditionalOnClass Spring框架还为我们提供了多种复合注解供我们选择:

@ConditionalOnBean(在当前ApplicationContext中存在某个对象时,才去实例化一个Bean)
@ConditionalOnClass(某个class位于类路径上,才会实例化一个Bean)
@ConditionalOnExpression(表达式为true的时候,才会实例化一个Bean)//@Conditional是实现类返回ture
@ConditionalOnMissingBean(在当前ApplicationContext中不存在某个对象时,才会实例化一个Bean)
@ConditionalOnMissingClass(某个class类路径上不存在的时候,才会实例化一个Bean)
@ConditionalOnNotWebApplication(非web应用)

1.3我们也可以实现自己Conditional注解:

首先定义一个注解, 它被@Condition所注解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnMyCondition.class)//自己定义的条件
public @interface ConditionOnMyProperties {
    String value();
}
定义OnMyCondition继承了SpringBootCondition,这个借口也比较强大,这里我们是现实了它的部分公共能:
public class OnMyCondition extends SpringBootCondition {
    @Override
    public ConditionOutcome getMatchOutcome(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        //获取注解上属性
        Object value = annotatedTypeMetadata.getAnnotationAttributes(ConditionOnMyProperties.class.getName()).get("value");
        if (value != null) {
            int i = Integer.parseInt((String) value);
            if (i > 0 ) {
                return new ConditionOutcome(true, "OK");
            }
        }
        return new ConditionOutcome(false, "OK");
    }
}
测试类

@Configuration
public class MyConfiguration {
    @Bean
    @ConditionOnMyProperties(value="3")
    public  String test03(){
        System.out.println("hello world");
        return "";
    }
 
}
控制台会输出打印"hello world";

这只是自定义条件加载的一个简单的例子,实际我们可以用它来实现更强大的功能,但原理都差不多;








阅读更多
个人分类: Spring
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭
关闭