spring--@Conditional详解

S_L__

已于 2023-01-10 11:04:01 修改

阅读量219

点赞数

分类专栏： spring源码总结文章标签： spring java 后端

于 2023-01-10 11:02:54 首次发布

本文链接：https://blog.youkuaiyun.com/S_L__/article/details/128626002

版权

spring源码总结专栏收录该内容

3 篇文章

订阅专栏

@Conditional注解用于基于特定条件注册SpringBean。它允许在运行时根据条件决定加载哪个实现类。例如，在Nacos的场景中，有两个CommonPersistService的实现，通过不同的Condition实现判断，当ConditionOnExternalStorage的matches方法返回true时，ExternalCommonPersistServiceImpl被注册并执行，否则EmbeddedCommonPersistServiceImpl生效。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@Conditional的作用

@Conditional是Spring4新提供的注解，它的作用是按照一定的条件进行判断，满足条件给容器注册bean。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
    Class<? extends Condition>[] value();
}

@FunctionalInterface
public interface Condition {
    //根据返回的true 或者 false p判断是否注入对象
    boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

@Conditional的使用

以下案例来自nacos中的使用场景：用来区分单机环境和集群环境

//该接口有两个实现类
public interface CommonPersistService {
    void findTenantByKp();
}

//实现类1
@Conditional(value = ConditionOnExternalStorage.class)
@Service("externalOtherPersistServiceImpl")
public class ExternalCommonPersistServiceImpl implements CommonPersistService {
    void findTenantByKp(){
        System.out.println("实现类1打印了-----");
    }
}

public class ConditionOnExternalStorage implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return true;
    }
}


//实现类2
@Conditional(value = ConditionOnEmbeddedStorage.class)
@Service("embeddedOtherPersistServiceImpl")
public class EmbeddedCommonPersistServiceImpl implements CommonPersistService {
    void findTenantByKp(){
        System.out.println("实现类2打印了-----");
    }
}

public class ConditionOnEmbeddedStorage implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return false;
    }
}


//使用
@Service
public class NamespaceOperationService {
    @resource
    private CommonPersistService commonPersistService;

    public List<Namespace> getNamespaceList() {
        commonPersistService.findTenantByKp();
    }
}


结果：实现类1打印了-----
因为实现类的@Conditional条件注解中的实现方法返回的true