欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

@Conditional 条件注解

程序员文章站 2024-01-20 15:49:46
...

概述

  很多的时候,在使用spring的时候,都会遇到在某些条件下某个对象是不需要注册的,或者,某些条件下某个对象是需要进行注册的。这个时候就需要使用到条件注解(当然这不是必须的,通过其它的方式也是可以解决的,但是这个是比较方便的)。

  First?
我遇到这个问题(微服务),是在spring-security-oauth2和spring的web拦截器,oauth2拦截判断权限之后解析token将解析的用户数据保存到本地线程(网关),而web拦截器的作用是从请求头中提取这些信息保存到本地线程(各个其它服务),当这两个东西都在网关中出现的时候,很明显只需要一个oauth2的就可以了,web拦截器是不需要的,这个时候其实可以采用不引入web拦截器的jar包然后手动处理一下,但是我还需要web拦截器中的一些东西方法。所以在spring注册对象的时候可以采用,如果在网关中就不注册web拦截器对象的方法。

@Conditional 说明

  该注解总共个就一个属性value,该属性类型是Condition类的数组类型。所以可以通过大括号来添加多个条件{}。

  既然是Condition类型的,所以我们要做的就是看看这个Condition到底是什么,org.springframework.context.annotation.Condition是一个接口,所以我们只要实现它就可以了。

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

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

  如何使用呢?

@Conditional({Test1.class,Test2.class})
@Bean
public String test1() {
    
    return "测试对象是否创建成功";
}

Condition接口的使用

该接口里面就一个匹配方法,返回值是布尔类型,表示条件注解的是与否。关键就在这个matches方法的里面的两个参数的使用,一个是条件上下文对象,一个是注解类型元数据信息对象。通过在这个方法里面写判断语句来判断指定的对象是否向spring容器注册。

扩展

实际上conditional给出的条件注解已经扩展了很多,我们这里列举一下。
@ConditionalOnBean:仅仅在当前上下文中存在某个对象时,才会实例化一个Bean。
@ConditionalOnClass:某个class位于类路径上,才会实例化一个Bean。
@ConditionalOnExpression:当表达式为true的时候,才会实例化一个Bean。
@ConditionalOnMissingBean:仅仅在当前上下文中不存在某个对象时,才会实例化一个Bean。
@ConditionalOnMissingClass:某个class类路径上不存在的时候,才会实例化一个Bean。
@ConditionalOnNotWebApplication:不是web应用,才会实例化一个Bean。
@ConditionalOnBean:当容器中有指定Bean的条件下进行实例化。
@ConditionalOnMissingBean:当容器里没有指定Bean的条件下进行实例化。
@ConditionalOnClass:当classpath类路径下有指定类的条件下进行实例化。
@ConditionalOnMissingClass:当类路径下没有指定类的条件下进行实例化。
@ConditionalOnWebApplication:当项目是一个Web项目时进行实例化。
@ConditionalOnNotWebApplication:当项目不是一个Web项目时进行实例化。
@ConditionalOnProperty:当指定的属性有指定的值时进行实例化。
@ConditionalOnExpression:基于SpEL表达式的条件判断。
@ConditionalOnJava:当JVM版本为指定的版本范围时触发实例化。
@ConditionalOnResource:当类路径下有指定的资源时触发实例化。
@ConditionalOnJndi:在JNDI存在的条件下触发实例化。
@ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个,或者有多个但是指定了首选的Bean时触发实例化。
相关标签: # spirng