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

SpringBoot条件装配注解

news 来源：原创 2025/6/26 0:06:10

SpringBoot条件装配注解

Spring Boot 提供了一系列条件装配注解，用于控制 Bean 的创建和装配过程。以下是一些常用的条件装配注解及其详细介绍：
@ConditionalOnClass
作用：当类路径中存在指定的类时，才会创建该 Bean。
示例：

 @ConditionalOnClass(RedisTemplate.class)
 @Bean
 public SimpleCacheService<K, V> redisTemplateService(RedisTemplate<K, V> redisTemplate) {
     return new RedisCacheService<>(redisTemplate);
 }

说明：只有当类路径中存在 RedisTemplate 类时，才会创建 redisTemplateService Bean。

@ConditionalOnMissingClass
作用：当类路径中不存在指定的类时，才会创建该 Bean。
示例：

 @ConditionalOnMissingClass("org.springframework.data.redis.core.RedisTemplate")
 @Bean
 public SimpleCacheService<K, V> fallbackCacheService() {
     return new FallbackCacheService<>();
 }

说明：只有当类路径中不存在 RedisTemplate 类时，才会创建 fallbackCacheService Bean。

@ConditionalOnBean
作用：当容器中存在指定类型的 Bean 时，才会创建该 Bean。
示例：

 @ConditionalOnBean(RedisTemplate.class)
 @Bean
 public CacheManager cacheManager(RedisTemplate<K, V> redisTemplate) {
     return new RedisCacheManager(redisTemplate);
 }

说明：只有当容器中存在 RedisTemplate Bean 时，才会创建 cacheManager Bean。

@ConditionalOnMissingBean
作用：当容器中不存在指定类型的 Bean 时，才会创建该 Bean。
示例：

 @ConditionalOnMissingBean(SimpleCacheService.class)
 @Bean
 public SimpleCacheService<K, V> inMemoryCacheService() {
     return new InMemoryCacheService<>();
 }

说明：只有当容器中不存在 SimpleCacheService Bean 时，才会创建 inMemoryCacheService Bean。

@ConditionalOnProperty
作用：当配置文件中的某个属性满足特定条件时，才会创建该 Bean。
示例：

 @ConditionalOnProperty(name = "cache.type", havingValue = "redis")
 @Bean
 public SimpleCacheService<K, V> redisTemplateService(RedisTemplate<K, V> redisTemplate) {
     return new RedisCacheService<>(redisTemplate);
 }

说明：只有当配置文件中 cache.type 属性的值为 redis 时，才会创建 redisTemplateService Bean。

@ConditionalOnExpression
作用：当 SpEL 表达式的结果为 true 时，才会创建该 Bean。
示例：

 @ConditionalOnExpression("${cache.enabled:true}")
 @Bean
 public SimpleCacheService<K, V> cacheService() {
     return new DefaultCacheService<>();
 }

说明：只有当配置文件中的 cache.enabled 属性为 true 或未设置时，才会创建 cacheService Bean。

@ConditionalOnWebApplication 和 @ConditionalOnNotWebApplication
作用：分别在 Web 应用程序和非 Web 应用程序中生效。
示例：

 @ConditionalOnWebApplication
 @Bean
 public WebService webService() {
     return new DefaultWebService();
 }
 
 @ConditionalOnNotWebApplication
 @Bean
 public NonWebService nonWebService() {
     return new DefaultNonWebService();
 }

这些注解可以帮助开发者根据不同的运行环境和配置条件来动态装配 Bean，提高应用的灵活性和可扩展性。