SpringBoot条件注解常见用法

忘是亡心i 2023-08-17 16:19 150阅读 0赞

### 前言 ###

常见的条件注解：

<table> 
 <tbody> 
  <tr> 
   <td>条件注解</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnBean</td> 
   <td>Spring容器中是否存在对应的实例。可以通过实例的类型、类名、注解、昵称去容器中查找(可以配置从当前容器中查找或者父容器中查找或者两者一起查找)这些属性都是数组，通过”与”的关系进行查找</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnClass</td> 
   <td>类加载器中是否存在对应的类。可以通过Class指定(value属性)或者Class的全名指定(name属性)。如果是多个类或者多个类名的话，关系是”与”关系，也就是说这些类或者类名都必须同时在类加载器中存在</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnExpression</td> 
   <td>判断SpEL 表达式是否成立</td> 
  </tr> 
  <tr> 
   <td> <p>@ConditionalOnJava</p> </td> 
   <td>指定Java版本是否符合要求。内部有2个属性value和range。value表示一个枚举的Java版本，range表示比这个老或者新于等于指定的Java版本(默认是新于等于)。内部会基于某些jdk版本特有的类去类加载器中查询，比如如果是jdk9，类加载器中需要存在java.security.cert.URICertStoreParameters；如果是jdk8，类加载器中需要存在java.util.function.Function；如果是jdk7，类加载器中需要存在java.nio.file.Files；如果是jdk6，类加载器中需要存在java.util.ServiceLoader</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingBean</td> 
   <td>Spring容器中是否缺少对应的实例。可以通过实例的类型、类名、注解、昵称去容器中查找(可以配置从当前容器中查找或者父容器中查找或者两者一起查找)这些属性都是数组，通过”与”的关系进行查找。还多了2个属性ignored(类名)和ignoredType(类名)，匹配的过程中会忽略这些bean</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingClass</td> 
   <td>跟ConditionalOnClass的处理逻辑一样，只是条件相反，在类加载器中不存在对应的类</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnWebApplication</td> 
   <td><br> 应用程序是否是Web程序，没有提供属性，只是一个标识。会从判断Web程序特有的类是否存在，环境是否是Servlet环境，容器是否是Web容器等</td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnNotWebApplication</td> 
   <td>应用程序是否是非Web程序，没有提供属性，只是一个标识。会从判断Web程序特有的类是否存在，环境是否是Servlet环境，容器是否是Web容器等</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnProperty</td> 
   <td>应用环境中的屬性是否存在。提供prefix、name、havingValue以及matchIfMissing属性。prefix表示属性名的前缀，name是属性名，havingValue是具体的属性值，matchIfMissing是个boolean值，如果属性不存在，这个matchIfMissing为true的话，会继续验证下去，否则属性不存在的话直接就相当于匹配不成功</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnResource</td> 
   <td>是否存在指定的资源文件。只有一个属性resources，是个String数组。会从类加载器中去查询对应的资源文件是否存在</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnSingleCandidate</td> 
   <td>Spring容器中是否存在且只存在一个对应的实例。只有3个属性value、type、search。跟ConditionalOnBean中的这3种属性值意义一样</td> 
  </tr> 
 </tbody> 
</table>

### 例子： ###

比如说实现不同条件创建不同的bean，以前可能需要写很多判断，但是有了条件注解，一切都变得很方便了。

**我们实现一个swagger的开关**

我们编写一个SwaggerConfig的配置类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2ODUwODEz_size_16_color_FFFFFF_t_70][]

对应的配置如下

zoo.swagger.enable = true

还有其他写法：

@ConditionalOnExpression("$\{test.enabled:true\}")

@ConditionalOnExpression("\#\{'true'.equals(environment\['conditional.express'\])\}")

@ConditionalOnExpression("\#\{!'true'.equals(environment.getProperty('conditional.express'))\}")

@ConditionalOnExpression("$\{mq.cumsumer.enabled\}==1&&$\{rabbitmq.comsumer.enabled:true\}")

@ConditionalOnExpression("'$\{mq.comsumer\}'.equals('rabbitmq')")

其他注解用法：

@ConditionalOnProperty(prefix = “spring.aop”, name = “auto”, havingValue = “true”, matchIfMissing = true)

其他的可以自行百度了。。。。。。。。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2ODUwODEz_size_16_color_FFFFFF_t_70]: /images/20230810/38603ccdfeb54bfa98acbf3cb7fb19cc.png