Spring的条件注解，一篇文章盘得清清楚楚明明白白-Toy模板网

这篇具有很好参考价值的文章主要介绍了Spring的条件注解，一篇文章盘得清清楚楚明明白白。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

前言

在Spring中，条件注解可根据特定的条件来决定是否创建或配置Bean，这些条件可以基于类、属性、环境等因素。通过使用条件注解，我们可以在Spring容器中更加灵活地管理和控制组件的创建和注入，帮助我们更加灵活地管理和控制Bean的创建和注入，提高代码的灵活性和可维护性。总之，使用很简单，功能很强大。

如果你在项目里有类似下面这样的需求场景，选择使用相关的条件注解，绝对是是非常优雅的实现，没有之一。干货内容呀，如果怕以后找不到，马上收藏+关注吧。

自动化配置：根据特定的条件来决定是否创建或配置Bean，例如根据类路径下是否包含特定的库、特定的环境变量是否设置等条件来控制Bean的创建。
条件化装配：在Spring容器中，根据条件来决定是否加载某个Bean，例如根据当前所处的环境（如开发、测试、生产）来控制Bean的创建。
Bean依赖：在Spring容器中，根据条件来决定是否创建依赖的Bean，例如只有当另外某个特定Bean也声明了之后才创建某个Bean。
自定义条件：通过实现Condition接口，自定义条件逻辑，根据特定条件来控制Bean的创建行为。

Springboot的相关条件注解大盘点

@ConditionalOnClass：当指定的class存在时，才会注入。

@ConditionalOnMissingClass：当指定的class不存在时，才会注入。

@ConditionalOnProperty：当指定的属性存在于application.properties文件中时，才会注入。

@ConditionalOnResource：当指定的资源文件存在时，才会注入。

@ConditionalOnWebApplication：用于判断当前应用是否为Web应用。

@ConditionalOnNotWebApplication：用于判断当前应用是否非Web应用。

@ConditionalOnBean：当Spring容器中存在指定的Bean时，才会注入。

@ConditionalOnMissingBean：当Spring容器中不存在指定的Bean时，才会注入。

@ConditionalOnSingleCandidate：当Spring容器中存在且仅存在一个指定的Bean时，才会注入。

@ConditionalOnExpression：当SpEL表达式为真时，才会注入。

@ConditionalOnJava：根据Java版本进行判断，不同版本有不同的处理方式。

Springboot的相关条件注解的功能描述与使用

@ConditionalOnClass

@ConditionalOnClass注解的作用是当项目中存在某个类时才会使标有该注解的类或方法生效。这个注解可以用来进行条件判断，以便在特定的类存在时才加载相应的Bean。例如，如果项目中引入了ApacheHttpClient包，那么可以使用@ConditionalOnClass(ApacheHttpClient.class)注解来标识这个Bean，只有当ApacheHttpClient类存在于类路径下时才会构建这个Bean。

在这个示例中，@ConditionalOnClass(ApacheHttpClient.class)注解表示只有当ApacheHttpClient类存在于类路径下时，才会加载HttpClientConfig类中的Bean。如果ApacheHttpClient类不存在，那么HttpClientConfig类中的Bean将不会被创建和注入。

@Configuration  
@ConditionalOnClass(ApacheHttpClient.class)  
public class HttpClientConfig {  
  
    @Bean  
    public ApacheHttpClient httpClient() {  
        return new ApacheHttpClient();  
    }  
}

@ConditionalOnMissingClass

@ConditionalOnMissingClass注解的作用是在类路径下不存在指定类时，才会使标有该注解的类或方法生效。这个注解可以用来进行条件判断，以便在特定的类不存在时才加载相应的Bean。例如，如果项目中没有引入MySQL数据库驱动包，那么可以使用@ConditionalOnMissingClass(MySQL.class)注解来标识这个Bean，只有当MySQL类不存在于类路径下时才会构建这个Bean。

@Configuration  
@ConditionalOnMissingClass("com.example.NonExistentClass")  
public class MyConfig {  
    // Bean definitions go here  
}

在这个示例中，@ConditionalOnMissingClass注解表示只有当"com.example.NonExistentClass"这个类不存在时，才会加载MyConfig类中的Bean。如果这个类存在，那么MyConfig类中的Bean将不会被创建和注入。

@ConditionalOnProperty

@ConditionalOnProperty注解的作用是根据指定的属性值来决定是否加载带有该注解的类或方法。如果属性存在且具有指定的值，那么带有@ConditionalOnProperty注解的类或方法将会被加载；否则，将不会加载。它通常用于在Spring应用程序中根据外部配置来决定哪些Bean需要创建和注入。

