Spring@Value屬性注入使用方法解析
這篇文章主要介紹了Spring@Value屬性注入使用方法解析,文中通過示例程式碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
在使用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;
其中${}中直接使用“:”對未定義或為空的值進行預設值設定,而#{}則需要使用“?:”對未設定的屬性進行預設值設定。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。