SpringBoot之Spring@Value屬性注入使用詳解

轉載：https://www.cnblogs.com/secbro/p/12095837.html

在使用Spring框架的項目中，@Value是使用比較頻繁的注解之一，它的作用是將配置文件中key對應的值賦值給它標注的屬性。在日常使用中我們常用的功能都比較簡單，本篇文章系統的帶大家來了解一下@Value的使用方法。

@Value注入支持形式

@Value屬性注入功能根據注入的內容來源可分為兩類：通過配置文件的屬性注入和通過非配置文件的屬性注入。

通過配置文件的注入根據配置文件的來源又可分為兩類：一類為默認的Spring Boot會自動加載的配置文件application.properties中的屬性；另一類為自定義配置文件中的屬性，需要先通過@PropertySource加載。

而非配置文件注入的類型又分為：

• 注入普通字符串
• 注入操作系統屬性
• 注入表達式結果
• 注入其他Bean屬性
• 注入文件資源
• 注入URL資源

基於配置文件注入

首先來看數據來源自配置文件的注入，無論是會被默認加載的application.properties或自定義的my.properties文件。比如，application.properties中定義屬性值的形式如下：

user.name=admin

在my.properties配置文件中定義的屬性如下：

user.password=pwd123

那么，@Value在Bean中的使用形式為：

@PropertySource("classpath:my.properties")
@RestController
public class ValueController {

    /**
     * 獲取位於application.properties中配置的屬性
     */
    @Value("${user.name}")
    private String name;

    /**
     * 獲取位於my.properties中的配置屬性
     */
    @Value("${user.password}")
    private String password;

}

不同的是，在Spring Boot項目中，如果是自定義的my.properties文件，需要在某個類中通過@PropertySource引入該配置文件，而application.properties中的屬性會自動被加載。

同時，不僅僅可以通過@Value注入單個屬性，還可以注入數組和列表形式。比如如下配置：

tools=car,train,airplane

可以通過以下方式注入：

/**
 * 注入數組（自動根據","分割）
 */
@Value("${tools}")
private String[] toolArray;

/**
 * 注入列表形式（自動根據","分割）
 */
@Value("${tools}")
private List<String> toolList;

Spring默認情況下會以“,”進行分割，轉換成對應的數組或列表。

基於非配置文件注入

在使用實例說明基於非配置文件注入屬性的實例之前，我們先了解一下SpEL。

SpEL（Spring Expression Language）即Spring表達式語言，可以在運行時查詢和操作數據。使用#{...}作為定界符, 所有在大括號中的字符都將被認為是 SpEL。

下面看具體實例場景的應用：

/**
 * 注入普通字符串，相當於直接給屬性默認值
 */
@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。
• 二者結合使用時（#{'${}'}），注意單引號，注意不能反過來。

默認值注入

無論使用#{}或${}進行屬性的注入，當無法獲取對應值時需要設置默認值，可以采用如下方式來進行設置。

/**
 * 如果屬性中未配置ip，則使用默認值
 */
@Value("${ip:127.0.0.1}")
private String ip;

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

其中${}中直接使用“:”對未定義或為空的值進行默認值設置，而#{}則需要使用“?:”對未設置的屬性進行默認值設置。