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+SpringBoot+Vue+maven+Mysql实现一个精美的物流管理系统,大家可以在过程中查缺补漏，提升水平2021-11-11
这篇文章主要介绍了IDEA里面的Artifact到底是什么，本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧2021-01-01
MyBatis-Plus updateById不更新null值的方法解决
用Mybatis-Plus的updateById()来更新数据时,无法将字段设置为null值,更新后数据还是原来的值,本文就来详细的介绍一下解决方法,具有一定的参考价值,感兴趣的可以了解一下2023-08-08
一文带你学会Java中ScheduledThreadPoolExecutor使用
ScheduledThreadPoolExecutor是Java并发包中的一个类,同时也是 ThreadPoolExecutor的一个子类,本文主要为大家介绍一下ScheduledThreadPoolExecutor使用,需要的可以参考下2024-12-12
SpringBoot使用Redis单机版过期键监听事件的实现示例
在缓存的使用场景中经常需要使用到过期事件,本文主要介绍了SpringBoot使用Redis单机版过期键监听事件的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2024-07-07
这篇文章主要介绍了Java多线程 线程状态原理详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2021-09-09
详解SpringBoot的三种缓存技术(Spring Cache、Layering Cache 框架、Alibaba J
这篇文章主要介绍了SpringBoot的三种缓存技术，帮助大家更好的理解和学习springboot框架，感兴趣的朋友可以了解下2020-10-10
关于idea引入spring boot ＜parent＞＜/parent＞父依赖标红问题
这篇文章主要介绍了idea引入spring boot ＜parent＞＜/parent＞父依赖标红问题,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-10-10
深入解析Spring TransactionTemplate 高级用法(示例代码)
TransactionTemplate是 Spring 框架中一个强大的工具,它允许开发者以编程方式控制事务,通过本文的详细解析和示例代码,我们可以看到如何使用 `TransactionTemplate` 来执行事务性操作,并处理高级事务场景,感兴趣的朋友跟随小编一起看看吧2025-02-02
本文主要介绍了SpringBoot配置Https入门实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2023-11-11
最新评论