1、前言

在平常開發中，常常會遇到須要在配置文件中，存儲 List 或是 Map 這種類型的數據。Spring 原生是支持這種數據類型的，以配置 List 類型爲例，對於 .yml 文件配置以下：java

test:
  list:
    - aaa
    - bbb
    - ccc
複製代碼

對於 .properties 文件配置以下所示：git

test.list[0]=aaa
test.list[1]=bbb
test.list[2]=ccc
複製代碼

當咱們想要在程序中使用時候，想固然的使用 @Value 註解去讀取這個值，就像下面這種寫法同樣：github

@Value("${test.list}")
private List<String> testList;
複製代碼

你會發現程序直接報錯了，報錯信息以下：spring

java.lang.IllegalArgumentException: Could not resolve placeholder 'test.list' in value "${test.list}"
複製代碼

這個問題也是能夠解決的，以咱們要配置的 key 爲 test.list 爲例，新建一個 test 的配置類，將 list 做爲該配置類的一個屬性：json

@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();
複製代碼

能夠看見，這種方式十分的不方便，最大的問題是配置和代碼高耦合了，增長一個配置，還須要對配置類作增減改動。markdown

整理的spring學習筆記分享給你們：176頁Spring學習筆記，完整版數據結構

2、數組怎麼樣

數組？說實話，業務代碼寫多了，這個「古老」的數據結構遠遠沒有 list 用的多，可是它在解決上面這個問題上，出乎異常的好用。ide

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 等操做。

3、替代方法

那麼咱們有沒有辦法，在解析 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;
複製代碼

如上所示，即爲最終的版本，它具備數組方式的所有優勢，且更容易在業務代碼中去應用。

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 值使用引號包裹。

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;
複製代碼

4、後續

以上就是本文的所有內容，利用 EL 表達式、甚至是本身的解析方法，可讓咱們更加方便的配置和使用 Collection 類型的配置文件。特別注意的是 @Value 註解不能和 @AllArgsConstructor 註解同時使用，不然會報錯

Consider defining a bean of type 'java.lang.String' in your configuration
複製代碼

這種作法惟一不優雅的地方就是，這樣寫出來的 @Value 的內容都很長，既不美觀，也不容易閱讀。