快捷導(dǎo)航

Spring的@ConfigurationProperties注解詳解

更新時(shí)間：2023年11月22日 10:38:41 作者：杜小舟

這篇文章主要介紹了Spring的@ConfigurationProperties注解詳解,@ConfigurationProperties該注解是用來(lái)獲取yml或者properties配置文件的配置信息,下面根據(jù)一些配置信息給出案例代碼進(jìn)行講解,需要的朋友可以參考下

前言

本篇文章主要介紹SringBoot中的@ConfigurationProperties注解，該注解是用來(lái)獲取yml或者properties配置文件的配置信息，下面根據(jù)一些配置信息給出案例代碼進(jìn)行講解。

@ConfigurationProperties 屬性介紹

屬性名稱(chēng)	介紹
prefix、value	指定屬性前綴
ignoreInvalidFields	是否忽略無(wú)效字段，如果設(shè)置為true，則在綁定過(guò)程中遇到無(wú)效字段不會(huì)拋出異常下面有對(duì)該屬性值的專(zhuān)門(mén)介紹默認(rèn)是false
ignoreUnknownFields	是否忽略未知字段，如果設(shè)置為true，則在綁定過(guò)程中遇到未知字段不會(huì)拋出異常下面有對(duì)該屬性值的專(zhuān)門(mén)介紹默認(rèn)是true

案例代碼介紹

下面在yml配置文件中配置：

user:
  name: "張三"
  age: 18
  hobbies: 
    - "看書(shū)"
    - "寫(xiě)代碼"

代碼實(shí)現(xiàn)：

@Component
@ConfigurationProperties(prefix = "user")
public class UserInfo {
    private String name;
    private int age;
    private List<String> hobbies;
}

這樣，就能從配置文件中讀取到配置的信息。

ignoreInvalidFields 屬性用法

如果，我把ignoreInvalidFields屬性值設(shè)置為false（ignoreInvalidFields屬性值默認(rèn)值就是fasle），然后把yml配置文件中的age修改成字符串類(lèi)型，這樣配置文件中的類(lèi)型和Class中的類(lèi)型不一致就會(huì)出現(xiàn)錯(cuò)誤，以下是代碼案例

user:
  name: "張三"
  age: 18
  hobbies: 
    - "看書(shū)"
    - "寫(xiě)代碼"

代碼實(shí)現(xiàn)：

@Component
@ConfigurationProperties(prefix = "user", ignoreInvalidFields = false)
public class UserInfo {
    private String name;
    private int age;
    private List<String> hobbies;
}

錯(cuò)誤如下：

***************************
APPLICATION FAILED TO START
***************************

Description:

Failed to bind properties under 'user.age' to int:

    Property: user.age
    Value: 18歲
    Origin: class path resource [application.yml] - 10:8
    Reason: failed to convert java.lang.String to int (caused by java.lang.NumberFormatException: For input string: "18歲")

Action:

Update your application's configuration

ignoreUnknownFields 屬性用法

這里，我把ignoreUnknownFields屬性值設(shè)置為false（ignoreUnknownFields屬性值默認(rèn)值是true），然后把UserInfo文件中的hobbies變量刪除，這樣配置文件中的類(lèi)型和Class中的屬性就會(huì)不一致，接下來(lái)就會(huì)出現(xiàn)錯(cuò)誤，以下是代碼案例

user:
  name: "張三"
  age: 18
  hobbies: 
    - "看書(shū)"
    - "寫(xiě)代碼"

代碼實(shí)現(xiàn)：

@Component
@ConfigurationProperties(prefix = "user", ignoreUnknownFields = false)
public class UserInfo {
    private String name;
    private int age;
}

錯(cuò)誤如下：

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target [Bindable@31e2232f type = com.demo.UserInfo, value = 'provided', annotations = array<Annotation>[@org.springframework.boot.context.properties.ConfigurationProperties(ignoreInvalidFields=false, ignoreUnknownFields=false, prefix=user, value=user)]] failed:

    Property: user.hobbies[0]
    Value: 看書(shū)
    Origin: class path resource [application.yml] - 12:7
    Reason: The elements [user.hobbies[0],user.hobbies[1]] were left unbound.
    Property: user.hobbies[1]
    Value: 寫(xiě)代碼
    Origin: class path resource [application.yml] - 13:7
    Reason: The elements [user.hobbies[0],user.hobbies[1]] were left unbound.

Action:

Update your application's configuration

到此這篇關(guān)于Spring的@ConfigurationProperties注解詳解的文章就介紹到這了,更多相關(guān)@ConfigurationProperties注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: