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

Java中 枚举类怎么在 Spring 配置文件 application.yml 中自动绑定属性

云明小哥_1132

云明小哥_1132

发布时间:2026-07-16 16:14:08

|

554人浏览过

|

来源于php中文网

原创

Spring Boot支持YAML字符串自动绑定枚举,需YAML值与枚举常量名(name())严格匹配(大小写敏感),推荐使用UPPER_SNAKE_CASE;可通过@ConfigurationProperties绑定配置类,或@Value直接注入;若需小写/中文等灵活匹配,须自定义Converter并注册为Bean。

java中 枚举类怎么在 spring 配置文件 application.yml 中自动绑定属性

Java 枚举类可以在 Spring Boot 的 application.yml 中直接配置字符串值,Spring 会自动将其绑定为对应枚举类型,前提是字段名、枚举常量名和 YAML 中的值能正确匹配。

枚举定义需规范命名

Spring 默认使用枚举的 name()(即大写常量名)进行绑定。因此 YAML 中应填写枚举常量的原始名称(全大写、下划线分隔),且 Java 枚举需定义标准的 public static final 常量。

  • 推荐使用 UPPER_SNAKE_CASE 风格,例如:ONLINE、OFFLINE
  • 避免在枚举中重写 toString() 或自定义序列化逻辑,除非同时配置了自定义转换器
  • 若枚举含构造参数(如带中文描述),不影响绑定,只要 name 匹配即可

配置类用 @ConfigurationProperties 绑定

定义一个配置类,用 @ConfigurationProperties 注解,并确保该类被 Spring 扫描到(如加 @Component 或在主启动类上用 @EnableConfigurationProperties)。

示例枚举:

立即学习“Java免费学习笔记(深入)”;

public enum Status {
    ONLINE,
    OFFLINE,
    PENDING
}

对应配置类:

@ConfigurationProperties(prefix = "app")
@Component
public class AppProperties {
    private Status defaultStatus;
    // getter/setter
}

YAML 中写法:

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
app:
  default-status: ONLINE

注意:字段名为 defaultStatus,YAML 键为 default-status(遵循 kebab-case),值为枚举常量名 ONLINE。

支持自定义值绑定(如小写或中文)

若希望 YAML 中使用小写(如 online)或中文(如 在线),需提供自定义 Converter:

  • 实现 Converter<String, YourEnum>
  • 注册为 @Bean,并确保其类型为 GenericConversionService 可识别的 converter
  • 常用方式:在配置类中添加 @Configuration 类,用 ConversionService 注册转换逻辑

例如支持小写绑定:

@Component
public class StatusConverter implements Converter<String, Status> {
    @Override
    public Status convert(String source) {
        return Status.valueOf(source.toUpperCase());
    }
}

Spring Boot 2.2+ 会自动发现并注册此类 converter(需在 component scan 范围内)。

常见失败原因与检查点

绑定失败时,通常不是“不支持”,而是细节不匹配:

  • YAML 值大小写错误(如写成 online 但枚举是 ONLINE,且未配 converter)
  • 字段名与 YAML key 的驼峰/短横线转换出错(如 Java 字段 apiTimeout → YAML 应为 api-timeout)
  • 缺少 @ConfigurationProperties 的 prefix 或未启用(如忘记 @EnableConfigurationProperties 或 @Component)
  • 枚举类不在 classpath 下,或被 AOP 代理干扰(极少见,但复杂模块下需留意)

启用 debug 日志可查看绑定过程:logging.level.org.springframework.boot.context.properties=DEBUG。

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

豆包大模型

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

火山引擎

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

DeepSeek

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

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

相关专题

更多
java
java

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

10397

2023.06.15

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

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

7522

2023.07.05

java自学难吗
java自学难吗

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

6592

2023.07.31

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

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

1124

2023.08.01

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

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

928

2023.08.02

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

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

1376

2023.08.02

java有什么用
java有什么用

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

2729

2023.08.02

java在线网站
java在线网站

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

20051

2023.08.03

VibeKnow知识视频制作与导出详解
VibeKnow知识视频制作与导出详解

本专题整理VibeKnow从注册、素材上传、AI生成到预览导出的完整操作,帮助新手快速制作第一条知识讲解视频。

0

2026.10.14

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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