【Spring Boot】条件化自动装配

Bertha 。 2023-06-10 03:24 14阅读 0赞

**【引言】**

在前面的博客中，了解了Spring Boot的自动装配是如何实现的，这只是一个基础，对于自动装配，更专业的使用是可以做到条件化自动装配。

**【条件注解】**

Spring Boot中，提供了以下条件化注解：

<table> 
 <thead> 
  <tr> 
   <th>条件化注解</th> 
   <th>配置生效条件</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@ConditionalOnClass</td> 
   <td>Classpath里有指定的类</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingClass</td> 
   <td>Classpath里缺少指定的类</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnBean</td> 
   <td>配置了某个特定Bean</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingBean</td> 
   <td>没有配置特定的Bean</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnProperty</td> 
   <td>指定的配置属性要有一个明确的值</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnResource</td> 
   <td>Classpath里有指定的资源</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnWebApplication</td> 
   <td>这是一个Web应用程序</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnNotWebApplication</td> 
   <td>这不是一个Web应用程序</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnExpression</td> 
   <td>给定的SpEL表达式计算结果为true</td> 
  </tr> 
 </tbody> 
</table>

**【Class条件注解】**

下面借助上篇博客中自定义starter的first-springboot-starter工程，看下Class条件注解的使用会出现什么样的结果呢？

在工程中，我们定义了一个默认的输出方法类DefaultFormatter，下面添加一个输出JSON格式的实现类，JsonFormatter。

**1. 添加Jackson依赖到pom.xml**

<dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.9.9</version>
        <optional>true</optional>
    </dependency>

**2. 新增Json格式输出类**

public class JsonFormatter implements Formatter {
    
        private final ObjectMapper objectMapper;
    
        public JsonFormatter(){
            this.objectMapper=new ObjectMapper();
        }
    
        @Override
        public String format(Object object) {
            try {
                return objectMapper.writeValueAsString(object);
            }catch (JsonProcessingException e){
                throw new IllegalArgumentException(e);
            }
        }
    }

**3. 新增JsonFormatter Bean声明到FormatterAutoConfiguration**

@Configuration
    public class FormatterAutoConfiguration {
        @Bean
        public Formatter defaultFormatter(){
            return new DefaultFormatter();
        }
    
        /**
         * json格式输出
         * @return
         */
        @Bean
        public Formatter jsonFormatter(){
            return new JsonFormatter();
        }
    }

这样，在同一个Spring应用上下文中出现了两个Formatter Bean，即DefaultFormatter和JsonFormatter，为避免出现Formatter Bean唯一性冲突，我们便可以利用Class条件注解。

**4. 两个Formatter Bean可使用互斥的Class条件注解@ConditionOnMissingClass和@ConditionOnClass，代码修改如下：**

@Configuration
    public class FormatterAutoConfiguration {
    
        @Bean
        @ConditionalOnMissingClass(value = "com.fasterxml.jackson.databind.ObjectMapper")
        public Formatter defaultFormatter(){
            return new DefaultFormatter();
        }
    
        /**
         * json格式输出
         * @return
         */
        @Bean
        @ConditionalOnClass(name = "com.fasterxml.jackson.databind.ObjectMapper")
        public Formatter jsonFormatter(){
            return new JsonFormatter();
        }
    }

**5. 测试代码**

public static void main(String[] args) {
        ConfigurableApplicationContext context = new SpringApplicationBuilder(TeststarterApplication.class).web(WebApplicationType.NONE).run(args);
        Map<String,Object> data = new HashMap<>();
        data.put("date","1025");
        Formatter formatter = context.getBean(Formatter.class);
        System.out.printf("%s.formatter.format(data) : %s\n",formatter.getClass().getSimpleName(),formatter.format(data));
        context.close();
    }

上面的运行结果依然是DefaultFormatter:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70]  
原因是项目依赖中添加了Optional为true，所以Maven依赖并没有传递到该工程

在该项目中添加json依赖，即可发现结果是json格式化输出的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70 1]  
通过以上示例，对于Class的条件注解的使用想必也是很清楚了。对于其他的一些条件注解，使用方式也都一样，想要达到什么样的结果，借助条件，也都是可以实现的。

**【参考资料】**

1.  官网文档的“[49.3 Condition Annotations][]”章节内容。
2.  Spring Boot编程思想（核心篇）

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70]: /images/20230531/0a1876e2215841d4a5f2df544bab6b3c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70 1]: /images/20230531/185a0d4250494fdca7661f51eb0ef23b.png
[49.3 Condition Annotations]: https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/htmlsingle/#boot-features-condition-annotations