本文详细介绍了如何利用OpenAPI Generator的模板自定义功能，生成在`toString()`方法中排除空值（null）字段的POJO类。通过配置Gradle插件并修改`pojo.mustache`模板文件，开发者可以精确控制代码生成行为，优化输出对象的可读性，避免冗余的null字段显示。
1. 理解OpenAPI Generator的模板机制
OpenAPI Generator是一个强大的工具，能够根据OpenAPI规范生成客户端、服务器存根和模型。其核心优势之一是高度可定制性，允许用户通过修改Mustache模板来调整生成的代码。当需要改变特定类的行为，例如定制toString()方法的输出格式时，修改相应的模板文件是最佳实践。对于POJO（Plain Old Java Object）模型类，通常需要修改pojo.mustache文件。
2. 配置OpenAPI Generator Gradle插件
首先，确保您的build.gradle文件中已正确集成OpenAPI Generator Gradle插件，并指定了自定义模板目录。
plugins { // 引入OpenAPI Generator Gradle插件 id "org.openapitools.openapigenerator" version "7.10.0" }repositories { mavenCentral()}dependencies { // 确保插件运行时依赖也已添加 implementation 'org.openapitools:openapi-generator-gradle-plugin:7.10.0'}// 配置OpenAPI Generator任务openApiGenerate { generatorName = "spring" // 指定生成器类型，例如Spring inputSpec = "$rootDir/path/to/your/openapi.yaml" // OpenAPI规范文件路径 outputDir = "${buildDir}/generate-resources/main" // 生成代码的输出目录 modelPackage = "com.example.model" // 生成模型类的包名 generateModelTests = false // 不生成模型测试 globalProperties = [ modelDocs: "false", // 不生成模型文档 apis: "false", // 不生成API接口 models: "" // 仅生成模型 ] configOptions = [ library: "spring-boot", // 使用Spring Boot库 dateLibrary: "java8" // 日期使用Java 8日期时间API ] // 关键配置：指定自定义Mustache模板的目录 templateDir = "$rootDir/src/main/resources/templates" }
在上述配置中，templateDir = “$rootDir/src/main/resources/templates”是核心，它告诉OpenAPI Generator在生成代码时，优先使用此目录下的模板文件，而不是其内置的默认模板。
3. 创建并自定义模板目录
接下来，在项目根目录（或您指定的任何位置）下创建模板目录，例如src/main/resources/templates。
在该目录下，您需要放置定制化的Mustache模板文件。对于POJO类的toString()方法定制，目标文件是pojo.mustache。
获取原始模板：
为了确保修改的正确性，建议您从OpenAPI Generator的官方GitHub仓库中获取对应版本（例如v7.10.0）的原始pojo.mustache文件作为起点。您可以访问以下链接查找：
Waymark
Waymark是一个视频制作工具，帮助企业快速轻松地制作高影响力的广告。
79 查看详情 
OpenAPI Generator GitHub仓库 (根据您的generatorName和语言选择对应的模板目录，例如Java/spring)
将找到的pojo.mustache文件复制到您的src/main/resources/templates目录中。
4. 修改pojo.mustache以排除空值字段
打开src/main/resources/templates/pojo.mustache文件。找到toString()方法的定义部分。原始的toString()方法通常会遍历所有字段并将其值追加到字符串构建器中。为了排除空值字段，您需要在每个字段的追加逻辑前添加一个条件判断。
以下是一个修改pojo.mustache中toString()方法的示例片段，展示如何添加空值检查：
// ... 其他类定义和方法 ...@Overridepublic String toString() { StringBuilder sb = new StringBuilder(); sb.append("class {{classname}} {\n"); {{#vars}} // 为每个字段添加空值检查 {{^isPrimitive}} // 非原始类型字段才可能为null if (this.{{name}} != null) { sb.append(" {{name}}: ").append(toIndentedString(this.{{name}})).append("\n"); } {{/isPrimitive}} {{#isPrimitive}} // 原始类型字段永远不会为null，直接添加 sb.append(" {{name}}: ").append(toIndentedString(this.{{name}})).append("\n"); {{/isPrimitive}} {{/vars}} sb.append("}"); return sb.toString();}// toIndentedString辅助方法通常已存在，如果不存在，请确保添加// 这个方法用于将对象转换为带缩进的字符串，并处理null值private String toIndentedString(Object o) { if (o == null) { return "null"; // 如果希望完全不显示null字段，这里可以返回"" } return o.toString().replace("\n", "\n ");}// ... 其他方法 ...
代码解释：
{{#vars}} … {{/vars}}: 这是一个Mustache循环，遍历POJO中的所有字段（变量）。{{^isPrimitive}} … {{/isPrimitive}}: 这是一个Mustache条件判断，表示“如果字段不是原始类型（如int, boolean），则执行内部代码”。只有非原始类型才可能为null。{{#isPrimitive}} … {{/isPrimitive}}: 对应地，如果字段是原始类型，则直接追加，因为它们不会是null。if (this.{{name}} != null): 这是Java代码中的空值检查，确保只有当字段不为null时才将其值追加到StringBuilder中。toIndentedString(Object o): 这个辅助方法通常由OpenAPI Generator提供，用于格式化输出。您可以根据需要调整其行为，例如当o为null时返回空字符串””，这样toString()的输出中将完全不包含该字段的行。
5. 重新生成代码
完成模板修改后，执行Gradle的openApiGenerate任务来重新生成您的模型类。
./gradlew openApiGenerate
此时，生成的POJO模型类中的toString()方法将根据您的定制逻辑，自动排除所有值为null的字段。
6. 注意事项与总结
版本兼容性： 不同的OpenAPI Generator版本可能使用略有不同的Mustache模板变量和结构。在复制和修改模板时，务必参考与您使用的OpenAPI Generator插件版本匹配的模板。模板依赖： 有些模板可能依赖于其他模板文件或辅助方法。在修改pojo.mustache时，如果发现缺少某些辅助方法（如toIndentedString），可能需要从原始模板集中找到并复制过来。粒度控制： 通过自定义模板，您可以实现对生成代码的极致控制。除了toString()方法，您还可以修改构造函数、equals/hashCode方法、字段注解等。维护成本： 自定义模板虽然强大，但也增加了项目的维护成本。当OpenAPI Generator版本升级时，您可能需要检查并更新您的自定义模板以保持兼容性。
通过上述步骤，您已经成功地利用OpenAPI Generator的模板定制功能，生成了符合特定输出要求（排除空值字段）的toString()方法，从而提高了生成代码的实用性和可读性。
以上就是使用OpenAPI Generator生成不包含空值字段的toString方法的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1031895.html
微信扫一扫 
支付宝扫一扫 
