当前位置：首页 > news >正文

【Spring】条件装配 @ConditionalOnClass @ConditionalOnBean

news 来源：原创 2024/9/25 16:05:56

@ConditionalOnClass 是 Spring Framework 提供的一个注解，用于在应用程序上下文加载过程中根据类的存在与否来决定是否创建或配置某个 bean。

通常情况下，当应用程序上下文加载时，Spring 会根据配置文件或注解等方式定义的 bean 定义来创建对象，并将其加入到 bean 集合中。然而，有时候我们希望只在某些特定的类存在时才创建或配置某个 bean。这时候，就可以使用 @ConditionalOnClass 注解。

@ConditionalOnClass 注解可以用于类或接口上，它的作用是检查指定类或接口是否存在于应用程序上下文中。如果存在，则进行相应的 bean 创建或配置；如果不存在，则忽略该 bean 的创建或配置。

下面是一个示例：

@Configuration  
@ConditionalOnClass(value = {A.class})  
public class MyConfiguration {  @Bean  public B b() {  return new B();  }  
}

在这个示例中，MyConfiguration 类上使用了 @ConditionalOnClass 注解，并指定了需要检查的类 A。如果这个类都存在于应用程序上下文中，那么 MyConfiguration 类中的 b 方法将会被调用，并返回一个 B 对象。否则，这个 bean 将不会被创建或配置。

需要注意的是，@ConditionalOnClass 注解只能检查类或接口是否存在于应用程序上下文中，而不能检查类的实例是否已经存在。如果需要检查类的实例是否存在，可以使用 @ConditionalOnBean 注解。

下面是一个示例：

@Configuration  
@ConditionalOnBean(value = A.class)  
public class MyConfiguration {  @Bean  public B b() {  return new B();  }  
}

在这个示例中，MyConfiguration 类上使用了 @ConditionalOnBean 注解，并指定了需要检查的类 MyBean。如果 A 的实例存在于应用程序上下文中，那么 MyConfiguration 类中的 b 方法将会被调用，并返回一个 B 对象。否则，这个 bean 将不会被创建或配置。

在Spring中，有许多与条件装配相关的注解。这些注解可以帮助我们更方便地实现条件装配。以下是一些常用的条件装配注解：

@Conditional 这是一个通用的条件装配注解，可以用于任何情况下的条件装配。它需要指定一个实现了Condition接口的类，用于判断是否满足条件。
@ConditionalOnBean 当容器中存在某个指定的bean时，才会创建被注解的bean。
@ConditionalOnMissingBean 当容器中不存在某个指定的bean时，才会创建被注解的bean。
@ConditionalOnClass 当类路径下存在某个指定的类时，才会创建被注解的bean。
@ConditionalOnMissingClass 当类路径下不存在某个指定的类时，才会创建被注解的bean。
@ConditionalOnProperty 当指定的属性存在且值为指定值时，才会创建被注解的bean。
@ConditionalOnResource 当指定的资源存在时，才会创建被注解的bean。
@ConditionalOnWebApplication 当应用程序是一个Web应用程序时，才会创建被注解的bean。
@ConditionalOnNotWebApplication 当应用程序不是一个Web应用程序时，才会创建被注解的bean。
@ConditionalOnExpression 当指定的SpEL表达式计算结果为true时才进行装配。