Java 中怎么使用 @ConfigurationProperties 将复杂层级配置映射为结构化对象

风婷大大_9142

风婷大大_9142

2026-08-17

744人浏览

原创

@ConfigurationProperties可自动绑定YAML/properties嵌套配置到Java对象树,需保证属性名与字段名按kebab-case→camelCase规则松散匹配、类型可转换,并通过@EnableConfigurationProperties或@Bean注册启用;支持静态嵌套类、JSR-303校验、默认值及List/Map/Duration等类型自动转换。

java 中怎么使用 @configurationproperties 将复杂层级配置映射为结构化对象

直接用 @ConfigurationProperties 就能将 YAML 或 properties 中的嵌套配置,自动绑定到 Java 对象树上,关键是要保证属性名和字段名严格匹配、类型可转换,并启用配置类扫描。

定义层级对应的 POJO 类

每个层级对应一个类,用标准 getter/setter(Lombok 的 @Data 也行),字段名必须与配置键小写+中划线风格(kebab-case)一一对应。例如:

// application.yml 中有:

app:
  database:
    url: jdbc:h2:mem:testdb
    username: sa
    password: ""
  features:
    enable-cache: true
    timeout-seconds: 30

// 对应 Java 类:

@ConfigurationProperties(prefix = "app")
@Data
public class AppProperties {
    private Database database;
    private Features features;

    @Data
    public static class Database {
        private String url;
        private String username;
        private String password;
    }

    @Data
    public static class Features {
        private boolean enableCache; // 自动映射 enable-cache
        private int timeoutSeconds;  // 自动映射 timeout-seconds
    }
}

启用并注册配置类

两种方式任选其一:

  • 在主启动类或配置类上加 @EnableConfigurationProperties(AppProperties.class)
  • 把 AppProperties 声明为 @Bean,并加上 @ConfigurationProperties("app") 注解

推荐后者,更灵活:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
@Configuration
public class AppConfig {
    @Bean
    @ConfigurationProperties("app")
    public AppProperties appProperties() {
        return new AppProperties();
    }
}

校验和默认值支持

可以在字段上加 JSR-303 注解(如 @NotBlank、@Min),配合 @Validated 启用校验:

@ConfigurationProperties(prefix = "app")
@Validated
@Data
public class AppProperties {
    private Database database;

    @Data
    public static class Database {
        @NotBlank
        private String url;
        @Min(1)
        private int port = 5432; // 提供默认值
    }
}

启动时若配置缺失或不合法,会抛出 BindException,便于早期发现问题。

注意命名规范和类型转换

Spring Boot 默认按以下规则绑定:

  • YAML 中的 enable-cache → Java 字段 enableCache(驼峰转连字符)
  • 支持 List/Map 嵌套:如 app.servers[0].host 可映射为 List
  • 枚举、Duration、DataSize 等类型自动转换(如 10MB → DataSize.ofMegabytes(10))
  • 避免使用基本类型(如 int)而不用包装类(Integer),否则缺省时会报错

不复杂但容易忽略。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11837

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8922

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7652

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1264

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1008

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1496

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3089

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20351

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1355

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习