Springboot中@Value注解

前言
一、使用步骤
- 1.@value注入数组
- 2.@value中注入集合List
- 3.@value中注入Map
总结

前言 springboot项目中有很多数据为了避免硬编码,会将数据写在配置文件中,例:application.yml,bootstrap.yml,applicaiton.properties等等,然后再通过@Value注解读入到项目中

以下是本篇文章正文内容，下面案例可供参考

一、使用步骤 1.@value注入数组

配置文件（示例）：application.yml

test:
  array1: aaa,bbb,ccc
  array2: 111,222,333
  array3: 11.1,22.2,33.3

代码如下（示例）：java代码

@Value("${test.array1}")
private String[] testArray1;

@Value("${test.array2}")
private int[] testArray2;

@Value("${test.array3}")
private double[] testArray3;

一般需要配置文件中存在该配置,项目才会启动成功,如果想要项目没有该配置,也能启动的话,只需稍作修改即可
如下

修改后的java代码（示例）：java代码

@Value("${test.array1:}")
private String[] testArray1;

@Value("${test.array2:}")
private int[] testArray2;

@Value("${test.array3:}")
private double[] testArray3;

仅仅多了一个:号，冒号后的值表示当 key 不存在时候使用的默认值，使用默认值
时数组的 length = 0.

这种配置的优缺点:
优点:
不需要写配置类
使用逗号分割，一行配置，即可完成多个数值的注入，配置文件更加精简

缺点:
业务代码中数组使用很少，基本需要将其转换为 List，去做 contains、foreach 等操作

2.@value中注入集合List

配置文件（示例）：application.yml

test:
  list: aaa,bbb,ccc

代码如下（示例）：java代码

@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;

3.@value中注入Map

配置文件（示例）：application.yml
解析 Map 的写法如下所示，value 为该 map 的 JSON 格式，注意这里使用的引号：整个 JSON
串使用引号包裹，value 值使用引号包裹。

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

代码如下（示例）：java代码
在程序中,利用EL 表达式注入

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

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

注意，使用这种方式，必须得在配置文件中配置该 key 及其 value。我在网上找了许多资料，都没找到利用 EL 表达式支持不配置 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注解处指定解析方法

@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;

总结

以上就是@Value注解的基本用法,你学会了吗.

Springboot中@Value注解

Java相关栏目本月热门文章