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

OpenAPI Generator 枚举值前缀被自动截断问题的解决方案

小磊大大_4194

小磊大大_4194

发布时间:2026-05-20 10:21:44

|

630人浏览过

|

来源于php中文网

原创

OpenAPI Generator 默认会移除枚举值中与字段名(如 sb)匹配的前缀(如 SB_),导致生成的 Java 枚举常量名异常(如 _150_150)。本文介绍通过配置 removeEnumValuePrefix=false 禁用该行为,实现原始枚举值到常量名的一对一映射。

openapi generator 默认会移除枚举值中与字段名(如 `sb`)匹配的前缀(如 `sb_`),导致生成的 java 枚举常量名异常(如 `_150_150`)。本文介绍通过配置 `removeenumvalueprefix=false` 禁用该行为,实现原始枚举值到常量名的一对一映射。

在使用 OpenAPI Generator(尤其是 Maven 插件)生成 Java 客户端或服务端代码时,若 OpenAPI 规范中定义了以特定前缀(如 SB_)开头的字符串枚举值,你可能会遇到枚举常量名被意外截断的问题。例如,以下 YAML 片段:

sb:
  type: string
  enum:
    - SB_150_150
    - SB_300_150

默认生成的 Java 枚举类中,常量名会丢失 SB_ 前缀:

public enum SbEnum {
    _150_150("SB_150_150"),
    _300_150("SB_300_150");
    // ...
}

这是由于 OpenAPI Generator 内置的枚举值前缀自动剥离机制(removeEnumValuePrefix)默认启用:当枚举值以字段名(snake_case 或 UPPERCASE 形式推导出的前缀,如 `SB`)开头时,会将其移除以生成更“Java 风格”的常量名。虽然该机制在部分场景下有益,但在需要严格保留原始命名语义(如与外部系统约定一致、日志/调试可读性要求高)时,反而成为障碍。

✅ 解决方案:显式禁用前缀移除

在 pom.xml 的 openapi-generator-maven-plugin 配置中,添加 removeEnumValuePrefix=false 到 :

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>6.4.0</version>
  <configuration>
    <inputSpec>${project.basedir}/src/main/resources/openapi.yaml</inputSpec>
    <generatorName>java</generatorName>
    <!-- 关键配置:禁止自动移除枚举值前缀 -->
    <additionalProperties>
      <removeEnumValuePrefix>false</removeEnumValuePrefix>
    </additionalProperties>
  </configuration>
</plugin>

执行 mvn clean generate-sources 后,即可获得预期结果:

public enum SbEnum {
    SB_150_150("SB_150_150"),
    SB_300_150("SB_300_150");

    private final String value;
    SbEnum(String value) { this.value = value; }
    public String getValue() { return value; }
}

⚠️ 注意事项

  • 该配置仅影响枚举常量名(name() 返回值),不影响其关联的原始字符串值(getValue() 或 toString() 返回值),后者始终与 OpenAPI 中定义的 enum 字符串完全一致;
  • 若项目中其他枚举依赖默认前缀移除逻辑(例如 status: [ACTIVE, INACTIVE] 期望生成 ACTIVE, INACTIVE 而非 STATUS_ACTIVE),请评估全局禁用的影响,必要时可通过 --global-property 或单独配置不同生成任务;
  • 该选项自 OpenAPI Generator v5.4.0 起稳定支持,推荐使用 v6.x 及以上版本以获得完整兼容性与修复;
  • 对于 Gradle 用户,等效配置为:
    generatorName = "java"
    additionalProperties = [
        "removeEnumValuePrefix": "false"
    ]

通过一行关键配置,即可精准控制枚举命名策略,在保持代码规范性的同时,尊重 OpenAPI 规范的原始语义——这是构建健壮、可维护 API 集成层的重要实践。

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

热门AI工具

更多
豆包大模型

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

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

DeepSeek

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

相关专题

更多
java
java

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

11317

2023.06.15

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

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

8422

2023.07.05

java自学难吗
java自学难吗

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

7252

2023.07.31

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

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

1204

2023.08.01

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

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

988

2023.08.02

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

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

1456

2023.08.02

java有什么用
java有什么用

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

2989

2023.08.02

java在线网站
java在线网站

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

20231

2023.08.03

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

100

2026.10.22

热门下载

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

精品课程

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

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