SpringBoot | @Value 和 @ConfigurationProperties 的區(qū)別

Scliang 發(fā)布于2019-08-16 15:53 / 1869人閱讀

微信公眾號：一個優(yōu)秀的廢人。如有問題，請后臺留言，反正我也不會聽。

前言

最近有跳槽的想法，所以故意復習了下 SpringBoot 的相關知識，復習得比較細。其中有些，我感覺是以前忽略掉的東西，比如 @Value 和 @ConfigurationProperties 的區(qū)別。

如何使用

定義兩個對象，一個學生對象，對應著一個老師對象，代碼如下：

@ConfigurationProperties

學生類

@Component
@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    private String firstName;

    private String lastName;

    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List hobbys;

    private Map scores;

    //注意，為了測試必須重寫 toString 和 get，set 方法
}

老師類

public class Teacher {

    private String name;

    private Integer age;

    private String gender;

    //注意，為了測試必須重寫 toString 和 get，set 方法
}

測試類

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootValConproDemoApplicationTests {

    @Autowired
    private Student student;

    @Test
    public void contextLoads() {
        // 這里為了方便，但工作中千萬不能用 System.out
        System.out.println(student.toString());
    }
}

輸出結果

Student{firstName="陳", lastName="一個優(yōu)秀的廢人", age=24, gender="男", city="廣州", teacher=Teacher{name="eses", age=24, gender="女"}, hobbys=[籃球, 羽毛球, 兵兵球], scores={java=100, Python=99, C=99}}

@Value

@Value 支持三種取值方式，分別是字面量、${key}從環(huán)境變量、配置文件中獲取值以及 #{SpEL}

學生類

@Component
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    /**
     * 
     *      
     * 
     */

    @Value("陳") // 字面量
    private String firstName;

    @Value("${student.lastName}") // 從環(huán)境變量、配置文件中獲取值
    private String lastName;

    @Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List hobbys;

    private Map scores;

    //注意，為了測試必須重寫 toString 和 get，set 方法
}

測試結果

Student{firstName="陳", lastName="一個優(yōu)秀的廢人", age=24, gender="null", city="null", teacher=null, hobbys=null, scores=null}

區(qū)別

二者區(qū)別	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定
松散綁定（松散語法）	支持	不支持
SpEL	不支持	支持
JSR303數(shù)據校驗	支持	不支持
復雜類型封裝	支持	不支持

從上表可以看見，@ConfigurationProperties 和 @Value 主要有 5 個不同，其中第一個功能上的不同，上面已經演示過。下面我來介紹下剩下的 4 個不同。

松散語法

松散語法的意思就是一個屬性在配置文件中可以有多個屬性名，舉個栗子：學生類當中的 firstName 屬性，在配置文件中可以叫 firstName、first-name、first_name 以及 FIRST_NAME。而 @ConfigurationProperties 是支持這種命名的，@Value 不支持。下面以 firstName 為例，測試一下。如下代碼：

@ConfigurationProperties

學生類的 firstName 屬性在 yml 文件中被定義為 first_name：

student:
  first_name: 陳  # 學生類的 firstName 屬性在 yml 文件中被定義為 first_name
  lastName: 一個優(yōu)秀的廢人
  age: 24
  gender: 男
  city: 廣州
  teacher: {name: eses,age: 24,gender: 女}
  hobbys: [籃球,羽毛球,兵兵球]
  scores: {java: 100,Python: 99,C++: 99}

學生類：

@Component
@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    /**
     * 
     *      
     * 
     */

    //@Value("陳") // 字面量
    private String firstName;

    //@Value("${student.lastName}") // 從環(huán)境變量、配置文件中獲取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List hobbys;

    private Map scores;

    //注意，為了測試必須重寫 toString 和 get，set 方法
}

測試結果：

Student{firstName="陳", lastName="一個優(yōu)秀的廢人", age=24, gender="男", city="廣州", teacher=Teacher{name="eses", age=24, gender="女"}, hobbys=[籃球, 羽毛球, 兵兵球], scores={java=100, Python=99, C=99}}

@Value

學生類：

