@Value注入List、数组、Set、Map问题

 更新时间:2023年07月28日 09:03:55   作者:wuychn  
这篇文章主要介绍了@Value注入List、数组、Set、Map问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

注入List

在日常开发中,经常会遇到需要在配置文件中,存储 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 testList;  

你会发现程序直接报错了,报错信息如下:

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

这个问题也是可以解决的,以我们要配置的 key 为 test.list 为例,新建一个 test 的配置类,将 list 作为该配置类的一个属性:

@Data
@Configuration  
@ConfigurationProperties("test")  
public class TestListConfig {  
    private 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 等操作。

使用EL表达式解析配置

那么我们有没有办法,在解析 list、map 这些类型时,像数组一样方便呢?

答案是可以的,这就依赖于 EL 表达式。

解析List

以使用 .yml 文件为例,我们只需要在配置文件中,跟配置数组一样去配置:

test:  
  list: aaa,bbb,ccc  

在调用时,借助 EL 表达式的 split() 函数进行切分即可:

@Value("#{'${test.list}'.split(',')}")  
private List testList;  

同样,为它加上默认值,避免不配置这个 key 时候程序报错:

@Value("#{'${test.list:}'.split(',')}")  
private List testList;  

但是这样有个问题,当不配置该 key 值,默认值会为空串,它的 length = 1(不同于数组,length = 0),这样解析出来 list 的元素个数就不是空了。

这个问题比较严重,因为它会导致代码中的判空逻辑执行错误。

这个问题也是可以解决的,在 split() 之前判断下是否为空即可:

@Value("#{'${test.list:}'.empty ? null : '${test.list:}'.split(',')}")  
private List testList;  

 如上所示,即为最终的版本,它具有数组方式的全部优点,且更容易在业务代码中去应用。

解析 Set

解析 Set 和解析 List 本质上是相同的,唯一的区别是 Set 会做去重操作。

test:  
  set: 111,222,333,111  
@Value("#{'${test.set:}'.empty ? null : '${test.set:}'.split(',')}")  
private Set testSet;  
// output: [111, 222, 333]  

解析Map

解析 Map 的写法如下所示,value 为该 map 的 JSON 格式,注意这里使用的引号:整个 JSON 串使用引号包裹,value 值使用引号包裹。

test:  
  map1: '{"name": "zhangsan", "sex": "male"}'  
  map2: '{"math": "90", "english": "85"}'  

在程序中,利用 EL 表达式注入:

@Value("#{${test.map1}}")  
private Map map1;  
@Value("#{${test.map2}}")  
private Map map2;  

注意,使用这种方式,必须得在配置文件中配置该 key 及其 value。

如果你真的很需要这个功能,就得自己写解析方法了,这里以使用 fastjson 进行解析为例:

自定义解析方法:

public class MapDecoder {  
    public static Map decodeMap(String value) {  
        try {  
            return JSONObject.parseObject(value, new TypeReference>(){});  
        } catch (Exception e) {
            return null;  
        }  
    }  
}  

在程序中指定解析方法:

@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map1:}')}")  
private Map map1;  
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map2:}')}")  
private Map map2;  

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Netty分布式获取异线程释放对象源码剖析

    Netty分布式获取异线程释放对象源码剖析

    这篇文章主要为大家介绍了Netty分布式获取异线程释放的对象源码剖析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步早日升职加薪
    2022-03-03
  • Spring 中优雅的获取泛型信息的方法

    Spring 中优雅的获取泛型信息的方法

    这篇文章主要介绍了Spring 中优雅的获取泛型信息的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • Maven依赖冲突原因以及解决方法

    Maven依赖冲突原因以及解决方法

    依赖冲突是指项目依赖的某一个 jar 包,有多个不同的版本,因而造成类包版本冲突依赖冲突很经常是类包之间的间接依赖引起的,本文将给大家介绍Maven依赖冲突原因以及解决方法,需要的朋友可以参考下
    2023-12-12
  • 浅析SpringBoot自动装配的实现

    浅析SpringBoot自动装配的实现

    springboot开箱即用,其实实现了自动装配,本文重点给大家介绍SpringBoot是如何做到自动装配的,感兴趣的朋友跟随小编一起看看吧
    2022-02-02
  • Java设计模式之状态模式State Pattern详解

    Java设计模式之状态模式State Pattern详解

    这篇文章主要介绍了Java设计模式之状态模式State Pattern,状态模式允许一个对象在其内部状态改变的时候改变其行为。这个对象看上去就像是改变了它的类一样
    2022-11-11
  • Java 单向队列及环形队列的实现原理

    Java 单向队列及环形队列的实现原理

    本文主要介绍了Java 单向队列及环形队列的实现原理,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-10-10
  • Java中==符号与equals()的使用详解(测试两个变量是否相等)

    Java中==符号与equals()的使用详解(测试两个变量是否相等)

    下面小编就为大家带来一篇Java中==符号与equals()的使用详解(测试两个变量是否相等)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • java使用FFmpeg提取音频的实现示例

    java使用FFmpeg提取音频的实现示例

    在Java开发中,我们经常会遇到需要使用FFmpeg来处理音视频文件的情况,本文主要介绍了java使用FFmpeg提取音频的实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • spring boot上传文件出错问题如何解决

    spring boot上传文件出错问题如何解决

    这篇文章主要介绍了spring boot上传文件出错问题如何解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • 基于Java实现空间滤波完整代码

    基于Java实现空间滤波完整代码

    空间滤波是一种采用滤波处理的影像增强方法。其理论基础是空间卷积和空间相关。这篇文章主要介绍了基于Java的空间滤波代码实现,需要的朋友可以参考下
    2021-08-08

最新评论