SpringBoot @ConfigurationProperties注解的簡單使用

更新時間：2021年05月24日 11:37:06 作者：WinterJay

即便現(xiàn)在簡化了配置，但是一個獨立的配置文件總是易于理解而且使人安心的。Spring在構建完項目后，會默認在resources文件夾下創(chuàng)建一個application.properties文件，application.yml也是一樣的效果。@ConfigurationProperties可以獲取配置文件中的數據，將其注入類。

源碼

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConfigurationProperties {
    @AliasFor("prefix")
    String value() default "";

    @AliasFor("value")
    String prefix() default "";

    boolean ignoreInvalidFields() default false;

    boolean ignoreUnknownFields() default true;
}

使用

向注解中傳入配置文件中的前綴名，如果配置文件如下：

myConfigs:
  config1:
    field1: f1
    field2: f2
    field3: f3

那么代碼中的配置類應該這樣寫：

@Component
@ConfigurationProperties("myConfigs.config1")
public class MyConfig1 {
    String field1;
    String field2;
    String field3;
}

如上所示，field1, field2, field3三個屬性就被綁定到了對象上。

注意到我們使用了@Component，實際上我們使用配置類都是將其注入到其他類中，所以我們往往將其注冊為Bean。

ignoreInvalidFields默認為false，不合法的屬性的屬性會默認拋出異常；
ignoreUnknownFields默認為true, 未能識別的屬性會被忽略(所以打錯了名字就會被忽略了)

@ConfigurationProperties(prefix="config.prefix", ignoreInvalidFields=true, ignoreUnknownFields=false)
public class MyConfig {
    // fields
}

Spring Boot的綁定規(guī)則相當寬松，myField, my-field, my_field等都能識別綁定到myField上。

可以給字段設定默認值，這樣配置中沒有傳入時會使用默認值。

@ConfigurationProperties("your.prefix")
public class YourConfig {
    private String field = "Default"
    // setter
}

類的字段必須要有public訪問權限的setter方法。

在很多情況下public的setter方法時必須的，使用IDEA的話，這里推薦Alt+Insert(Windows, Mac使用Alt+n)生成；當然，想使用Lombok也可以

以上就是SpringBoot @ConfigurationProperties注解的簡單使用的詳細內容，更多關于SpringBoot @ConfigurationProperties注解的資料請關注腳本之家其它相關文章！

您可能感興趣的文章:

一文詳解Spring?Boot可以同時處理多少請求
SpringBoot是一個流行的Java開發(fā)框架,它被廣泛用于構建Web應用程序,但是,開發(fā)人員通常會擔心它的性能問題,特別是在高負載條件下,Spring?Boot能夠同時處理多少請求是一個重要的問題,在本文中,我們將討論SpringBoot的請求處理能力,并介紹如何提高性能
2023-10-10
Java使用FTP上傳文件并模擬接受的方法
這篇文章主要介紹了Java使用FTP上傳文件并模擬接受的方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2021-02-02
深入理解Java對象的序列化與反序列化的應用
本篇文章是對Java中對象的序列化與反序列化進行了詳細的分析介紹，需要的朋友參考下
2013-05-05
mybatis-plus返回map自動轉駝峰配置操作
這篇文章主要介紹了mybatis-plus返回map自動轉駝峰配置操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2020-11-11
Spring Boot 快速入門指南
Spring 框架是非常著名的 Java 開源框架，歷經十多年的發(fā)展，整個生態(tài)系統(tǒng)已經非常完善甚至是繁雜，Spring Boot 正是為了解決這個問題而開發(fā)的，為 Spring 平臺和第三方庫提供了開箱即用的設置，只需要很少的配置就可以開始一個 Spring 項目
2017-03-03
SpringBoot實現(xiàn)yml配置文件為變量賦值
這篇文章主要介紹了SpringBoot實現(xiàn)yml配置文件為變量賦值，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2022-02-02
詳解Java中的字節(jié)碼增強技術
字節(jié)碼增強技術就是一類對現(xiàn)有字節(jié)碼進行修改或者動態(tài)生成全新字節(jié)碼文件的技術。本文將通過示例詳細說說Java的字節(jié)碼增強技術，需要的可以參考一下
2022-10-10
Java8實現(xiàn)優(yōu)雅的獲取重復字符與次數
這篇文章主要為大家詳細介紹了在Java8中,我們應該如何進行字符及字符串的去重,以及計算去重次數,文中的示例代碼講解詳細,感興趣的小伙伴可以了解下
2023-12-12
MyBatis 管理和查找TypeHandler的方法
MyBatis通過TypeHandlerRegistry組件集中管理和查找TypeHandler,TypeHandler用于處理Java類型和JDBC類型之間的轉換,本文介紹MyBatis 管理和查找TypeHandler的方法,感興趣的朋友一起看看吧
2025-03-03
Fastjson反序列化隨機性失敗示例詳解
這篇文章主要為大家介紹了Fastjson反序列化隨機性失敗示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪
2022-08-08