Spring的@ConfigurationProperties注解详解
更新时间：2023年11月22日 10:38:41 作者：杜小舟
这篇文章主要介绍了Spring的@ConfigurationProperties注解详解,@ConfigurationProperties该注解是用来获取yml或者properties配置文件的配置信息,下面根据一些配置信息给出案例代码进行讲解,需要的朋友可以参考下
前言
本篇文章主要介绍SringBoot中的@ConfigurationProperties注解，该注解是用来获取yml或者properties配置文件的配置信息，下面根据一些配置信息给出案例代码进行讲解。
@ConfigurationProperties 属性介绍
| 属性名称 | 介绍 |
| prefix、value | 指定属性前缀 |
| ignoreInvalidFields | 是否忽略无效字段，如果设置为true，则在绑定过程中遇到无效字段不会抛出异常 下面有对该属性值的专门介绍 默认是false |
| ignoreUnknownFields | 是否忽略未知字段，如果设置为true，则在绑定过程中遇到未知字段不会抛出异常 下面有对该属性值的专门介绍 默认是true |
案例代码介绍
下面在yml配置文件中配置：
user:
name: "张三"
age: 18
hobbies:
- "看书"
- "写代码"
代码实现：
@Component
@ConfigurationProperties(prefix = "user")
public class UserInfo {
private String name;
private int age;
private List<String> hobbies;
}
这样，就能从配置文件中读取到配置的信息。
ignoreInvalidFields 属性用法
如果，我把ignoreInvalidFields属性值设置为false（ignoreInvalidFields属性值默认值就是fasle），然后把yml配置文件中的age修改成字符串类型，这样配置文件中的类型和Class中的类型不一致就会出现错误，以下是代码案例
user:
name: "张三"
age: 18
hobbies:
- "看书"
- "写代码"
代码实现：
@Component
@ConfigurationProperties(prefix = "user", ignoreInvalidFields = false)
public class UserInfo {
private String name;
private int age;
private List<String> hobbies;
}
错误如下：
***************************
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属性值设置为false（ignoreUnknownFields属性值默认值是true），然后把UserInfo文件中的hobbies变量删除，这样配置文件中的类型和Class中的属性就会不一致，接下来就会出现错误，以下是代码案例
user:
name: "张三"
age: 18
hobbies:
- "看书"
- "写代码"
代码实现：
@Component
@ConfigurationProperties(prefix = "user", ignoreUnknownFields = false)
public class UserInfo {
private String name;
private int age;
}
错误如下：
***************************
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: 看书
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: 写代码
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
到此这篇关于Spring的@ConfigurationProperties注解详解的文章就介绍到这了,更多相关@ConfigurationProperties注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了Java实现的简单数字处理类及用法,涉及java数字运算相关操作技巧,需要的朋友可以参考下2018-01-01
Java SpringMVC框架开发之数据导出Excel文件格式实例详解
这篇文章主要介绍了Java基础开发之数据导出Excel文件格式实例详解,需要的朋友可以参考下2020-02-02
这篇文章主要介绍了Java中集合和数组的排序方式小结,本文讲解了对数字数组、字符数组排序以及集合序列的排序,需要的朋友可以参考下2015-01-01
这篇文章主要为大家详细介绍了如何使用Java实现视频与音频转码,即把其他视频格式转换成HTML5能播放的视频格式和把其他音频格式转换为mp3,感兴趣的小伙伴可以了解下2025-07-07
今天带大家来了解一下Java内存泄漏与溢出的知识,文中有非常详细的介绍,对正在学习Java基础的各位小伙伴呢很有帮助哟,需要的朋友可以参考下2021-05-05
使用SpringBoot AOP 记录操作日志、异常日志的过程
这篇文章主要介绍了使用SpringBoot AOP 记录操作日志、异常日志的过程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-05-05
这篇文章主要介绍了JAVA实现生成顺序ID,不浪费ID问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-04-04
这篇文章主要为大家详细介绍了java图形化界面实现登录窗口，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2018-05-05
这篇文章主要介绍了java中File类的构造函数及其方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-06-06
本文主要介绍了IDEA运行SpringBoot项目的详细步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-07-07
最新评论