本文作者：Jitwxs
鏈接：www.jitwxs.cn/d6d760c4.html
一、前言
在日常開發中，經常會遇到需要在組態檔中，存盤 List 或是 Map 這種型別的資料，
Spring 原生是支持這種資料型別的，以配置 List 型別為例，對于 .yml 檔案配置如下：
test:
list:
- aaa
- bbb
- ccc
對于 .properties 檔案配置如下所示：
test.list[0]=aaa
test.list[1]=bbb
test.list[2]=ccc
當我們想要在程式中使用時候，想當然的使用 @Value 注解去讀取這個值，就像下面這種寫法一樣：
@Value("${test.list}")
private List<String> testList;
你會發現程式直接報錯了，報錯資訊如下：
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<String> list;
public List<String> getList() {
return list;
}
public void setList(List<String> list) {
this.list = list;
}
}
在程式其他地方使用時候，采用自動注入的方式，去獲取值：
@Autowired
private TestListConfig testListConfig;
// testListConfig.getList();
可以看見，這種方式十分的不方便，最大的問題是配置和代碼高耦合了，增加一個配置，還需要對配置類做增減改動，關注公眾號Java技術堆疊可以搜索閱讀Spring Boot更多強大的引數配置和讀取教程，
二、陣列怎么樣
陣列？說實話，業務代碼寫多了，這個“古老”的資料結構遠遠沒有 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 程式也能正常運行的話，給它們加上默認值即可：
@Value("${test.array1:}")
private String[] testArray1;
@Value("${test.array2:}")
private int[] testArray2;
@Value("${test.array3:}")
private double[] testArray3;
僅僅多了一個 : 號，冒號后的值表示當 key 不存在時候使用的默認值，使用默認值時陣列的 length = 0，
總結下使用陣列實作的優缺點：
優點：
-
不需要寫配置類
-
使用逗號分割，一行配置，即可完成多個數值的注入，組態檔更加精簡
缺點：
- 業務代碼中陣列使用很少，基本需要將其轉換為 List，去做 contains、foreach 等操作，
三、替代方法
那么我們有沒有辦法，在決議 list、map 這些型別時，像陣列一樣方便呢？
答案是可以的，這就依賴于 EL 運算式，
3.1 決議 List
以使用 .yml 檔案為例，我們只需要在組態檔中，跟配置陣列一樣去配置：
test:
list: aaa,bbb,ccc
在呼叫時，借助 EL 運算式的 split() 函式進行切分即可，
@Value("#{'${test.list}'.split(',')}")
private List<String> testList;
同樣，為它加上默認值，避免不配置這個 key 時候程式報錯：
@Value("#{'${test.list:}'.split(',')}")
private List<String> testList;
但是這樣有個問題，當不配置該 key 值，默認值會為空串，它的 length = 1（不同于陣列，length = 0），這樣決議出來 list 的元素個數就不是空了，
這個問題比較嚴重，因為它會導致代碼中的判空邏輯執行錯誤，這個問題也是可以解決的，在 split() 之前判斷下是否為空即可，
@Value("#{'${test.list:}'.empty ? null : '${test.list:}'.split(',')}")
private List<String> testList;
如上所示，即為最終的版本，它具有陣列方式的全部優點，且更容易在業務代碼中去應用，執行緒安全的List，這篇推薦看下，
3.2 決議 Set
決議 Set 和決議 List 本質上是相同的，唯一的區別是 Set 會做去重操作，
test:
set: 111,222,333,111
@Value("#{'${test.set:}'.empty ? null : '${test.set:}'.split(',')}")
private Set<Integer> testSet;
// output: [111, 222, 333]
3.3 決議 Map
決議 Map 的寫法如下所示，value 為該 map 的 JSON 格式，注意這里使用的引號：整個 JSON 串使用引號包裹，value 值使用引號包裹，Spring Boot 回傳 JSON 資料，推薦大家看下，
test:
map1: '{"name": "zhangsan", "sex": "male"}'
map2: '{"math": "90", "english": "85"}'
在程式中，利用 EL 運算式注入：
@Value("#{${test.map1}}")
private Map<String,String> map1;
@Value("#{${test.map2}}")
private Map<String,Integer> map2;
注意，使用這種方式，必須得在組態檔中配置該 key 及其 value，我在網上找了許多資料，都沒找到利用 EL 運算式支持不配置 key/value 的寫法，
如果你真的很需要這個功能，就得自己寫決議方法了，這里以使用 fastjson 進行決議為例：
(1) 自定義決議方法
public class MapDecoder {
public static Map<String, String> decodeMap(String value) {
try {
return JSONObject.parseObject(value, new TypeReference<Map<String, String>>(){});
} catch (Exception e) {
return null;
}
}
}
(2) 在程式中指定決議方法
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map1:}')}")
private Map<String, String> map1;
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map2:}')}")
private Map<String, String> map2;
四、后續
以上就是本文的全部內容，利用 EL 運算式、甚至是自己的決議方法，可以讓我們更加方便的配置和使用 Collection 型別的組態檔，
特別注意的是 @Value 注解不能和 @AllArgsConstructor 注解同時使用，否則會報錯
Consider defining a bean of type 'java.lang.String' in your configuration
這種做法唯一不優雅的地方就是，這樣寫出來的 @Value 的內容都很長，既不美觀，也不容易閱讀，
近期熱文推薦：
1.Java 15 正式發布， 14 個新特性，重繪你的認知！！
2.終于靠開源專案弄到 IntelliJ IDEA 激活碼了，真香！
3.我用 Java 8 寫了一段邏輯，同事直呼看不懂，你試試看，，
4.吊打 Tomcat ，Undertow 性能很炸！！
5.《Java開發手冊（嵩山版）》最新發布，速速下載！
覺得不錯，別忘了隨手點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/187022.html
標籤：其他
上一篇：Helm 帶你飛