SpringBoot中的@Value註解用法
一、前言
在日常開發中,經常會遇到需要在配置文件中,存儲 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();
可以看見,這種方式十分的不方便,最大的問題是配置和代碼高耦合瞭,增加一個配置,還需要對配置類做增減改動。
二、數組怎麼樣
數組?說實話,業務代碼寫多瞭,這個“古老”的數據結構遠遠沒有 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;
如上所示,即為最終的版本,它具有數組方式的全部優點,且更容易在業務代碼中去應用。
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;
四、後續
以上就是本文的全部內容,利用 EL 表達式、甚至是自己的解析方法,可以讓我們更加方便的配置和使用 Collection 類型的配置文件。
特別註意的是 @Value 註解不能和 @AllArgsConstructor 註解同時使用,否則會報錯
Consider defining a bean of type 'java.lang.String' in your configuration
這種做法唯一不優雅的地方就是,這樣寫出來的 @Value 的內容都很長,既不美觀,也不容易閱讀。
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。
推薦閱讀:
- SpringMvc接受請求參數的幾種情況演示
- SpringBoot如何讀取配置文件中的數據到map和list
- 詳細介紹Java函數式接口
- 一文帶你深入瞭解Java泛型
- 淺談Java中ArrayList線程不安全怎麼辦