@Component
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    /**
     * 
     *      
     * 
     */

    //@Value("陳") // 字面量
    @Value("${student.firstName}")
    private String firstName;

    //@Value("${student.lastName}") // 從環(huán)境變量、配置文件中獲取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List hobbys;

    private Map scores;
    
   //注意，為了測試必須重寫 toString 和 get，set 方法
}

測試結果：啟動報錯，找不到 bean。

從上面兩個測試結果可以看出，使用 @ConfigurationProperties 注解時，yml 中的屬性名為 last_name 而學生類中的屬性為 lastName 但依然能取到值，而使用 @value 時，使用 lastName 確報錯了。證明 @ConfigurationProperties 支持松散語法，@value 不支持。

SpEL

SpEL 使用 #{...} 作為定界符 , 所有在大括號中的字符都將被認為是 SpEL , SpEL 為 bean 的屬性進行動態(tài)賦值提供了便利。

@Value

如上述介紹 @Value 注解使用方法時，有這樣一段代碼：

@Value("#{12*2}") // #{SpEL}
private Integer age;

證明 @Value 是支持 SpEL 表達式的。

@ConfigurationProperties

由于 yml 中的 # 被當成注釋看不到效果。所以我們新建一個 application.properties 文件。把 yml 文件內容注釋，我們在 properties 文件中把 age 屬性寫成如下所示：

student.age=#{12*2}

把學生類中的 @ConfigurationProperties 注釋打開，注釋 @value 注解。運行報錯， age 屬性匹配異常。

說明 @ConfigurationProperties 不支持 SpEL

JSR303 數(shù)據校驗

@Value

加入 @Length 校驗：

@Component
@Validated
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    /**
     * 
     *      
     * 
     */

    //@Value("陳") // 字面量
    @Value("${student.first-name}")
    @Length(min=5, max=20, message="用戶名長度必須在5-20之間")
    private String firstName;

    //@Value("${student.lastName}") // 從環(huán)境變量、配置文件中獲取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List hobbys;

    private Map scores;
}

yaml：

student:
  first_name: 陳

測試結果：

Student{firstName="陳", lastName="null", age=null, gender="null", city="null", teacher=null, hobbys=null, scores=null}

yaml 中的 firstname 長度為 1 。而檢驗規(guī)則規(guī)定 5-20 依然能取到屬性，說明檢驗不生效，@Value 不支持 JSR303 數(shù)據校驗

@ConfigurationProperties

學生類：

@Component
@Validated
@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    /**
     * 
     *      
     * 
     */

    //@Value("陳") // 字面量
    //@Value("${student.first-name}")
    @Length(min=5, max=20, message="用戶名長度必須在5-20之間")
    private String firstName;

    //@Value("${student.lastName}") // 從環(huán)境變量、配置文件中獲取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List hobbys;

    private Map scores;
}

測試結果：報錯

[firstName],20,5]; default message [用戶名長度必須在5-20之間]

校驗生效，支持 JSR303 數(shù)據校驗。

復雜類型封裝

復雜類型封裝指的是，在對象以及 map （如學生類中的老師類以及 scores map）等屬性中，用 @Value 取是取不到值，比如：

@Component
//@Validated
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 屬性與這個 bean綁定
public class Student {

    /**
     * 
     *      
     * 
     */

    //@Value("陳") // 字面量
    //@Value("${student.first-name}")
    //@Length(min=5, max=20, message="用戶名長度必須在5-20之間")
    private String firstName;

    //@Value("${student.lastName}") // 從環(huán)境變量、配置文件中獲取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    @Value("${student.teacher}")
    private Teacher teacher;

    private List hobbys;

    @Value("${student.scores}")
    private Map scores;
}

這樣取是報錯的。而上文介紹 @ConfigurationProperties 和 @Value 的使用方法時已經證實 @ConfigurationProperties 是支持復雜類型封裝的。也就是說 yaml 中直接定義 teacher 以及 scores 。 @ConfigurationProperties 依然能取到值。

怎么選用？

如果說，只是在某個業(yè)務邏輯中需要獲取一下配置文件中的某項值，使用 @Value；比如，假設現(xiàn)在學生類加多一個屬性叫 school 那這個屬性對于該校所有學生來說都是一樣的，但防止我這套系統(tǒng)到了別的學校就用不了了。那我們可以直接在 yml 中給定 school 屬性，用 @Value 獲取。當然上述只是舉個粗暴的例子，實際開發(fā)時，school 屬性應該是保存在數(shù)據庫中的。

如果說，專門編寫了一個 javaBean 來和配置文件進行映射，我們就直接使用 @ConfigurationProperties。

完整代碼

https://github.com/turoDog/Demo/tree/master/springboot_val_conpro_demo

如果覺得對你有幫助，請給個 Star 再走唄，非常感謝。

后語

如果本文對你哪怕有一丁點幫助，請幫忙點好看。你的好看是我堅持寫作的動力。

另外，關注之后在發(fā)送 1024 可領取免費學習資料。

資料詳情請看這篇舊文：Python、C++、Java、Linux、Go、前端、算法資料分享

云服務器 GPU云服務器寬帶和專線的區(qū)別專線和寬帶的區(qū)別空間和域名的區(qū)別功能和作用的區(qū)別

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/73755.html

SpringBoot | @Value 和 @ConfigurationProperties 的區(qū)別

微信公眾號：一個優(yōu)秀的廢人。如有問題，請后臺留言，反正我也不會聽。前言最近有跳槽的想法，所以故意復習了下 SpringBoot 的相關知識，復習得比較細。其中有些，我感覺是以前忽略掉的東西，比如 @Value 和 @ConfigurationProperties 的區(qū)別。如何使用定義兩個對象，一個學生對象，對應著一個老師對象，代碼如下： @ConfigurationProperties ...

lovXin 2019-08-19 11:34 評論0 收藏0
SpringBoot學習筆記：Spring Boot配置文件詳解

摘要：全局配置文件默認為下的，另外它還可以重命名為格式即對著兩種格式均支持。其中每個環(huán)境的數(shù)據庫地址服務器端口等等配置都會不同，如果在為不同環(huán)境打包時都要頻繁修改配置文件的話，那必將是個非常繁瑣且容易發(fā)生錯誤的事。 SpringBoot全局配置文件默認為src/main/resources下的application.properties，另外它還可以重命名為.yml格式（即SpringBoo...

sunny5541 2019-08-19 10:43 評論0 收藏0
SpringBoot非官方教程 | 第二篇：SpringBoot配置文件詳解

摘要：采納了建立生產就緒應用程序的觀點。優(yōu)先于配置的慣例，旨在讓您盡快啟動和運行。啟動工程，訪問我們會發(fā)現(xiàn)配置文件信息讀到了。三自定義配置文件上面介紹的是我們都把配置文件寫到中。源碼下載五參考文獻干貨系列二配置文件解析屬性配置文件詳解 springboot采納了建立生產就緒Spring應用程序的觀點。 Spring Boot優(yōu)先于配置的慣例，旨在讓您盡快啟動和運行。在一般情況下，我們不需要做...

荊兆峰 2019-08-16 10:44 評論0 收藏0
這樣講 SpringBoot 自動配置原理，你應該能明白了吧

摘要：這里有一個參數(shù)，主要是用來指定該配置項在配置文件中的前綴。創(chuàng)建一個配置類，里面沒有顯式聲明任何的，然后將剛才創(chuàng)建的導入。創(chuàng)建實現(xiàn)類，返回的全類名。創(chuàng)建實現(xiàn)類，實現(xiàn)方法直接手動注冊一個名叫的到容器中。前言小伙伴們是否想起曾經被 SSM 整合支配的恐懼？相信很多小伙伴都是有過這樣的經歷的，一大堆配置問題，各種排除掃描，導入一個新的依賴又得添加新的配置。自從有了 SpringBoot 之后，咋...

cc17 2019-05-23 14:33 評論0 收藏0
Spring Boot（二）Spring Boot 的配置

摘要：不同的環(huán)境之間的配置存在覆蓋關系。提供了一種統(tǒng)一的方式來管理應用的配置，允許開發(fā)人員使用屬性文件文件環(huán)境變量和命令行參數(shù)來定義優(yōu)先級不同的配置值。比如命令行參數(shù)的優(yōu)先級被設置為最高。一.關于Spring Boot的配置 Spring Boot 對于開發(fā)人員最大的好處在于可以對 Spring 應用進行自動配置。Spring Boot 會根據應用中聲明的第三方依賴來自動配置 Spring...

nicercode 2019-08-16 11:06 評論0 收藏0