SpringBoot@Value解析集合配置
本⽂作者：Jitwxs
链接：www.jitwxs/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;
// List();
可以看见，这种⽅式⼗分的不⽅便，最⼤的问题是配置和代码⾼耦合了，增加⼀个配置，还需要对配置类做增减改动。
⼆、数组怎么样
数组？说实话，业务代码写多了，这个“古⽼”的数据结构远远没有 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 程序也能正常运⾏的话，给它们加上默认值即可：
el表达式获取值@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 ⽂件为例，我们只需要在配置⽂件中，跟配置数组⼀样去配置：
这个问题⽐较严重，因为它会导致代码中的判空逻辑执⾏错误。这个问题也是可以解决的，在 split() 之前判断下是否为空即可。@Value("#{'${test.list:}'.empty ? null : '${test.list:}'.split(',')}")
解析 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 的内容都很长，既不美观，也不容易阅读。后续我将为⼤家介绍下利⽤ AST(抽象
语法树) 和⾃定义注解来更加⽅便的实现这⼀功能，敬请期待！
- END -
推荐阅读
1.  8⽉撸书|当当花160买400，不撸⽩不撸
2.  两难！到底⽤Apache BeanUtils还是Spring BeanUtils？
3.  Spring的Controller是单例还是多例？怎么保证并发的安全之前
点赞是最⼤的⽀持

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。