当前位置: 首页 > article >正文

【Spring】@ConfigurationProperties 注解的简单使用和介绍

文章目录

  • @ConfigurationProperties 中属性介绍
  • 案例代码介绍
  • ignoreInvalidFields 属性用法
  • ignoreUnknownFields 属性用法

本篇文章主要介绍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属性值设置为falseignoreInvalidFields属性值默认值就是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属性值设置为falseignoreUnknownFields属性值默认值是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





End



http://www.kler.cn/a/9856.html

相关文章:

  • 软件测试 软考
  • 使用D3.js给SVG元素上色
  • qt QColorDialog详解
  • 潮玩宇宙方块兽系统开发:可定制UI与多种游戏内嵌助力个性化体验
  • 基于MPPT最大功率跟踪的光伏发电蓄电池控制系统simulink建模与仿真
  • OceanBase 应用实践:如何处理数据空洞,降低存储空间
  • Hive概论、架构和基本操作
  • ios逆向工具有那些
  • 2022国赛32:NFS服务
  • 【数据库】面试题合集
  • 【JS运算】分组求和/平均值(reduce函数)
  • 2023 年 MQTT 协议的 7 个技术趋势|描绘物联网的未来
  • 使用Nginx反向代理OpenAI API
  • python内置方法的使用方法及示例
  • Python 小型项目大全 46~50
  • 怎样做好仓库管理?必须记住这八条!
  • 文件:IO流
  • 黑马2023JavaScript笔记
  • 鸿鹄工程项目管理系统源码 Spring Cloud+Spring Boot+Mybatis+Vue+ElementUI+前后端分离构建工程项目管理系统
  • 若依数据隔离 ${params.dataScope} 替换 优化为sql 替换
  • 【SQL 必知必会】- 第十三课 创建高级联结
  • Python求矩阵的内积、外积、克罗内克直积、Khatri-Rao积
  • 医院不良事件上报系统源码,全套源代码
  • Spring框架中的Bean
  • QML控件--Container
  • 每日一问-ChapGPT-20230414-中医基础-四诊之问诊