功能说明
@ConditionalOnMissingBean
是 Spring Framework 提供的一个条件注解,用于指定在当前 Spring 应用上下文中没有找到指定类型的 Bean 时,才会实例化被注解的类或者方法。
具体来说,当 Spring 容器启动时,会检查当前上下文中是否已经存在某种类型的 Bean。如果不存在,才会根据 @ConditionalOnMissingBean
的配置来决定是否创建一个新的 Bean 实例并加入到容器中。
注解详细描述:
-
位置:可以用在类上或者方法上。
- 类级别:标注在类上时,表示如果容器中不存在该类的 Bean 实例,则创建该 Bean。
- 方法级别:标注在方法上时,表示如果容器中不存在该方法返回类型的 Bean 实例,则调用该方法创建并注册一个 Bean。
-
属性:
value
/name
:指定要检查的 Bean 类型或名称。可以是一个 Class 类型,也可以是一个字符串数组,指定 Bean 的名称。annotation
:指定要检查的 Bean 是否标注了特定的注解。match
:是否考虑 Bean 的派生类。默认为true
,表示检查是否存在该类型及其子类的 Bean。
-
使用场景:
- 默认实现替换:当需要为某个接口或者类提供默认的实现时,可以用
@ConditionalOnMissingBean
注解标注一个备选的实现类。如果用户没有自定义的 Bean,就会使用备选的默认实现。 - 条件化装配:可以根据不同的条件提供不同的 Bean 实现,如果某些条件下已经有了指定类型的 Bean,则不再创建新的实例。
- 插件扩展:用于插件化的应用中,允许插件定义自己的默认实现,但如果用户已经提供了自定义的实现,就使用用户定义的版本。
- 默认实现替换:当需要为某个接口或者类提供默认的实现时,可以用
示例:
1、在类级别使用 @ConditionalOnMissingBean
:
@Service
@ConditionalOnMissingBean(UserService.class)
public class DefaultUserService implements UserService {
// 实现 UserService 接口的默认逻辑
}
-
这段代码中,如果 Spring 容器中不存在
UserService
的其他实现,则会注册DefaultUserService
作为默认实现。
2、在方法级别使用 @ConditionalOnMissingBean
:
@Bean
@ConditionalOnMissingBean(UserService.class)
public UserService defaultUserService() {
return new DefaultUserService();
}
这段代码中,如果容器中不存在 UserService
的 Bean,则会注册 defaultUserService()
方法返回的 DefaultUserService
Bean。
总之,@ConditionalOnMissingBean
是一个非常有用的条件注解,可以根据具体的条件动态地决定是否创建和注册 Bean,从而实现更灵活和可定制的 Bean 管理和装配策略。