使用@ConditionalOnProperty注解时，可以通过指定属性名称和属性值来进行条件判断。其中，属性名称可以是应用程序配置文件（如application.properties）中的任意属性，而属性值则可以是任何字符串表达式。当配置文件中的属性值与指定的属性值相匹配时，带有@ConditionalOnProperty注解的类或方法将会被加载。

例如，假设在应用程序的配置文件中有一个名为myapp.database.url的属性，我们希望当该属性的值为jdbc:mysql://localhost:3306/mydb时才加载某个Bean。这时，我们可以在定义该Bean的类中使用@ConditionalOnProperty注解，并指定属性名称和属性值，如下所示：

@Configuration  
@ConditionalOnProperty(  
  name = "myapp.database.url",  
  havingValue = "jdbc:mysql://localhost:3306/mydb"  
)  
public class MyBeanConfig {  
  
    @Bean  
    public MyBean myBean() {  
        return new MyBean();  
    }  
}

在上面的示例中，当配置文件中的myapp.database.url属性值为jdbc:mysql://localhost:3306/mydb时，MyBeanConfig类中的Bean才会被创建和注入。否则，该Bean将不会被加载。

@ConditionalOnResource

@ConditionalOnResource注解的作用是当指定的资源文件存在时，才会使带有该注解的类或方法生效。它通常用于在Spring应用程序中根据资源文件的存在与否来决定哪些Bean需要创建和注入。

使用@ConditionalOnResource注解时，需要指定资源文件的路径和名称。当应用程序在启动时检测到该资源文件存在时，带有@ConditionalOnResource注解的类或方法将会被加载；否则，将不会加载。

例如，假设我们有一个名为config.properties的配置文件，其中包含了一些应用程序的配置信息。我们希望当该配置文件存在时才加载某个Bean。这时，我们可以在定义该Bean的类中使用@ConditionalOnResource注解，并指定配置文件的路径和名称，如下所示：

@Configuration  
@ConditionalOnResource(resources = "config.properties")  
public class MyBeanConfig {  
  
    @Bean  
    public MyBean myBean() {  
        return new MyBean();  
    }  
}

在上面的示例中，当应用程序在启动时检测到config.properties文件存在时，MyBeanConfig类中的Bean才会被创建和注入。否则，该Bean将不会被加载。

@ConditionalOnWebApplication

@ConditionalOnWebApplication注解用于判断当前SpringBoot应用是否为Web应用。根据应用类型，可以进一步确定是否满足某种特定的条件。

使用方式：

@Configuration  
@ConditionalOnWebApplication(type = Type.SERVLET)  
public class ForMatterAutoConfiguration {  
    // Bean definitions go here  
}

在上述示例中，@ConditionalOnWebApplication(type = Type.SERVLET)表示只有当SpringBoot应用类型为SERVLET应用类型时，ForMatterAutoConfiguration才会被加载到Spring容器。

该注解支持以下三种类型：

Type.ANY: 当应用是任何Web应用时，该注解修饰的配置类或方法都会生效。

Type.REACTIVE: 当应用是反应式Web应用（Spring WebFlux）时，该注解修饰的配置类或方法才会生效。

Type.SERVLET: 当应用是基于Servlet的Web应用（Spring MVC）时，该注解修饰的配置类或方法才会生效。

@ConditionalOnNotWebApplication

@ConditionalOnNotWebApplication注解用于判断当前SpringBoot应用是否非Web应用。当应用类型不是Web应用类型时，带有该注解的类或方法将会被加载；否则，将不会加载。

使用方式：

@Configuration  
@ConditionalOnNotWebApplication  
public class ForMatterAutoConfiguration {  
    // Bean definitions go here  
}

在上述示例中，只有当SpringBoot应用类型不是Web应用类型时，ForMatterAutoConfiguration才会被加载到Spring容器。

@ConditionalOnBean

@ConditionalOnBean注解是当Spring容器中有某个Bean时才装配。

这个注解通常用于控制某个Bean的创建和注入，只有当容器中已经存在指定的Bean时，带有该注解的类或方法才会被加载。

使用示例：

@Configuration  
@ConditionalOnBean(name = "userBean")  
public class MyBeanConfig {  
  
    @Bean  
    public MyBean myBean() {  
        return new MyBean();  
    }  
}

在上面的示例中，只有当容器中存在名为"userBean"的Bean时，MyBeanConfig类中的myBean()方法才会被创建和注入。

注意：

@ConditionalOnClass和@ConditionalOnBean都是Spring框架中用于条件化配置的注解，但它们的作用和使用场景有所不同。

@ConditionalOnClass注解用于判断classpath下是否存在某个类。当classpath下存在指定类型的类时，带有该注解的类或方法才会被加载。它通常用于在类路径中引入某个类时进行条件判断。

@ConditionalOnBean注解则用于判断Spring容器中是否存在某个Bean。当容器中有指定类型的Bean时，带有该注解的类或方法才会被加载。它通常用于在Spring容器中已有某个Bean时进行条件判断。

