Spring 开发过程中Value 注解使用介绍

2020-11-17 0 By admin

Spring 开发过程中使用 Value 注解对属性进行赋值;常见的场景有三种。

  1. 直接对属性进行赋值;包括普通字符串、操作系统属性、文件内容等。
  2. 从配置文件中读取简单类型进行赋值;配置文件需要生效才可。
  3. 从配置文件中读取复杂类型进行赋值;如数组、Map、对象列表等。

一、直接对属性进行赋值

通过 @Value 将外部的值动态注入到Bean中,使用的情况有:

  1. 注入普通字符串
  2. 注入操作系统属性
  3. 注入表达式结果
  4. 注入其他Bean属性:注入beanInject对象的属性another
  5. 注入文件资源
  6. 注入URL资源
@Value("normal")
private String normal; // 注入普通字符串

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

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

@Value("#{beanInject.another}")
private String fromAnotherBean; 
// 注入其他Bean属性:注入beanInject对象的属性another,类具体定义见下面

@Value("classpath:com/hry/spring/configinject/config.txt")
private Resource resourceFile; // 注入文件资源

@Value("http://www.baidu.com")
private Resource testUrl; // 注入URL资源

二、从配置文件中读取简单类型进行赋值

通过 @Value 将外部配置文件的值动态注入到Bean中。

2.1、默认自动加载配置

Spring boot 启动过程中会自动默认加载配置文件 application.propreties(application.yml);这样的话,配置文件中的配置项,可以直接被 Value 注解使用。如果放置在其他配置文件中的话,只要保证启动时会被加载即可;配置方式有好几种,这里就不赘述了。

2.2、使用注解指定加载的配置文件

自定义配置文件通过 @PropertySource 注解加载。
@PropertySource可以同时加载多个文件,也可以加载单个文件。如果相同第一个属性文件和第二属性文件存在相同key,则最后一个属性文件里的key启作用。加载文件的路径也可以使用变量定义。

2.3、配置文件加载示例

1、config.properties 配置文件

book.name=bookName
anotherfile.configinject=placeholder 
//作为第二个配置文件加载路径的变量值

2、config_placeholder.properties 配置文件

book.name.placeholder=bookNamePlaceholder

3、下面通过@Value(“${app.name}”)语法将属性文件的值注入bean属性值

@Component
// 引入外部配置文件组:${app.configinject}的值来自config.properties。
// 如果相同
@PropertySource({"classpath:com/hry/spring/configinject/config.properties",
    "classpath:com/hry/spring/configinject/config_${anotherfile.configinject}.properties"})
public class ConfigurationFileInject{
    @Value("${app.name}")
    private String appName; // 这里的值来自application.properties,spring boot启动时默认加载此文件

    @Value("${book.name}")
    private String bookName; // 注入第一个配置外部文件属性

    @Value("${book.name.placeholder}")
    private String bookNamePlaceholder; // 注入第二个配置外部文件属性

    @Autowired
    private Environment env;  // 注入环境变量对象,存储注入的属性值

    public String toString(){
        StringBuilder sb = new StringBuilder();
        sb.append("bookName=").append(bookName).append("\r\n")
        .append("bookNamePlaceholder=").append(bookNamePlaceholder).append("\r\n")
        .append("appName=").append(appName).append("\r\n")
        .append("env=").append(env).append("\r\n")
        // 从eniroment中获取属性值
        .append("env=").append(env.getProperty("book.name.placeholder")).append("\r\n");
        return sb.toString();
    }
}

三、从配置文件中读取复杂类型进行赋值

Spring Boot 通过 Value 注解从配置文件中获取Map、List或者对象列表类型的配置信息时,应该创建一个接受这些配置信息的对象。配置文件中的配置项,设置为此对象的属性。

3.1、添加依赖包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

3.2、创建接受配置信息的对象

@Configuration
@Component
@ConfigurationProperties(prefix = "dingtalk")
@EnableConfigurationProperties(MapConfig.class)
public class MapConfig {
    /**
     * 从配置文件中读取的dingtalk.urls开头的数据
     * 注意:名称必须与配置文件中保持一致
     */
    private Map<String, String> urls;

    public Map<String, String> getUrls() {
        return urls;
    }

    public void setUrls(Map<String, String> urls) {
        this.urls = urls;
    }
}

3.3、配置文件示例

dingtalk:
  urls:
    default: https://oapi.dingtalk.com/default
    test: https://oapi.dingtalk.com/test
    center: https://oapi.dingtalk.com/center

3.4、调用实例

@Component
public class test {
    @Autowired
    private MapConfig mapConfig;
	private Map<String,String> urlsMap;

    public void test {
        urlsMap = mapConfig.getUrls();
		System.out.println(urlsMap.toString());
	}
}