配置 OpenAPI Generator 使用 Jakarta EE 命名空间指南

本文介绍了如何配置 OpenAPI Generator，使其在生成代码时使用 Jakarta EE 命名空间（例如 `jakarta.annotation.Generated`）替代过时的 `javax` 命名空间。这对于升级到 Spring Boot 3.0+ 的项目至关重要，因为 Spring Boot 3.0 移除了 `javax` 依赖。通过修改 Maven 插件配置，可以轻松实现命名空间的切换，确保生成的代码与项目依赖保持一致。

在使用 OpenAPI Generator 为 Spring Boot 3.0 或更高版本的项目生成代码时，你可能会遇到 javax 命名空间相关的问题。这是因为 Spring Boot 3.0 已经迁移到 Jakarta EE，不再默认包含 javax 依赖。为了解决这个问题，你需要配置 OpenAPI Generator 使用 Jakarta EE 命名空间，例如将 @Generated 注解的引用从 javax.annotation.Generated 更改为 jakarta.annotation.Generated。

配置方法

以下步骤展示了如何通过修改 pom.xml 文件来配置 OpenAPI Generator 使用 Jakarta EE 命名空间：

1. 定位 OpenAPI Generator Maven 插件配置：

   在你的 pom.xml 文件中找到 org.openapitools:openapi-generator-maven-plugin 的配置。

2. 添加或修改 节点：

   在 节点中，添加或修改 节点，并设置 属性为 true。

3. 完整配置示例：

   以下是一个完整的 pom.xml 插件配置示例：

   
       org.openapitools
       openapi-generator-maven-plugin
       6.4.0
       
           
               
                   generate
               
               
                   false
                   
                       true
                   
                   
                       ${project.basedir}/src/main/resources/api.openapi.yaml
                   
                   spring
                   some.package
                   some.package.model
               
           
       
   

   说明:

   • true：这个配置项指示 OpenAPI Generator 使用 Jakarta EE 命名空间。
   • ：指定 OpenAPI 规范文件的路径。
   • ：指定使用的生成器名称，这里是 "spring"。
   • 和 ：指定生成的 API 和 Model 类的包名。

4. 重新生成代码：

   完成配置后，运行 mvn clean install 命令重新生成代码。 OpenAPI Generator 将会使用 Jakarta EE 命名空间生成代码。

注意事项

• useSpringBoot3 属性： 虽然也可以使用 useSpringBoot3 属性，但 useJakartaEe 是更通用的选项，因为它不仅适用于 Spring Boot 3，也适用于其他需要 Jakarta EE 命名空间的项目。
• 版本兼容性： 确保使用的 OpenAPI Generator 版本支持 useJakartaEe 属性。建议使用较新的版本，例如 6.4.0 或更高版本。
• 检查生成的代码： 重新生成代码后，仔细检查生成的类，确保所有的 javax 引用都被替换为 jakarta 引用。

总结

通过简单的 Maven 插件配置，你可以轻松地让 OpenAPI Generator 使用 Jakarta EE 命名空间，从而解决 Spring Boot 3.0+ 项目中的依赖问题。 确保正确配置 useJakartaEe 属性，并检查生成的代码，以确保项目能够顺利编译和运行。 这个配置可以帮助你平滑地将项目迁移到 Spring Boot 3.0+，并利用 Jakarta EE 的新特性。