0

0

如何在 OpenAPI 代码生成中禁用默认访问方法并改用 Lombok 注解

花韻仙語

花韻仙語

发布时间:2026-02-11 21:00:27

|

469人浏览过

|

来源于php中文网

原创

如何在 OpenAPI 代码生成中禁用默认访问方法并改用 Lombok 注解

本文探讨为何不建议通过修改 mustache 模板来移除 openapi generator 生成的 java 模型类中的 getter/setter 等访问方法,而是推荐利用 vendor extensions(如 x-class-extra-annotation)安全集成 lombok,兼顾标准兼容性与开发效率。

OpenAPI Generator 的核心设计目标是生成开箱即用、语义完备、生态兼容的模型类。默认生成的 POJO 包含符合 Java Bean 规范的字段、getter/setter、构造器、equals()/hashCode()/toString(),以及对 Jackson 序列化、Bean Validation(如 @NotNull)、JAXB 等主流框架的原生支持。这些能力并非冗余,而是构建可维护 API 客户端与服务端契约的关键基础。

直接删除访问方法(例如通过覆盖 pojo.mustache 模板移除 {{#hasGetter}}...{{/hasGetter}} 块),虽技术上可行,但会引发一系列隐性成本:

  • 破坏序列化兼容性:Jackson 默认依赖标准 getter/setter;若仅靠 @Data 注解替代,需额外配置 @JsonAutoDetect 或全局 ObjectMapper 设置,否则反序列化可能失败;
  • 丢失校验上下文:@Valid 嵌套校验、分组校验(groups = {Create.class})等高级特性依赖标准 Bean 结构,Lombok 生成的方法无法自动继承 OpenAPI 中定义的 x-validation 或 nullable: false 元信息;
  • Vendor extension 失效:OpenAPI Generator 支持的 x-field-extra-annotation、x-class-extra-annotation 等扩展字段,其注入逻辑深度耦合于标准模板流程——一旦模板被大幅裁剪,这些注解将无法正确渲染到字段或类上。

✅ 正确实践:保留标准生成逻辑 + 声明式注入 Lombok

Wordware
Wordware

Wordware是一个自然语言编程工具,使任何人都可以开发、迭代和部署有用的AI应用程序。

下载

推荐使用官方支持的 vendor extensions,在 OpenAPI YAML/Swagger 文件中为模型添加 Lombok 注解,无需修改模板:

components:
  schemas:
    User:
      x-class-extra-annotation: "@lombok.Data @lombok.Builder"
      x-field-extra-annotation:
        id: "@lombok.Generated"
        email: "@javax.validation.constraints.Email"
      properties:
        id:
          type: integer
          format: int64
        email:
          type: string

配合 Maven 插件配置启用扩展支持:

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>7.8.0</version>
  <configuration>
    <generatorName>java</generatorName>
    <configOptions>
      <useBeanValidation>true</useBeanValidation>
      <!-- 启用 vendor extension 解析 -->
      <additionalModelTypeAnnotations>@lombok.NoArgsConstructor</additionalModelTypeAnnotations>
    </configOptions>
  </configuration>
</plugin>
⚠️ 注意事项:additionalModelTypeAnnotations 是全局注入,适用于所有模型类;而 x-class-extra-annotation 可实现按 Schema 精准控制,更灵活;若需 @Builder 的细粒度配置(如 builderClassName),应通过 x-class-extra-annotation 字符串拼接实现,例如 "@lombok.Builder(builderClassName = \"UserBuilder\")";务必在项目中引入 Lombok 依赖及编译插件(如 lombok-maven-plugin 或 IDE 对应插件),确保注解处理器生效;避免混合使用 @Data 与手动 getter/setter —— 这会导致编译错误或行为不一致。

总结而言,OpenAPI Generator 不是“代码片段生成器”,而是契约驱动的全栈建模工具。与其投入大量精力定制模板以适配 Lombok,不如善用其原生扩展机制,在保持标准兼容的前提下,优雅叠加现代 Java 工具链能力。这既降低了维护复杂度,也保障了团队协作中 API 模型的一致性与可演进性。

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

0

2025.09.15

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

529

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

214

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1550

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

863

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

814

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

184

2025.07.29

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

24

2026.02.12

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号