SpringBoot 之 @Value注解从配置文件中读取数组/集合、设置默认值

一、用法

1）配置文件信息(application.yml)：

mybatis:
  plugin:
    ignoreTables: operate_log,audit_config

2）Java自动注入：

@Value("#{'${mybatis.plugin.ignoreTables:}'.split(',')}")
private List<String> ignoreTableList = Collections.emptyList();

注意：mybatis.plugin.ignoreTables:这里的:表示如果没有配置mybatis.plugin.ignoreTables属性，则使其默认为空字符串；不过这里有一个缺陷：ignoreTableList默认情况下会有一个空字符串的数据（对业务上无影响）。

二、@Value设置默认值

使用@Value注解将变量进行自动注入的时候，如果没有在配置文件中配置该参数会导致整个项目报错；这时我们可以通过给被@Value注解作用的变量在注入时设置一个默认值解决整个项目报错的问题；

例如：如果配置文件中没有spring.port属性，则port的默认为8080

@Value("${spring.port:8080}")
private String port;

2、@Value(“#{}”)

我们平时选择使用@Value("${xxx}")自动注入配置文件的属性；

对于非配置文件注入的属性，我们一般使用SpEL（Spring Expression Language）即Spring表达式语言，其可以在运行时查询和操作数据。使用#{…}作为定界符, 所有在大括号中的字符都将被认为是 SpEL。比如：@Value("#{xxx}")

@Value("#{xxx}")的使用场景包括：

/**
 * 注入普通字符串，相当于直接给属性默认值
 */
@Value("程序新视界")
private String wechatSubscription;

/**
 *  注入操作系统属性
 */
@Value("#{systemProperties['os.name']}")
private String systemPropertiesName;

/**
 * 注入表达式结果
 */
@Value("#{ T(java.lang.Math).random() * 100.0 }")
private double randomNumber;

/**
 * 注入其他Bean属性：注入config对象的属性tool
 */
@Value("#{config.tool}")
private String tool;

/**
 * 注入列表形式（自动根据"|"分割）
 */
@Value("#{'${words}'.split('\\|')}")
private List<String> numList;

/**
 * 注入文件资源
 */
@Value("classpath:config.xml")
private Resource resourceFile;

/**
 * 注入URL资源
 */
@Value("http://www.choupangxia.com")
private URL homePage;

在上述示例分别展示了以下场景的使用：

• 直接注入字符串，相当于实例化时直接初始化字符串。
• 通过#{}注入系统属性。
• 通过#{}注入表达式结果。
• 通过#{}注入其他Bean的属性。
• 通过#{}和${}的组合注入属性并进行分割处理。
• 注入文件资源，将对应的字符串值转换成对应的资源文件。
• 注入URL资源，将对应的URL字符串转换成URL。

需要注意的是：

• Resource的全限定名为 org.springframework.core.io.Resource。
• 二者结合使用时（#{‘${}’}），注意单引号，注意不能反过来。

3、@Value(“#{}”)设置默认值

/**
 * 如果系统属性中未获取到port的值，则使用8888。
 */
@Value("#{systemProperties['port']?:'8888'}")
private String port;

其中${}中直接使用“:”对未定义或为空的值进行默认值设置，而#{}则需要使用“?:”对未设置的属性进行默认值设置。