总结来说，@ConditionalOnClass和@ConditionalOnBean都用于条件化配置，但前者用于判断classpath下是否存在某个类，后者用于判断容器中是否存在某个Bean。根据实际需求选择使用适当的注解。

@ConditionalOnMissingBean

@ConditionalOnMissingBean注解用于判断Spring容器中是否存在指定类型的Bean。如果容器中不存在该类型的Bean，那么带有该注解的类或方法才会被加载；否则，将不会加载。

使用示例：

@Configuration  
@ConditionalOnMissingBean(type = "com.example.MyBean")  
public class MyBeanConfig {  
  
    @Bean  
    public MyBean myBean() {  
        return new MyBean();  
    }  
}

在上面的示例中，只有当容器中不存在类型为"com.example.MyBean"的Bean时，MyBeanConfig类中的myBean()方法才会被创建和注入。否则，该Bean将不会被加载。

需要注意的是，@ConditionalOnMissingBean注解通常用于避免多个配置同时注入的风险。对于自定义的配置类，建议加上@ConditionalOnMissingBean注解，以确保只有当容器中不存在指定类型的Bean时才会加载该配置。

注意：

@ConditionalOnMissingClass和@ConditionalOnMissingBean都用于判断当前上下文是否存在某个对象，如果不存在，则实例化一个Bean。然而，它们分别用于判断类和Bean的存在与否。

@ConditionalOnMissingClass用于判断某个类是否存在于classpath中。当指定的类不存在时，带有该注解的类或方法才会被加载。

@ConditionalOnMissingBean用于判断某个Bean是否存在于Spring容器中。当容器中不存在指定类型的Bean时，带有该注解的类或方法才会被加载。

因此，@ConditionalOnMissingClass和@ConditionalOnMissingBean分别用于不同的场景，需要根据具体需求选择使用。

@ConditionalOnSingleCandidate

@ConditionalOnSingleCandidate注解用于检测容器中是否存在匹配的单个候选Bean。只有当容器中只有单个候选Bean时，带有该注解的类或方法才会被加载；否则，将不会加载。

使用示例：

@Configuration  
@ConditionalOnSingleCandidate(MyBean.class)  
public class MyBeanConfig {  
  
    @Bean  
    public MyBean myBean() {  
        return new MyBean();  
    }  
}

在上面的示例中，只有当容器中存在类型为"com.example.MyBean"且只有一个候选Bean时，MyBeanConfig类中的myBean()方法才会被创建和注入。否则，该Bean将不会被加载。

需要注意的是，@ConditionalOnSingleCandidate注解通常用于确保容器中只存在一个指定类型的Bean，以避免多个实例同时存在的情况。对于需要确保单例的Bean，建议使用@ConditionalOnSingleCandidate注解进行条件判断。

@ConditionalOnExpression

@ConditionalOnExpression注解用于根据给定的SpEL（Spring Expression Language）表达式来决定是否加载带有该注解的类或方法。当表达式的结果为true时，该类或方法才会被加载；否则，将不会加载。

使用示例：

@Configuration  
@ConditionalOnExpression("${my.feature.enabled:false}")  
public class MyFeatureConfig {  
  
    @Bean  
    public MyFeature myFeature() {  
        return new MyFeature();  
    }  
}

在上面的示例中，当配置文件中的"my.feature.enabled"属性值为true时，MyFeatureConfig类中的myFeature()方法才会被创建和注入。否则，该Bean将不会被加载。

需要注意的是，@ConditionalOnExpression注解通常用于根据配置文件中的属性值来动态决定是否加载某个类或方法。在实际使用中，需要根据具体的业务需求来设置SpEL表达式，以满足不同的条件判断需求。

@ConditionalOnJava

@ConditionalOnJava注解用于根据当前运行的Java版本决定是否加载带有该注解的类或方法。可以根据不同的Java版本来控制不同版本的Bean的创建和注入。

使用示例：

@Configuration  
@ConditionalOnJava(9)  
public class Java9Config {  
  
    @Bean  
    public MyJava9Bean myJava9Bean() {  
        return new MyJava9Bean();  
    }  
}

在上面的示例中，只有当当前运行的Java版本为9时，Java9Config类中的myJava9Bean()方法才会被创建和注入。否则，该Bean将不会被加载。

需要注意的是，@ConditionalOnJava注解只能检测当前运行的Java版本，而不能检测其他已安装的Java版本。如果需要检测其他版本的Java，可以使用其他条件判断注解或通过其他方式进行检测。 Spring的条件注解，一篇文章盘得清清楚楚明明白白,Springboot,spring,java,spring boot 文章来源地址https://www.toymoban.com/news/detail-730337.html