讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 Spring Boot 中将 YAML 配置映射为嵌套 Map 结构

大磊吖_8087

大磊吖_8087

发布时间:2026-06-12 18:20:39

|

758人浏览过

|

来源于php中文网

原创

如何在 Spring Boot 中将 YAML 配置映射为嵌套 Map 结构

本文详解如何通过 @ConfigurationProperties 正确绑定多层嵌套的 YAML 配置(如 car.model.volkswagen.office)到 Java 的 Map<String, T> 结构中,确保深层嵌套对象(如 Office)也能自动注入,无需手动解析或修改配置格式。

本文详解如何通过 `@configurationproperties` 正确绑定多层嵌套的 yaml 配置(如 `car.model.volkswagen.office`)到 java 的 `map` 结构中,确保深层嵌套对象(如 `office`)也能自动注入,无需手动解析或修改配置格式。

在 Spring Boot 中,将 YAML 中的键值结构(尤其是以 Map 形式组织的动态配置项)精准映射为 Java 对象,是微服务对接配置中心(如 Spring Cloud Config)时的常见需求。你提供的配置片段中,car.model 下存在多个厂商(如 volkswagen、honda),每个厂商又包含嵌套的 office 对象——这正是典型的“Map of POJOs with nested objects”场景。

✅ 正确实现的关键在于:保证类结构与 YAML 层级严格一致 + 启用配置属性绑定机制 + 避免手动初始化集合字段。

以下为完整、可直接运行的解决方案:

Spring Boot 3.3.13
Spring Boot 3.3.13

Spring Boot下载页提供 3.3.13 官方源码 ZIP,并整理快速入门、项目创建、配置和自动配置说明。

下载

1. 定义嵌套 POJO 类(注意:必须含无参构造器和标准 getter/setter)

public class Office {
    private String country;
    private String city;
    // 必须提供无参构造器(Lombok @Data 或手动添加)
    public Office() {}
    // getter/setter(略,IDE 可自动生成)
}
public class CarModel {
    private Office office;
    private String year;
    private int ranking;
    public CarModel() {} // 无参构造器必不可少!
    // getter/setter
}
@ConfigurationProperties(prefix = "car")
public class CarProperties { // 推荐命名规范:XXXProperties
    private Map<String, CarModel> model; // ✅ 不要初始化!Spring 会自动创建 LinkedHashMap
    private int wheels;

    // getter/setter(model 和 wheels 均需有 public setter)
    public void setModel(Map<String, CarModel> model) { this.model = model; }
    public void setWheels(int wheels) { this.wheels = wheels; }
}

2. 启用配置属性绑定(Spring Boot 2.2+ 推荐方式)

在主启动类或配置类上添加:

@SpringBootApplication
@EnableConfigurationProperties(CarProperties.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

⚠️ 注意:@EnableConfigurationProperties 是必需的,否则 CarProperties 不会被 Spring 扫描并注入配置值。

3. 验证注入结果

@Service
public class CarService {
    private final CarProperties carProperties;

    public CarService(CarProperties carProperties) {
        this.carProperties = carProperties;
    }

    public void printConfig() {
        System.out.println("Wheels: " + carProperties.getWheels());
        carProperties.getModel().forEach((brand, model) -> 
            System.out.println(brand + " → Office: " + model.getOffice().getCountry() + "/" + model.getOffice().getCity())
        );
        // 输出示例:volkswagen → Office: germany/wolfsburg
    }
}

? 常见错误与排查要点

  • 缺失无参构造器:CarModel 和 Office 若使用 Lombok,请确保 @Data 或 @NoArgsConstructor 已正确添加;否则 Spring 无法实例化嵌套对象。
  • 字段未提供 setter:Map 字段必须有 setModel(...) 方法,且访问修饰符为 public。
  • 误用 @Configuration:CarProperties 是配置载体,不是配置类,应使用 @ConfigurationProperties 而非 @Configuration。
  • 未启用绑定:忘记 @EnableConfigurationProperties 将导致配置完全不生效(model 为 null,office 自然也为 null)。
  • YAML 缩进错误:YAML 对缩进敏感,确保 office: 与 year: 处于同一层级,且使用空格(非 Tab)。

✅ 最佳实践建议

  • 使用 @Validated + @NotNull 等注解增强配置校验;
  • 将 CarProperties 声明为 @Bean 并设置 @Scope(ConfigurableBeanFactory.SCOPE_SINGLETON) 以明确生命周期;
  • 在 application.yml 中添加 spring-boot-configuration-processor 依赖,支持 IDE 配置提示。

只要结构匹配、构造器完备、绑定启用,Spring Boot 的 ConfigurationPropertiesBinder 即可全自动完成从 car.model.honda.office.city 到 CarModel.office.city 的深度映射——无需反射、无需 Environment 手动读取,真正实现声明式、类型安全的配置驱动开发。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

更多
java
java

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

9737

2023.06.15

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

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

6882

2023.07.05

java自学难吗
java自学难吗

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

6072

2023.07.31

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

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

1064

2023.08.01

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

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

888

2023.08.02

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

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

1276

2023.08.02

java有什么用
java有什么用

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

2549

2023.08.02

java在线网站
java在线网站

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

19891

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn