Java Spring @Value
@Value注解 - 图1

1、由一个例子开始

假如在UserService类中，需要注入系统属性到userName变量中。通常情况下，会写出如下的代码：

  1. @Service
  2. public class UserService {
  4.     @Value("${fcant.test.userName}")
  5.     private String userName;
  7.     public String test() {
  8.         System.out.println(userName);
  9.         return userName;
  10.     }
  11. }

通过@Value注解指定系统属性的名称fcant.test.userName，该名称需要使用${}包起来。
这样Spring就会自动的把对应的系统属性值，注入到userName变量中。
不过，上面功能的重点是要在applicationContext.properties文件（简称：配置文件）中配置同名的系统属性：

  1. #张三
  2. fcant.test.userName=\u5f20\u4e09

那么，名称真的必须完全相同吗？

2、关于属性名

这时候，有些朋友可能会说：在@ConfigurationProperties配置类中，定义的参数名可以跟配置文件中的系统属性名不同。
比如，在配置类MyConfig类中定义的参数名是userName：

  1. @Configuration
  2. @ConfigurationProperties(prefix = "fcant.test")
  3. @Data
  4. public class MyConfig {
  5.     private String userName;
  6. }

而配置文件中配置的系统属性名是：

  1. fcant.test.user-name=\u5f20\u4e09

类中用的userName，而配置文件中用的user-name，不一样。但测试之后，发现该功能能够正常运行。
配置文件中的系统属性名用 驼峰标识 或 小写字母加中划线的组合，Spring都能找到配置类中的属性名userName进行赋值。
由此可见，配置文件中的系统属性名，可以跟配置类中的属性名不一样。不过，有个前提，前缀fcant.test必须相同。
那么，@Value注解中定义的系统属性名也可以不一样吗？
答案：不能。如果不一样，启动项目时会直接报错。
@Value注解 - 图2此外，如果只在@Value注解中指定了系统属性名，但实际在配置文件中没有配置它，也会报跟上面一样的错。
所以，@Value注解中指定的系统属性名，必须跟配置文件中的相同。

3、乱码问题

这里配置的属性值：张三，其实是转义过的。

  1. fcant.test.userName=\u5f20\u4e09

为什么要做这个转义？
假如在配置文件中配置中文的张三：

  1. fcant.test.userName=张三

最后获取数据时，会发现userName竟然出现了乱码：
å¼ ä¸‰
what？
为什么会出现乱码？
答：在SpringBoot的CharacterReader类中，默认的编码格式是ISO-8859-1，该类负责.properties文件中系统属性的读取。如果系统属性包含中文字符，就会出现乱码。
@Value注解 - 图3那么，如何解决乱码问题呢？
目前主要有如下三种方案：

  1. 手动将ISO-8859-1格式的属性值，转换成UTF-8格式。
  2. 设置encoding参数，不过这个只对@PropertySource注解有用。
  3. 将中文字符用unicode编码转义。

显然@Value不支持encoding参数，所以方案2不行。
假如使用方案1，具体实现代码如下：

  1. @Service
  2. public class UserService {
  4.     @Value(value = "${fcant.test.userName}")
  5.     private String userName;
  7.     public String test() {
  8.         String userName1 = new String(userName.getBytes(StandardCharsets.ISO_8859_1), StandardCharsets.UTF_8);
  9.         System.out.println();
  10.         return userName1;
  11.     }
  12. }

确实可以解决乱码问题。
但如果项目中包含大量中文系统属性值，每次都需要加这样一段特殊转换代码。出现大量重复代码，有没有觉得有点恶心？
那么，如何解决代码重复问题呢？
答：将属性值的中文内容转换成unicode。
类似于这样的：

  1. fcant.test.userName=\u5f20\u4e09

这种方式同样能解决乱码问题，不会出现恶心的重复代码。但需要做一点额外的转换工作，不过这个转换非常容易，因为有现成的在线转换工具。
推荐使用这个工具转换：http://www.jsons.cn/unicode/
如果使用的是.yml或.yaml格式的配置文件，并不会出现中文乱码问题。
这又是为什么？
因为.yml或.yaml格式的配置文件，最终会使用UnicodeReader类进行解析，它的init方法中，首先读取BOM文件头信息，如果头信息中有UTF8、UTF16BE、UTF16LE，就采用对应的编码，如果没有，则采用默认UTF8编码。
@Value注解 - 图4
需要注意的是：乱码问题一般出现在本地环境，因为本地直接读取的.properties配置文件。在dev、test、生产等环境，如果从zookeeper、apollo、nacos等配置中心中获取系统参数值，走的是另外的逻辑，并不会出现乱码问题。

4、默认值

有时候，默认值是非常头疼的问题。
为什么这样说呢？
因为很多时候使用java的默认值，并不能满足日常工作需求。
比如有这样一个需求：如果配置了系统属性，userName就用配置的属性值。如果没有配置，则userName用默认值fcant。
有些朋友可能认为可以这样做：

  1. @Value(value = "${fcant.test.userName}")
  2. private String userName = "fcant";

在定义参数时直接给个默认值，但如果仔细想想这招是行不通的的。因为设置userName默认值的时机，比@Value注解依赖注入属性值要早，也就是说userName初始化好了默认值，后面还是会被覆盖。
那么，到底该如何设置默认值呢？
答：使用:。
例如：

  1. @Value(value = "${fcant.test.userName:fcant}")
  2. private String userName;

在需要设置默认值的系统属性名后，加:符号。紧接着，在:右边设置默认值。
建议大家平时在使用@Value时，尽量都设置一个默认值。如果不需要默认值，宁可设置一个空。比如：

  1. @Value(value = "${fcant.test.userName:}")
  2. private String userName;

为什么这么说？
假如有这种场景：在business层中包含了UserService类，business层被api服务和job服务都引用了。但UserService类中@Value的userName只在api服务中有用，在job服务中根本用不到该属性。
对于job服务来说，如果不在.properties文件中配置同名的系统属性，则服务启动时就会报错。
这个坑，之前踩过多次。所以，建议大家，使用@Value注解时，最好给参数设置一个默认值，以防止出现类似的问题。

5、static变量

前面已经见识过，如何使用@Value注解，给类的成员变量注入系统属性值。
那么，问题来了，静态变量可以自动注入系统属性值不？
一起看看，假如将上面的userName定义成static的：

  1. @Value("${fcant.test.userName}")
  2. private static String userName;

程序可以正常启动，但是获取到userName的值却是null。
由此可见，被static修饰的变量通过@Value会注入失败。
此时肯定想问：如何才能给静态变量注入系统属性值呢？
答：这就需要使用如下的代码了：

  1. @Service
  2. public class UserService {
  4.     private static String userName;
  6.     @Value("${fcant.test.userName}")
  7.     public void setUserName(String userName) {
  8.         UserService.userName = userName;
  9.     }
  11.     public String test() {
  12.         return userName;
  13.     }
  14. }

提供一个静态参数的setter方法，在该方法上使用@Value注入属性值，并且同时在该方法中给静态变量赋值。
有些细心的朋友可能会发现，@Value注解在这里竟然使用在setUserName方法上了，也就是对应的setter方法，而不是在变量上。
不过，通常情况下，一般会在pojo实体类上，使用lombok的@Data、@Setter、@Getter等注解，在编译时动态增加setter或getter方法，所以@Value用在方法上的场景其实不多。

6、变量类型

上面的内容，都是用的字符串类型的变量进行举例的。其实，@Value注解还支持其他多种类型的系统属性值的注入。

6.1 基本类型

众所周知，在Java中的基本数据类型有4类8种，一起回顾一下：

  • 整型：byte、short、int、long
  • 浮点型：float、double
  • 布尔型：boolean
  • 字符型：char

相对应地提供了8种包装类：

  • 整型：Byte、Short、Integer、Long
  • 浮点型：Float、Double
  • 布尔型：Boolean
  • 字符型：Character

@Value注解对这8中基本类型和相应的包装类，有非常良好的支持，例如：

  1. @Value("${fcant.test.a:1}")
  2. private byte a;
  4. @Value("${fcant.test.b:100}")
  5. private short b;
  7. @Value("${fcant.test.c:3000}")
  8. private int c;
  10. @Value("${fcant.test.d:4000000}")
  11. private long d;
  13. @Value("${fcant.test.e:5.2}")
  14. private float e;
  16. @Value("${fcant.test.f:6.1}")
  17. private double f;
  19. @Value("${fcant.test.g:false}")
  20. private boolean g;
  22. @Value("${fcant.test.h:h}")
  23. private char h;
  25. @Value("${fcant.test.a:1}")
  26. private byte a1;
  28. @Value("${fcant.test.b:100}")
  29. private Short b1;
  31. @Value("${fcant.test.c:3000}")
  32. private Integer c1;
  34. @Value("${fcant.test.d:4000000}")
  35. private Long d1;
  37. @Value("${fcant.test.e:5.2}")
  38. private Float e1;
  40. @Value("${fcant.test.f:6.1}")
  41. private Double f1;
  43. @Value("${fcant.test.g:false}")
  44. private Boolean g1;
  46. @Value("${fcant.test.h:h}")
  47. private Character h1;

有了这些常用的数据类型，在定义变量类型时，可以非常愉快的玩耍了，不用做额外的转换。

6.2 数组

但只用上面的基本类型是不够的，特别是很多需要批量处理数据的场景中。这时候可以使用数组，它在日常开发中使用的频率很高。
在定义数组时可以这样写：

  1. @Value("${fcant.test.array:1,2,3,4,5}")
  2. private int[] array;

Spring默认使用逗号分隔参数值。
如果用空格分隔，例如：

  1. @Value("${fcant.test.array:1 2 3 4 5}")
  2. private int[] array;

Spring会自动把空格去掉，导致数据中只有一个值：12345，注意千万别搞错了。
顺便说一下，定义数组的时候，里面还是有挺多门道的。比如上面列子中，数据是：1,2,3,4,5。
如果把数组定义成：short、int、long、char、string类型，Spring是可以正常注入属性值的。
但如果把数组定义成：float、double类型，启动项目时就会直接报错。
@Value注解 - 图5
按理说，1,2,3,4,5用float、double是能够表示的呀，为什么会报错？
如果使用int的包装类，比如：

  1. @Value("${fcant.test.array:1,2,3,4,5}")
  2. private Integer[] array;

启动项目时同样会报上面的异常。
此外，定义数组时一定要注意属性值的类型，必须完全一致才可以，如果出现下面这种情况：

  1. @Value("${fcant.test.array:1.0,abc,3,4,5}")
  2. private int[] array;

属性值中包含了1.0和abc，显然都无法将该字符串转换成int。

6.3 集合类

有了基本类型和数组，的确更加方便了。但对数据的处理，只用数组这一种数据结构是远远不够的，下面给大家介绍一下其他的常用数据结构。

6.3.1 List

List是数组的变种，它的长度是可变的，而数组的长度是固定的。
看看List是如何注入属性值的：

  1. @Value("${fcant.test.list}")
  2. private List<String> list;

最关键的是看配置文件：

  1. fcant.test.list[0]=10
  2. fcant.test.list[1]=11
  3. fcant.test.list[2]=12
  4. fcant.test.list[3]=13

启动项目，准备使用这个功能的时候，却发现竟然报错了。
@Value注解 - 图6what?
看来@Value不支持这种直接的List注入。
那么，如何解决这个问题呢？
有人说用@ConfigurationProperties。
需要定义一个MyConfig类：

  1. @Configuration
  2. @ConfigurationProperties(prefix = "fcant.test")
  3. @Data
  4. public class MyConfig {
  5.     private List<String> list;
  6. }

然后在调用的地方这样写：

  1. @Service
  2. public class UserService {
  4.     @Autowired
  5.     private MyConfig myConfig;
  7.     public String test() {
  8.         System.out.println(myConfig.getList());
  9.         return null;
  10.     }
  11. }

这种方法确实能够完成List注入。但是，只能说明@ConfigurationProperties注解的强大，跟@Value有半毛钱的关系？
答：没有。
那么，问题来了，用@Value如何实现这个功能呢？
答：使用Spring的EL表达式。
List的定义改成：

  1. @Value("#{'${fcant.test.list}'.split(',')}")
  2. private List<String> list;

使用#号加大括号的EL表达式。
然后配置文件改成：

  1. fcant.test.list=10,11,12,13

跟定义数组时的配置文件一样。

6.3.2 Set

Set也是一种保存数据的集合，它比较特殊，里面保存的数据不会重复。
可以这样定义Set：

  1. @Value("#{'${fcant.test.set}'.split(',')}")
  2. private Set<String> set;

配置文件是这样的：

  1. fcant.test.set=10,11,12,13

Set跟List的用法极为相似。
如何给List或者Set设置默认值空呢？
有些朋友可能会说：这还不简单，直接在@Value的$表达式后面加个:号不就行了。
具体代码如下：

  1. @Value("#{'${fcant.test.set:}'.split(',')}")
  2. private Set<String> set;

结果却跟想象中不太一样：@Value注解 - 图7Set集合怎么不是空的，而是包含了一个空字符串的集合？
好吧，那在:号后加null，总可以了吧？@Value注解 - 图8Set集合也不是空的，而是包含了一个”null”字符串的集合。
这也不行，那也不行，该如何是好？
答：使用EL表达式的empty方法。
具体代码如下：

  1. @Value("#{'${fcant.test.set:}'.empty ? null : '${fcant.test.set:}'.split(',')}")
  2. private Set<String> set;

运行之后，结果对了：@Value注解 - 图9
其实List也有类似的问题，也能使用该方法解决问题。
在这里温馨的提醒一下，该判断的表达式比较复杂，自己手写非常容易写错，建议复制粘贴之后根据实际需求改改。

6.3.3 Map

还有一种比较常用的集合是map，它支持key/value键值对的形式保存数据，并且不会出现相同key的数据。
可以这样定义Map：

  1. @Value("#{${fcant.test.map}}")
  2. private Map<String, String> map;

配置文件是这样的：

  1. fcant.test.map={"name":"fcant", "age":"18"}

这种用法跟上面稍微有一点区别。
设置默认值的代码如下：

  1. @Value("#{'${fcant.test.map:}'.empty ? null : '${fcant.test.map:}'}")
  2. private Map<String, String> map;

7、EL高端玩法

前面已经见识过Spring EL表达式的用法了，在设置空的默认值时特别有用。
其实，empty方法只是它很普通的用法，还有更高端的用法，一起看看。

7.1 注入bean

以前注入bean，一般都是用的@Autowired或者@Resource注解。例如：

  1. @Service
  2. public class RoleService {
  3.     public String getRoleName() {
  4.         return "管理员";
  5.     }
  6. }
  8. @Service
  9. public class UserService {
  11.     @Autowired
  12.     private RoleService roleService;
  14.     public String test() {
  15.         System.out.println(roleService.getRoleName());
  16.         return null;
  17.     }
  18. }

@Value注解也可以注入bean，它是这么做的：

  1. @Value("#{roleService}")
  2. private RoleService roleService;

通过这种方式，可以注入id为roleService的bean。

7.2 bean的变量和方法

通过EL表达式，@Value注解已经可以注入bean了。既然能够拿到bean实例，接下来，可以再进一步。
在RoleService类中定义了：成员变量、常量、方法、静态方法。

  1. @Service
  2. public class RoleService {
  3.     public static final int DEFAULT_AGE = 18;
  4.     public int id = 1000;
  6.     public String getRoleName() {
  7.         return "管理员";
  8.     }
  10.     public static int getParentId() {
  11.         return 2000;
  12.     }
  13. }

在调用的地方这样写：

  1. @Service
  2. public class UserService {
  4.     @Value("#{roleService.DEFAULT_AGE}")
  5.     private int myAge;
  7.     @Value("#{roleService.id}")
  8.     private int id;
  10.     @Value("#{roleService.getRoleName()}")
  11.     private String myRoleName;
  13.     @Value("#{roleService.getParentId()}")
  14.     private String myParentId;
  16.     public String test() {
  17.         System.out.println(myAge);
  18.         System.out.println(id);
  19.         System.out.println(myRoleName);
  20.         System.out.println(myParentId);
  21.         return null;
  22.     }
  23. }

在UserService类中通过@Value可以注入：成员变量、常量、方法、静态方法获取到的值，到相应的成员变量中。
一下子有没有豁然开朗的感觉，有了这些，可以通过@Value注解，实现更多的功能了，不仅仅限于注入系统属性。

7.3 静态类

前面的内容都是基于bean的，但有时需要调用静态类，比如：Math、xxxUtil等静态工具类的方法，该怎么办呢？
答：用T加括号。
示例1：

  1. @Value("#{T(java.io.File).separator}")
  2. private String path;

可以注入系统的路径分隔符到path中。
示例2：

  1. @Value("#{T(java.lang.Math).random()}")
  2. private double randomValue;

可以注入一个随机数到randomValue中。

7.4 逻辑运算

通过上面介绍的内容，可以获取到绝大多数类的变量和方法的值了。但有了这些值，还不够，能不能在EL表达式中加点逻辑？
拼接字符串：

  1. @Value("#{roleService.roleName + '' + roleService.DEFAULT_AGE}")
  2. private String value;

逻辑判断：

  1. @Value("#{roleService.DEFAULT_AGE > 16 and roleService.roleName.equals('Fcant')}")
  2. private String operation;

三目运算：

  1. @Value("#{roleService.DEFAULT_AGE > 16 ? roleService.roleName: 'Fcant' }")
  2. private String realRoleName;

还有很多很多功能，就不一一列举了。EL表达式实在太强大了。

8、${}和#{}的区别

上面说了这么多@Value的用法，归根揭底就是${}和#{}的用法。
下面重点说说${}和#{}的区别，这可能是很多小伙伴比较关心的话题。

8.1 ${}

主要用于获取配置文件中的系统属性值。
例如：

  1. @Value(value = "${fcant.test.userName:fcant}")
  2. private String userName;

通过:可以设置默认值。如果在配置文件中找不到fcant.test.userName的配置，则注入时用默认值。
如果在配置文件中找不到fcant.test.userName的配置，也没有设置默认值，则启动项目时会报错。

8.2 #{}

主要用于通过Spring的EL表达式，获取bean的属性，或者调用bean的某个方法。还有调用类的静态常量和静态方法。

  1. @Value("#{roleService.DEFAULT_AGE}")
  2. private int myAge;
  4. @Value("#{roleService.id}")
  5. private int id;
  7. @Value("#{roleService.getRoleName()}")
  8. private String myRoleName;
  10. @Value("#{T(java.lang.Math).random()}")
  11. private double randomValue;

如果是调用类的静态方法，则需要加T(包名 + 方法名称)。
例如：T(java.lang.Math)。