SpringBoot如何使用@Value取配置文件中的map配置
使用@Value取配置文件中的map配置
在springboot項(xiàng)目中,使用application.properties配置文件,然后需要配置一個(gè)map類型的配置,然后在程序的其他地方獲取這個(gè)配置。
配置內(nèi)容
fyk.db-script.check-sql.[1-FYK_PROPERTIES-DQL]=select case when exists(select 1 from all_tables t where t.TABLE_NAME = upper('fyk_properties')) then 1 else 0 end as result from dual fyk.db-script.check-sql.[2-FYK_PROPERTIES-DML-fyk-oauth]=select case when exists(select 1 from fyk_properties t where t.application='fyk-oauth') then 1 else 0 end as result from dual
注意:如果Map類型的key包含非字母數(shù)字和-的字符,需要用[]括起來,否則不需要使用中括號。
使用配置類的形式獲取
建立一個(gè)配置類:
@Data @ConfigurationProperties(prefix = "fyk.db-script") public class CheckSqlProperties { private Map<String, String> checkSql; }
此時(shí)debug代碼,可以看到是取到了配置的值:
但是,如果把以上取配置的方式,改成@Value的形式:
@Value("${fyk.db-script.check-sql}") private Map<String, String> checkSql;
此時(shí)項(xiàng)目無法啟動(dòng),提示找不到該配置。不曉得是不是哪里錯(cuò)了,如果有知道的,望指教一二?。?!
使用@Value的方式獲取
要使用@Value的方式獲取,首先配置文件中,配置的方式要改下,如下:
fyk.db-script.check-sql={\ "1-FYK_PROPERTIES-DQL":"select case when exists(select 1 from all_tables t where t.TABLE_NAME = upper('fyk_properties')) then 1 else 0 end as result from dual",\ "2-FYK_PROPERTIES-DML-fyk-oauth":"select case when exists(select 1 from fyk_properties t where t.application='fyk-oauth') then 1 else 0 end as result from dual"\ }
注意:如果Map類型的key包含非字母數(shù)字和-的字符,需要用引號括起來,否則不需要使用引號(建議都用上引號);value值,都必須要用引號括起來。
在使用該配置的地方,使用@Value的使用獲?。?/p>
@Value("#{${fyk.db-script.check-sql}}") private Map<String, String> checkSql;
此時(shí)debug代碼,可以看到是取到了配置的值:
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)我們想要在程序中使用時(shí)候,想當(dāng)然的使用 @Value
注解去讀取這個(gè)值,就像下面這種寫法一樣:
@Value("${test.list}") private List<String> testList;
你會發(fā)現(xiàn)程序直接報(bào)錯(cuò)了,報(bào)錯(cuò)信息如下:
java.lang.IllegalArgumentException: Could not resolve placeholder 'test.list' in value "${test.list}"
這個(gè)問題也是可以解決的,以我們要配置的 key 為 test.list
為例,新建一個(gè) test
的配置類,將 list
作為該配置類的一個(gè)屬性:
@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; } }
在程序其他地方使用時(shí)候。采用自動(dòng)注入的方式,去獲取值:
@Autowired private TestListConfig testListConfig; // testListConfig.getList();
可以看見,這種方式十分的不方便,最大的問題是配置和代碼高耦合了,增加一個(gè)配置,還需要對配置類做增減改動(dòng)。
數(shù)組怎么樣
數(shù)組?說實(shí)話,業(yè)務(wù)代碼寫多了,這個(gè)“古老”的數(shù)據(jù)結(jié)構(gòu)遠(yuǎn)遠(yuǎn)沒有 list 用的多,但是它在解決上面這個(gè)問題上,出乎異常的好用。
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;
僅僅多了一個(gè) :
號,冒號后的值表示當(dāng) key 不存在時(shí)候使用的默認(rèn)值,使用默認(rèn)值時(shí)數(shù)組的 length = 0。
總結(jié)下使用數(shù)組實(shí)現(xiàn)的優(yōu)缺點(diǎn):
「優(yōu)點(diǎn)」 :
- 不需要寫配置類
- 使用逗號分割,一行配置,即可完成多個(gè)數(shù)值的注入,配置文件更加精簡
「缺點(diǎn)」 :
- 業(yè)務(wù)代碼中數(shù)組使用很少,基本需要將其轉(zhuǎn)換為 List,去做 contains、foreach 等操作。
替代方法
那么我們有沒有辦法,在解析 list、map 這些類型時(shí),像數(shù)組一樣方便呢?
答案是可以的,這就依賴于 EL
表達(dá)式。
解析 List
以使用 .yml
文件為例,我們只需要在配置文件中,跟配置數(shù)組一樣去配置:
test: list: aaa,bbb,ccc
在調(diào)用時(shí),借助 EL
表達(dá)式的 split()
函數(shù)進(jìn)行切分即可。
@Value("#{'${test.list}'.split(',')}") private List<String> testList;
同樣,為它加上默認(rèn)值,避免不配置這個(gè) key 時(shí)候程序報(bào)錯(cuò):
@Value("#{'${test.list:}'.split(',')}") private List<String> testList;
但是這樣有個(gè)問題,當(dāng)不配置該 key 值,默認(rèn)值會為空串,它的 length = 1(不同于數(shù)組,length = 0),這樣解析出來 list 的元素個(gè)數(shù)就不是空了。
這個(gè)問題比較嚴(yán)重,因?yàn)樗鼤?dǎo)致代碼中的判空邏輯執(zhí)行錯(cuò)誤。這個(gè)問題也是可以解決的,在 split()
之前判斷下是否為空即可。
@Value("#{'${test.list:}'.empty ? null : '${test.list:}'.split(',')}") private List<String> testList;
如上所示,即為最終的版本,它具有數(shù)組方式的全部優(yōu)點(diǎn),且更容易在業(yè)務(wù)代碼中去應(yīng)用。
解析 Set
解析 Set 和解析 List 本質(zhì)上是相同的,唯一的區(qū)別是 Set 會做去重操作。
test: set: 111,222,333,111
@Value("#{'${test.set:}'.empty ? null : '${test.set:}'.split(',')}") private Set<Integer> testSet; // output: [111, 222, 333]
解析 Map
解析 Map 的寫法如下所示,value 為該 map 的 JSON 格式,注意這里使用的引號:整個(gè) JSON 串使用引號包裹,value 值使用引號包裹。
test: map1: '{"name": "zhangsan", "sex": "male"}' map2: '{"math": "90", "english": "85"}'
在程序中,利用 EL 表達(dá)式注入:
@Value("#{${test.map1}}") private Map<String,String> map1; @Value("#{${test.map2}}") private Map<String,Integer> map2;
注意,使用這種方式,必須得在配置文件中配置該 key 及其 value。我在網(wǎng)上找了許多資料,都沒找到利用 EL 表達(dá)式支持不配置 key/value 的寫法。
如果你真的很需要這個(gè)功能,就得自己寫解析方法了,這里以使用 fastjson 進(jìn)行解析為例:
(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;
后續(xù)
以上就是本文的全部內(nèi)容,利用 EL 表達(dá)式、甚至是自己的解析方法,可以讓我們更加方便的配置和使用 Collection 類型的配置文件。
特別注意的是 @Value
注解不能和 @AllArgsConstructor
注解同時(shí)使用,否則會報(bào)錯(cuò)
Consider defining a bean of type 'java.lang.String' in your configuration
這種做法唯一不優(yōu)雅的地方就是,這樣寫出來的 @Value
的內(nèi)容都很長,既不美觀,也不容易閱讀。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot基于Minio實(shí)現(xiàn)分片上傳、斷點(diǎn)續(xù)傳的實(shí)現(xiàn)
本文主要介紹了SpringBoot基于Minio實(shí)現(xiàn)分片上傳、斷點(diǎn)續(xù)傳的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-08-08mybatisplus中EntityWrapper的常用方法
這篇文章主要介紹了mybatisplus中EntityWrapper的常用方法,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03logback FixedWindowRollingPolicy固定窗口算法重命名文件滾動(dòng)策略
這篇文章主要介紹了FixedWindowRollingPolicy根據(jù)logback 固定窗口算法重命名文件滾動(dòng)策略源碼解讀,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11java.lang.AbstractMethodError: org.apache.xerces.dom.Documen
這篇文章主要介紹了java.lang.AbstractMethodError: org.apache.xerces.dom.DocumentImpl.setXmlVersion問題解決方法,導(dǎo)致本文問題的原因是缺少一個(gè)xerces.jar jar包,需要的朋友可以參考下2015-03-03SpringBoot Redis實(shí)現(xiàn)接口冪等性校驗(yàn)方法詳細(xì)講解
這篇文章主要介紹了SpringBoot Redis實(shí)現(xiàn)接口冪等性校驗(yàn)方法,近期一個(gè)老項(xiàng)目出現(xiàn)了接口冪等性校驗(yàn)問題,前端加了按鈕置灰,依然被人拉著接口參數(shù)一頓輸出,還是重復(fù)調(diào)用了接口,通過復(fù)制粘貼,完成了后端接口冪等性調(diào)用校驗(yàn)2022-11-1110個(gè)Java程序員熟悉的面向?qū)ο笤O(shè)計(jì)原則
這篇文章主要為大家詳細(xì)介紹了Java程序員應(yīng)當(dāng)知道的10個(gè)面向?qū)ο笤O(shè)計(jì)原則,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-03-03