1. 程式人生 > >【Spring】只想用一篇文章記錄@Value的使用,不想再找其它了(附思維導圖)

【Spring】只想用一篇文章記錄@Value的使用,不想再找其它了(附思維導圖)

1 簡介

不得不說,Spring為大家提供許多開箱即用的功能,@Value就是一個極其常用的功能,它能將配置資訊注入到bean中去。即使是一個簡單的功能,Spring也提供了豐富的注入型別和形式。我經常會忘記一些特別型別注入的寫法,比如說陣列,現在整理一下,希望以後不用再找了。

2 三種形式

使用@Value注入有三種形式,如下所示:

(1)直接寫值@Value("string value")

這種方式就是直接把要注入的值字面量寫在註解裡,比較少用。如果要寫死在註解裡了,那直接定義變數的時候寫死就可以了。

(2)佔位符@Value("${myvalue}")

這種應該最常用,通過屬性名,將值注入進來。

如果可能為空,需要設定預設值,用法:@Value("${unknown.param:defaultValue}")

(3)SpEL表示式@Value("#{someBean.someValue}")
SpEL表示式很強大,還能在屬性值基礎上加以運算等。

如果可能為空,需要設定預設值,用法:@Value("#{systemProperties['unknown'] ?: 'defaultValue'}")

另外,佔位符形式和SpEL表示式是可以結合使用的,如下:

@Value("#{'${listOfValues}'.split(',')}")
private List valuesList;

需要注意的,內外順序不能倒過來,應該要#{}外面,${}在裡面。

3 使用場景

對於注入的場景,主要有三種:

(1)bean宣告的變數

(2)setter方法注入

(3)構造方法或其它方法的入參

例子程式碼如下:

//bean宣告的變數
public static class MyValues {
    @Value("#{systemProperties['user.timezone']}")
    private String timeZone;
}

//setter 方法中
public static class MyValues {
    private String timeZone;
    @Value("#{systemProperties['user.timezone']}")
    public void setTimeZone(String timeZone) {
        this.timeZone = timeZone;
    }
}

//方法入參
public class MyValues {
    private String timeZone;
    @Autowired
    public void configure(@Value("#{systemProperties['user.timezone']}") String timeZone) {
        this.timeZone = timeZone;
    }
}

4 引入配置檔案

既然是注入配置屬性,那就需要有配置檔案。對於Springboot,引入配置檔案有兩種方法,一種是預設引入的application.properties,另一種則需要通過@PropertySource來引入,引入的方式如下:

@PropertySources({
  @PropertySource(value = "classpath:missing.properties", ignoreResourceNotFound=true),
  @PropertySource("classpath:config.properties")
})
public class AppConfig {
        //...
}

加上ignoreResourceNotFound後,即使檔案找不到,也不會拋FileNotFoundException異常。

5 使用舉例

現在例舉一些可能使用到的例子,以後在這找就行了。

Java程式碼如下所示:

//直接寫值
@Value("plainText")
private String plainText;

//普通形式-字串
@Value("${myValues.string}")
private String myValuesString;

//普通形式-數字
@Value("${myValues.int}")
private int myValuesInt;

//普通形式-布林型別
@Value("${myValues.boolean}")
private boolean myValuesBoolean;

//陣列
@Value("${myValues.array}")
private String[] myValuesArray;

//Map
@Value("#{${myValues.map}}")
private Map<String, String> myValuesMap;

//作業系統屬性
@Value("#{systemProperties['user.timezone']}")
private String timeZone;

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

//其它bean的屬性
@Value("#{propertiesApplication.class.getName()}")
private String className;

//檔案資源
@Value("classpath:larry.txt")
private Resource file;

//URL資源
@Value("https://www.github.com")
private Resource url;

其中,配置檔案application.properties內容為:

myValues.int=99
myValues.boolean=true
myValues.string=Larry
myValues.array=my,name,is,larry
myValues.map={name: 'Larry', age: '18', city: 'Guangzhou'}

資原始檔larry.txt內容為:

上善若水,水利萬物而不爭!

啟動程式,列印以上所有屬性,輸出結果如下所示:

{
plainText='plainText', 
myValuesString='Larry', 
myValuesInt=99, 
myValuesBoolean=true, 
myValuesArray=[my, name, is, larry], 
myValuesMap={name=Larry, age=18, city=Guangzhou}, 
timeZone='Asia/Shanghai', 
randomNumber=19.775129662772294, 
className='com.pkslow.properties.PropertiesApplication$$EnhancerBySpringCGLIB$$4d0912c', 
file=上善若水,水利萬物而不爭!, 
url=
<!DOCTYPE html>
<html lang="en">
省略html內容
</html>
}

6 總結

本文講解了@Value註解的使用,基本上平時開發用到的都涉及了,應該不需要再找其它資料了吧。


歡迎關注公眾號<南瓜慢說>,將持續為你更新...

歡迎加博主微信,做一個點贊之友,哈哈...

多讀書,多分享;多寫作,多整理