概述
spring boot 中的 @conditional 注解是一個(gè)不太常用到的注解，但確實(shí)非常的有用，我們知道 spring boot 是根據(jù)配置文件中的內(nèi)容，決定是否創(chuàng)建 bean，以及如何創(chuàng)建 bean 到 spring 容器中，而 spring boot 自動(dòng)化配置的核心控制，就是 @conditional 注解。
@conditional 注解是 spring 4.0 之后出的一個(gè)注解，與其搭配的一個(gè)接口是 condition，@conditional 注解會(huì)根據(jù)具體的條件決定是否創(chuàng)建 bean 到容器中，接下來看看 @conditional 注解的簡(jiǎn)單使用。
1. @conditional 和 condition 接口搭配使用
這里需要實(shí)現(xiàn)的功能是，我們根據(jù)配置文件中的具體內(nèi)容，來決定是否創(chuàng)建 bean，首先我們?cè)?application.yml 中加上一個(gè)自定義配置：
這里我們決定，這個(gè)配置中包含了 product 這個(gè)字符串的時(shí)候，才創(chuàng)建 bean。product 是我自己隨便創(chuàng)建的一個(gè)實(shí)體類，你可以自行創(chuàng)建。
新建一個(gè)類 productcondition，內(nèi)容如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
public class productcondition implements condition { @override public boolean matches(conditioncontext conditioncontext, annotatedtypemetadata annotatedtypemetadata) { //從配置文件中獲取屬性 string property = conditioncontext.getenvironment().getproperty("create.bean"); if (property != null){ return property.contains("product"); } else { return false; } }} |
這個(gè)類實(shí)現(xiàn)了 condition 接口，這個(gè)接口只有一個(gè)方法，我們從配置文件中獲取剛才創(chuàng)建的自定義配置，如果配置中包含了 product 這個(gè)字符串，就會(huì)返回 true。
接下來創(chuàng)建一個(gè)配置類 productconfig，內(nèi)容如下：
|
1
2
3
4
5
6
7
8
9
10
11
|
@configurationpublic class productconfig { @conditional(productcondition.class) @bean(name = "product") public product createprod(){ return product.builder().id(12312).categoryid(12). productname("mac book pro").productimg("prod.png") .productprice(18000).build(); }} |
我們?cè)趧?chuàng)建的 bean 方法前面加上了 @conditional 注解，判斷的標(biāo)準(zhǔn)是剛才的 productcondition，如果是 true，則創(chuàng)建 bean，否則不創(chuàng)建。我們寫一個(gè)測(cè)試類，來測(cè)試一下 bean 是否被創(chuàng)建了。測(cè)試代碼如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
@slf4j@springboottest@runwith(springrunner.class)public class productconfigtest { @test public void createprod() { try { product product = springcontextutil.getbean("product", product.class); if (product != null){ system.out.println("創(chuàng)建了 bean : " + product.tostring()); } } catch (exception e){ log.info("發(fā)生異常，{}", e.getmessage()); system.out.println("沒有創(chuàng)建 bean"); } }} |
運(yùn)行測(cè)試代碼，發(fā)現(xiàn) bean 已經(jīng)創(chuàng)建了：
如果把 application.yml 中的配置改一下，不包含 product 這個(gè)字符串，那么返回的是 false，bean 則不會(huì)被創(chuàng)建，你可以試一下。
2. @conditionalonclass 的使用
這個(gè)注解的屬性可以跟上一個(gè)類的完整路徑或者是類的 class 對(duì)象，如果類存在，則會(huì)創(chuàng)建 bean，例如下面的例子：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
@configurationpublic class productconfig { @conditionalonclass(name = "com.roseduan.demo.entity.product") @bean(name = "product") public product createprod(){ return product.builder().id(12312).categoryid(12). productname("mac book pro").productimg("prod.png") .productprice(18000).build(); }} |
這個(gè)路徑下面的實(shí)體類 product 是存在的，所以會(huì)創(chuàng)建 bean，如果是一個(gè)不存在的類，則不會(huì)創(chuàng)建。
3. @conditionalonproperty 的使用
這個(gè)注解可以直接從配置文件中獲取屬性，然后做為是否創(chuàng)建 bean 的依據(jù)。例如我們?cè)?application.yml 中添加一個(gè)自定義配置：
productconfig 類的內(nèi)容是這樣的：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
@configurationpublic class productconfig { @conditionalonproperty(value = "create.product.bean") @bean(name = "product") public product createprod(){ return product.builder().id(12312).categoryid(12). productname("mac book pro").productimg("prod.png") .productprice(18000).build(); }} |
這里使用了 @conditionalonproperty 注解，從文件中讀取配置，因?yàn)槲覀冊(cè)O(shè)置的是 true，所以這個(gè) bean 會(huì)被創(chuàng)建，如果設(shè)置成 false，則 bean 不會(huì)被創(chuàng)建，你可以自己試一下。根據(jù)這個(gè)特性，我們可以給一些特定的配置加上一個(gè)開關(guān)，非常方便控制。
這里我只是列舉了幾個(gè)常用的注解，你可以查看官方文檔，里面有更詳細(xì)的說明：
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持服務(wù)器之家。
原文鏈接：https://segmentfault.com/a/1190000018777937
