SpringBoot @Value 解析集合配置

一、前言

在日常開發(fā)中，經(jīng)常會遇到需要在配置文件中，存儲 List 或是 Map 這種類型的數(shù)據(jù)。Spring 原生是支持這種數(shù)據(jù)類型的，以配置 List 類型為例，對于 .yml 文件配置如下：

test:
??list:
????-?aaa
????-?bbb
????-?ccc

對于 .properties 文件配置如下所示：

test.list[0]=aaa
test.list[1]=bbb
test.list[2]=ccc

當(dāng)我們想要在程序中使用時候，想當(dāng)然的使用 @Value 注解去讀取這個值，就像下面這種寫法一樣：

@Value("${test.list}")
private?List?testList;

你會發(fā)現(xiàn)程序直接報(bào)錯了，報(bào)錯信息如下：

java.lang.IllegalArgumentException:?Could?not?resolve?placeholder?'test.list'?in?value?"${test.list}"

這個問題也是可以解決的，以我們要配置的 key 為 test.list 為例，新建一個 test 的配置類，將 list 作為該配置類的一個屬性：

@Configuration
@ConfigurationProperties("test")
public?class?TestListConfig?{
????private?List?list;

????public?List?getList()?{
????????return?list;
????}

????public?void?setList(List?list)?{
????????this.list?=?list;
????}
}

在程序其他地方使用時候。采用自動注入的方式，去獲取值：

@Autowired
private?TestListConfig?testListConfig;

//?testListConfig.getList();

可以看見，這種方式十分的不方便，最大的問題是配置和代碼高耦合了，增加一個配置，還需要對配置類做增減改動。

二、數(shù)組怎么樣

數(shù)組？說實(shí)話，業(yè)務(wù)代碼寫多了，這個“古老”的數(shù)據(jù)結(jié)構(gòu)遠(yuǎn)遠(yuǎn)沒有 list 用的多，但是它在解決上面這個問題上，出乎異常的好用。

test:
??array1:?aaa,bbb,ccc
??array2:?111,222,333
??array3:?11.1,22.2,33.3

@Value("${test.array1}")
private?String[]?testArray1;

@Value("${test.array2}")
private?int[]?testArray2;

@Value("${test.array3}")
private?double[]?testArray3;

這樣就能夠直接使用了，就是這么的簡單方便，如果你想要支持不配置 key 程序也能正常運(yùn)行的話，給它們加上默認(rèn)值即可：

@Value("${test.array1:}")
private?String[]?testArray1;

@Value("${test.array2:}")
private?int[]?testArray2;

@Value("${test.array3:}")
private?double[]?testArray3;

僅僅多了一個 : 號，冒號后的值表示當(dāng) key 不存在時候使用的默認(rèn)值，使用默認(rèn)值時數(shù)組的 length = 0。

總結(jié)下使用數(shù)組實(shí)現(xiàn)的優(yōu)缺點(diǎn)：

優(yōu)點(diǎn)：

• 不需要寫配置類
• 使用逗號分割，一行配置，即可完成多個數(shù)值的注入，配置文件更加精簡

缺點(diǎn)：

• 業(yè)務(wù)代碼中數(shù)組使用很少，基本需要將其轉(zhuǎn)換為 List，去做 contains、foreach 等操作。

三、替代方法

那么我們有沒有辦法，在解析 list、map 這些類型時，像數(shù)組一樣方便呢？答案是可以的，這就依賴于 EL 表達(dá)式。

3.1 解析 List

以使用 .yml 文件為例，我們只需要在配置文件中，跟配置數(shù)組一樣去配置：

test:
??list:?aaa,bbb,ccc

在調(diào)用時，借助 EL 表達(dá)式的 split() 函數(shù)進(jìn)行切分即可。

@Value("#{'${test.list}'.split(',')}")
private?List?testList;

同樣，為它加上默認(rèn)值，避免不配置這個 key 時候程序報(bào)錯：

@Value("#{'${test.list:}'.split(',')}")
private?List?testList;

但是這樣有個問題，當(dāng)不配置該 key 值，默認(rèn)值會為空串，它的 length = 1（不同于數(shù)組，length = 0），這樣解析出來 list 的元素個數(shù)就不是空了。

這個問題比較嚴(yán)重，因?yàn)樗鼤?dǎo)致代碼中的判空邏輯執(zhí)行錯誤。這個問題也是可以解決的，在 split() 之前判斷下是否為空即可。

@Value("#{'${test.list:}'.empty???null?:?'${test.list:}'.split(',')}")
private?List?testList;

如上所示，即為最終的版本，它具有數(shù)組方式的全部優(yōu)點(diǎn)，且更容易在業(yè)務(wù)代碼中去應(yīng)用。

3.2 解析 Set

解析 Set 和解析 List 本質(zhì)上是相同的，唯一的區(qū)別是 Set 會做去重操作。

test:
??set:?111,222,333,111

@Value("#{'${test.set:}'.empty???null?:?'${test.set:}'.split(',')}")
private?Set?testSet;

//?output:?[111,?222,?333]

3.3 解析 Map

解析 Map 的寫法如下所示，value 為該 map 的 JSON 格式，注意這里使用的引號：整個 JSON 串使用引號包裹，value 值使用引號包裹。

test:
??map1:?'{"name":?"zhangsan",?"sex":?"male"}'
??map2:?'{"math":?"90",?"english":?"85"}'

在程序中，利用 EL 表達(dá)式注入：

@Value("#{${test.map1}}")
private?Map?map1;

@Value("#{${test.map2}}")
private?Map?map2;

注意，使用這種方式，必須得在配置文件中配置該 key 及其 value。我在網(wǎng)上找了許多資料，都沒找到利用 EL 表達(dá)式支持不配置 key/value 的寫法。

如果你真的很需要這個功能，就得自己寫解析方法了，這里以使用 fastjson 進(jìn)行解析為例：

(1) 自定義解析方法

public?class?MapDecoder?{
????public?static?Map?decodeMap(String?value)?{
????????try?{
????????????return?JSONObject.parseObject(value,?new?TypeReference>(){});
????????}?catch?(Exception?e)?{
????????????return?null;
????????}
????}
}

(2) 在程序中指定解析方法

@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map1:}')}")
private?Map?map1;
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map2:}')}")
private?Map?map2;

四、后續(xù)

以上就是本文的全部內(nèi)容，利用 EL 表達(dá)式、甚至是自己的解析方法，可以讓我們更加方便的配置和使用 Collection 類型的配置文件。

特別注意的是 @Value 注解不能和 @AllArgsConstructor 注解同時使用，否則會報(bào)錯

Consider?defining?a?bean?of?type?'java.lang.String'?in?your?configuration

這種做法唯一不優(yōu)雅的地方就是，這樣寫出來的 @Value 的內(nèi)容都很長，既不美觀，也不容易閱讀。后續(xù)我將為大家介紹下利用 AST(抽象語法樹) 和自定義注解來更加方便的實(shí)現(xiàn)這一功能，敬請期待！