SpringBoot 实现自定义的 @ConditionalOnXXX 注解示例详解

 更新时间:2022年08月31日 10:01:35   作者:tytler  
这篇文章主要介绍了SpringBoot 实现自定义的 @ConditionalOnXXX 注解,通过示例代码介绍了实现一个自定义的 @Conditional 派生注解,Conditional 派生注解的类如何注入到 spring 容器,需要的朋友可以参考下

实现一个自定义的 @Conditional 派生注解

自定义一个注解,继承 @Conditional 注解

// 派生注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(CustomConditional.class)
public @interface ConditionalOnCustom {
    String[] value() default {};
}

注解的处理类

public class CustomConditional implements Condition {

	@Override
	public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
		// 获取到自定义注解中的 value 值
		String[] properties = (String[]) metadata.getAnnotationAttributes("smoketest.test.condition.ConditionalOnCustom").get("value");
		// 遍历自定义属性的 value 值
		for (String property : properties) {
			// 获取定义在配置文件中的值,并且 equals("customBean") 则返回 true
			if ("customBean".equals(context.getEnvironment().getProperty(property))) {
				return true;
			}
		}
		return false;
	}
}

使用注解

@Component
@ConditionalOnCustom({"smoketest.test.condition.bean"})
public class ConditionalUse {
}

application.properties 中配置变量

smoketest.test.condition.bean = customBean

获取 ConditionalUse 对象

@SpringBootApplication
@ConfigurationPropertiesScan
public class SampleTestApplication {

	public static void main(String[] args) {
		ConfigurableApplicationContext context = SpringApplication.run(SampleTestApplication.class, args);
		ConditionalUse bean = context.getBean(ConditionalUse.class);
		System.out.println(bean);
	}

}

程序启动可以看到成功获取 ConditionalUse 对象

Conditional 派生注解的类如何注入到 spring 容器

@Conditional 注解在 spring 的 ConfigurationClassParse 类中会调用 ConditionEvaluator.shouldSkip() 方法进行判断,Condition 接口的 matches() 是否返回 true,如果返回 true,就实例化对象,并注册到 spring 容器中

  • shouldSkip() 这个方法执行的逻辑主要是如果是解析阶段则跳过,如果是注册阶段则不跳过
  • 如果是在注册阶段即 REGISTER_BEAN 阶段的话,此时会得到所有的 Condition 接口的具体实现类并实例化这些实现类,然后再执行下面关键的代码进行判断是否需要跳过
  • if ((requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)) { return true; }
  • 上面代码最重要的逻辑是调用 Condition 接口的具体实现类的 matches() 方法,若 matches() 返回 false,则跳过,不进行注册 bean 的操作
  • 若 matches() 返回 true,则不跳过,进行注册 bean 的操作

到此这篇关于SpringBoot 实现自定义的 @ConditionalOnXXX 注解示例详解的文章就介绍到这了,更多相关SpringBoot @ConditionalOnXXX 注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈SpringBoot如何自定义Starters

    浅谈SpringBoot如何自定义Starters

    今天带大家来学习SpringBoot如何自定义Starters,文中有非常详细的图文介绍及代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下
    2021-05-05
  • jfreechart画折线图的方法

    jfreechart画折线图的方法

    这篇文章主要为大家详细介绍了jfreechart画折线图的方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-06-06
  • Java.toCharArray()和charAt()的效率对比分析

    Java.toCharArray()和charAt()的效率对比分析

    这篇文章主要介绍了Java.toCharArray()和charAt()的效率对比分析,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • Springcloud微服务架构基础知识解析

    Springcloud微服务架构基础知识解析

    这篇文章主要介绍了Springcloud微服务架构基础知识解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Java利用位运算实现乘法运算详解

    Java利用位运算实现乘法运算详解

    这篇文章主要为大家详细介绍了Java如何用位运算实现乘法运算,在实现乘法时要用位运算实现,并且不能出现加减乘除任何符号,感兴趣的可以了解一下
    2023-04-04
  • Java 异步编程实践_动力节点Java学院整理

    Java 异步编程实践_动力节点Java学院整理

    异步编程提供了一个非阻塞的,事件驱动的编程模型。下面通过本文给大家介绍Java 异步编程实践,感兴趣的的朋友一起看看吧
    2017-05-05
  • 如何查看JVM使用的默认的垃圾收集器

    如何查看JVM使用的默认的垃圾收集器

    这篇文章主要介绍了如何查看JVM使用的默认的垃圾收集器,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • java.io.IOException:你的主机中的软件中止了一个已建立的连接踩坑实战

    java.io.IOException:你的主机中的软件中止了一个已建立的连接踩坑实战

    最近在工作中遇到了个问题,分享给同样遇到问题的同学,这篇文章主要给大家介绍了关于java.io.IOException:你的主机中的软件中止了一个已建立的连接的踩坑实战记录,需要的朋友可以参考下
    2023-03-03
  • Mybatis读取和存储json类型数据的实现

    Mybatis读取和存储json类型数据的实现

    本文主要介绍了Mybatis读取和存储json类型数据的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-06-06
  • springmvc的validator数据校验的实现示例代码

    springmvc的validator数据校验的实现示例代码

    这篇文章主要介绍了springmvc的数据校验的实现示例代码, 具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07

最新评论