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

2022-11-13 16:11:19 示例 注解 自定义

实现一个自定义的 @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 注解内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

相关文章