SpringBoot @Value 读取配置,太强大了

简介: SpringBoot @Value 读取配置,太强大了

一、前言

 

在日常开发中,经常会遇到需要在配置文件中,存储 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 时候程序报错:

 

1. @Value("#{'${test.list:}'.split(',')}")  
2. 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 的内容都很长,既不美观,也不容易阅读。

相关文章
|
9月前
|
存储 搜索推荐 Java
6 种方式读取 Springboot 的配置(原理+实战)
从配置文件中获取属性应该是SpringBoot开发中最为常用的功能之一,但就是这么常用的功能,仍然有很多开发者在这个方面踩坑。 我整理了几种获取配置属性的方式,目的不仅是要让大家学会如何使用,更重要的是弄清配置加载、读取的底层原理,一旦出现问题可以分析出其症结所在,而不是一报错取不到属性,无头苍蝇般的重启项目,在句句卧槽中逐渐抓狂~
437 0
|
9月前
|
Java API Spring
SpringBoot中“@SpringBootApplication“自动配置原理《第七课》
SpringBoot中“@SpringBootApplication“自动配置原理《第七课》
107 0
|
10月前
|
存储 搜索推荐 Java
6 种方式读取 Springboot 的配置,老鸟都这么玩(原理+实战)
6 种方式读取 Springboot 的配置,老鸟都这么玩(原理+实战)
322 0
6 种方式读取 Springboot 的配置,老鸟都这么玩(原理+实战)
|
11月前
|
Java Maven 数据格式
小白救星-SpringBoot最简教程03: springboot 读取 yml 配置
springboot 读取 yml 配置的几种方式。
514 0
|
11月前
|
Java 容器 Spring
SpringBoot简明教程 - 自动配置原理
SpringBoot简明教程 - 自动配置原理
109 0
SpringBoot简明教程 - 自动配置原理
|
XML Java 数据格式
Springboot读取配置的10种方式
Spring Boot 读取配置文件的方式有很多,下面介绍 10 种常用方式以及相应的示例和解析。
272 0
|
Java Maven Spring
springboot配置不同环境读取不同文件
以下是本人暂时了解的知识,写出来用于笔记同时方便大家使用。如有问题之处,欢迎朋友指正。
141 0
springboot配置不同环境读取不同文件
|
存储 Java 应用服务中间件
SpringBoot2.x系列教程04--SpringBoot花样配置之自定义Web端口及开启日志功能
前言 上一章节中,壹哥 带各位玩了个花样配置,设置了一个自定义的Banner图,而且 壹哥 还给各位留了个作业,让大家设计一个苍老师的图片给我看看,是不是都设计好了呢?别忘了发给我共享哦。 今天 壹哥 带各位再学习其他的一些花样技巧,比如设置自定义的Web端口号,启动Log日志功能等,这些可不是花架子了哦,这些都是很有用的实战技巧,这些都是我们项目开发时必须配置的设置。 一. 修改端口号和访问路径 我们知道,在任何一个Web项目中,都需要设置一个Web端口号,比如80、8080、8081等端口号。有的小伙伴说,我就没设置过端口号也没问题啊!你没配置过,那是因为使用的是默认的80或者8080端
226 0
|
存储 JSON 安全
SpringBoot @Value 读取配置,太好用了!
在日常开发中,经常会遇到需要在配置文件中,存储 List 或是 Map 这种类型的数据。
|
前端开发 Java
Springboot2.x实现文件上传下载的功能(非常实用的小例子)
文件的上传下载功能算是一个比较常用的功能
348 0
Springboot2.x实现文件上传下载的功能(非常实用的小例子)