背景
项目中有些分支暂时不需要用到kafka的消费监听,但以后可能会用到。于是需要一个方法可以动态开关kafka相关功能。
解决方案
通过注解@ConditionalOnProperty或注解@ConditionalOnBean实现,推荐使用@ConditionalOnProperty。
@ConditionalOnProperty
使用方法:在类名上方加以下注解
@ConditionalOnProperty(name = "kafkaEnable", havingValue = "true", matchIfMissing = true)
含义:配置文件(.properties文件或.yaml文件)中有字段kafkaEnable = false
则不加载该类,无对应配置字段或= true
则加载
@ConditionalOnBean
使用方法:在类名上方加以下注解
@ConditionalOnBean(xxxx.class)
含义:当xxxx.class bean
加载后,加载该类,否则不加载。
使用时可能出现的问题
当上梯队向下梯队使用@ConditionalOnBean
时,会导致无法成功注册。
Bean注册优先级梯队
第一梯队如下:
1.1. 扫描的Bean,包括直接扫描、自动配置中扫描、启用组件中扫描的Bean:
即扫描标注了 @Controller @Service @Repository @Component 的类
1.2. 直接的Java配置,即@SpringBootApplication直接覆盖的包下用@Bean注册的Bean
第二梯队如下:
2.1. 启用组件中的Java配置注册的Bean,即在@Enable...引入、而且使用@Bean注册的Bean
第三梯队如下:
3.1. 自动配置中的Java配置注册的Bean,即在自动配置中引入、而且使用@Bean注册的Bean
总结
以上介绍了怎么通过@ConditionalOnProperty
和@ConditionalOnBean
注解实现动态加载类,并对Bean注册优先级梯队进行了简单的介绍。