乐趣区

关于java:SpringBoot-的Value注解太强大了用了都说爽

送大家以下 java 学习材料,文末有支付形式




一、前言

在日常开发中,常常会遇到须要在配置文件中,存储 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 的内容都很长,既不美观,也不容易浏览。

退出移动版