SpringBoot之@Conditional衍生条件装配详解

🍓🍓🍓欢迎来到 请回答1024的博客

关于博主： 我是 请回答1024，一个追求数学与计算的边界、时间与空间的平衡，0与1的延伸的后端开发者。

博客特色： 在我的博客中，开设了如下专栏(点击可以进入专栏奥~): Java、MySQL、Redis、Spring、SpringBoot、SpringCloud、RabbitMQ、微服务、分布式 等相关技术专栏。期待与您一起，探索编程世界中的发现和创新之旅。

🍎🍎🍎我的主页 : https://reply1024.blog.csdn.net

敬请期待定期更新、见解和教程！让我们一起踏上这段编码冒险之旅！

☃️前言

当涉及SpringBoot应用程序的配置和装配时，@Conditional注解是一个非常有用的工具。它允许开发人员根据特定条件来决定是否应该创建一个bean或者装配一段配置。通过这种方式，可以实现更加灵活和可定制的应用程序配置，根据不同的环境或条件提供不同的实现或功能。

☃️简介

@Conditional注解简介
@Conditional注解可以与@ConditionalOnProperty、@ConditionalOnClass、@ConditionalOnBean等条件注解结合使用，根据条件判断是否应用装配或配置。这些条件注解可以根据应用程序的运行时环境、类路径上的存在情况或其他条件来确定应用程序的装配方式。

☃️示例

❄️❄️@ConditionalOnProperty

1. @ConditionalOnProperty示例
   @ConditionalOnProperty是一种常用的条件注解，它根据指定的属性值来决定是否应用装配。例如，可以根据配置文件中的属性来决定某个bean是否应该创建。

@Configuration
@ConditionalOnProperty(name = "myapp.feature.enabled", havingValue = "true")
public class MyFeatureConfiguration {
    // 在myapp.feature.enabled为true时装配该bean
    @Bean
    public MyFeatureBean myFeatureBean() {
        return new MyFeatureBean();
    }
}

❄️❄️@ConditionalOnClass

2. @ConditionalOnClass示例
   @ConditionalOnClass允许根据类路径上是否存在某个类来决定是否应用装配。这对于确保特定库或框架是否可用非常有用。

@Configuration
@ConditionalOnClass(name = "org.springframework.data.redis.core.RedisTemplate")
public class RedisConfiguration {
    // 当RedisTemplate类位于类路径上时，装配该bean
    @Bean
    public RedisTemplate redisTemplate() {
        return new RedisTemplate();
    }
}

❄️❄️@ConditionalOnBean

3. @ConditionalOnBean示例
   @ConditionalOnBean用于根据是否存在特定的bean来决定是否应用装配。这可以用于根据其他bean的存在与否来决定配置。

@Configuration
public class MyServiceAutoConfiguration {
    
    @Bean
    @ConditionalOnBean(DataSource.class)
    public MyService myService(DataSource dataSource) {
        return new MyService(dataSource);
    }
}

❄️❄️自定义条件

除了使用现有的条件注解外，还可以通过实现Condition接口来创建自定义条件。例如，根据自定义逻辑来决定是否应用装配：

public class MyCustomCondition implements Condition {
    
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 自定义逻辑判断，返回true表示条件匹配，应用装配
        // 这里可以根据ApplicationContext、Environment等上下文信息来判断
        return true; // 自定义条件始终为true，示例用途
    }
}

然后，在配置类中使用自定义条件：

@Configuration
@Conditional(MyCustomCondition.class)
public class MyConfiguration {
    // 当MyCustomCondition条件满足时，装配该配置类
}

☃️SpringBoot源码中使用

在 SpringBoot 源码中，@Conditional注解的使用非常广泛，它通常用于根据不同的条件来决定是否加载某些配置或者装配特定的 bean。下面是一个简单的例子，展示了 SpringBoot 源码中如何使用@Conditional注解：

@Configuration
@ConditionalOnWebApplication
public class WebMvcAutoConfiguration {
    
    @Configuration
    @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
    @Import(DelegatingWebMvcConfiguration.class)
    @EnableConfigurationProperties(WebMvcProperties.class)
    public static class EnableWebMvcConfiguration extends WebMvcConfigurationSupport {
        // 在缺少 WebMvcConfigurationSupport bean 时加载该配置
        // 这个配置类用于配置 Spring MVC 的相关特性
    }
    
    @Bean
    @ConditionalOnMissingBean({InternalResourceViewResolver.class, ViewResolver.class})
    public InternalResourceViewResolver defaultViewResolver() {
        // 在缺少 InternalResourceViewResolver 和 ViewResolver bean 时创建该 bean
        // 这个 bean 用于处理 JSP 视图解析
        return new InternalResourceViewResolver();
    }
    
    // 其他配置和 bean 的装配...
}

☃️总结

@Conditional注解提供了一种基于条件的装配机制，可以根据运行时环境、配置属性、类路径等因素来动态决定是否应用某个配置或装配某个bean。结合现有的条件注解或自定义条件，开发人员可以灵活地配置SpringBoot应用程序，使其更具可定制性和适应性。在开发过程中，根据实际需求合理使用@Conditional注解，可以使应用程序的配置更加智能和可控。