Spring使用@Conditional进行条件装配的实现

 更新时间:2023年12月15日 09:52:36   作者:曹朋羽  
在spring中有些bean需要满足某些环境条件才创建某个bean,这个时候可以在bean定义上使用@Conditional注解来修饰,所以本文给大家介绍了Spring使用@Conditional进行条件装配的实现,文中通过代码示例给大家介绍的非常详细,需要的朋友可以参考下

在spring中有些bean需要满足某些环境条件才创建某个bean,这个时候可以在bean定义上使用@Conditional注解来修饰。@Conditional需要指定一个条件类,这个类不需实现Condition接口并且实现其matches方法。只有当matches方法返回true时才创建当前bean。

例如下面定义一个bean只有当当前jdk版本大于等于8时才创建该bean。

bean定义这里写的很简单,

@Service
@Conditional(Java8Condition.class)
public class ConditionService {
}

看Java8Condition条件类

public class Java8Condition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return JavaVersion.getJavaVersion().isEqualOrNewerThan(JavaVersion.EIGHT);
    }
}

这里判断当前java的版本,如果大于等于8则返回true,ConditionService会被创建成bean,否则不会创建该bean。

Condition的matches方法有两个入参,context和metadata。从context可以获取beanFactory和environment信息,从metadata可以获取当前bean上所有注解配置信息。通过这两个参数可以获取到很多信息了,这里就可以根据上下文来进行判断。不如beanFacotry是否有某个bean,当前环境的profile信息,某个属性的配置信息等等。

看到这里你是否想到了些什么,没错就是springboot的自动条件装配。springboot对@Conditional进行了扩展,在org.springframework.boot.autoconfigure.condition包下有很多封装好的条件注解。如

ConditionalOnBean:某个bean存在时

ConditionalOnClass: 某个class存在时

ConditionalOnExpression: SpEL表达式成立时

ConditionalOnJava: java环境版本

ConditionalOnProperty: 某个property值是多少时

ConditionalOnMissingBean: 某个bean不存在时

等等还有很多。这就明白为什么有些bean我们没有显示声明可以直接拿来注入使用了吧。

condition的扩展

虽然springboot也封装了很多场景的condition注解,但是难免有时候还是有些业务场景可能需要自定义conditon。这里就来以判断上下文某个属性值来扩展condition。

最开始看到@Conditional注解是只有一个Condition类来指定出来条件判断逻辑,没有额外的配置项。这里要判断某个property必须要指定property的key和value,所以第一步先自定义一个注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Conditional(PropertyConditionMatcher.class)
public @interface MyPropertyCondition {
    String name();
    String value();
}

这里自定义注解PropertyConditionMatcher两个属性name用来指定property的key,value用来指定property的value。除此之外我们自定义的注解还用@Conditional来修饰,这样才能我们自定义的注解才能被当作@Conditional来处理。然后来看我们的condition处理类PropertyConditionMatcher。

public class PropertyConditionMatcher implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(MyPropertyCondition.class.getName());
        String propName = (String) annotationAttributes.get("name");
        Object value = annotationAttributes.get("value");
        String property = context.getEnvironment().getProperty(propName);
        if(property != null && property.equals(value)){
            return true;
        }
        return false;
    }
}

这里还是实现了Condition接口。然后首先从metadata中获取配置的property名称和value,然后从context的Environment根据前面的property名获取当前环境对应值,两个value进行对比相等来判断是否满足条件。

然后具体条件bean上配置MyPropertyCondition。

@Service
@MyPropertyCondition(name = "condation.enable",value = "true")
public class ConditionService {
}

这样当我们在properties文件中配置condation.enable=true时,ConditionService就会创建为一个bean,否则不会创建。

以上就是Spring使用@Conditional进行条件装配的实现的详细内容,更多关于Spring @Conditional条件装配的资料请关注脚本之家其它相关文章!

相关文章

  • 通过java反射机制动态调用某方法的总结(推荐)

    通过java反射机制动态调用某方法的总结(推荐)

    下面小编就为大家带来一篇通过java反射机制动态调用某方法的总结(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-07-07
  • SpringBoot3文件管理操作方法

    SpringBoot3文件管理操作方法

    这篇文章主要介绍了SpringBoot3文件管理,本文案例只围绕普通文件和Excel两种类型进行代码实现,包括工程搭建、上传下载操作,需要的朋友可以参考下
    2023-08-08
  • 基于struts2和hibernate实现登录和注册功能

    基于struts2和hibernate实现登录和注册功能

    这篇文章主要为大家详细介绍了基于struts2和hibernate实现登录和注册功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • 解决FeignClient重试机制造成的接口幂等性

    解决FeignClient重试机制造成的接口幂等性

    这篇文章主要介绍了解决FeignClient重试机制造成的接口幂等性问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • springboot使用GuavaCache做简单缓存处理的方法

    springboot使用GuavaCache做简单缓存处理的方法

    这篇文章主要介绍了springboot使用GuavaCache做简单缓存处理的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • SpringCloud Feign超详细讲解

    SpringCloud Feign超详细讲解

    Feign是Netflix公司开发的一个声明式的REST调用客户端; Ribbon负载均衡、 Hystrⅸ服务熔断是我们Spring Cloud中进行微服务开发非常基础的组件,在使用的过程中我们也发现它们一般都是同时出现的,而且配置也都非常相似
    2022-10-10
  • springboot之如何获取请求ip方法

    springboot之如何获取请求ip方法

    这篇文章主要介绍了springboot之如何获取请求ip方法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • Java8常用的新特性详解

    Java8常用的新特性详解

    这篇文章主要介绍了Java8常用的新特性详解,文中有非常详细的代码示例,对正在学习Java8新特性的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • Spring中如何操作JDBC的实现

    Spring中如何操作JDBC的实现

    这篇文章主要介绍了Spring中如何操作JDBC的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • 详解Spring Boot应用的启动和停止(start启动)

    详解Spring Boot应用的启动和停止(start启动)

    这篇文章主要介绍了详解Spring Boot应用的启动和停止(start启动),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12

最新评论