生成OpenAPI Generator中不输出空值的toString()方法-java教程-PHP中文网

生成OpenAPI Generator中不输出空值的toString()方法

DDD

发布： 2025-11-11 16:15:02

原创

643人浏览过

生成OpenAPI Generator中不输出空值的toString()方法

本文详细介绍了如何利用openapi generator的自定义模板功能，生成排除空值字段的`tostring()`方法。通过集成gradle插件、配置自定义模板目录，并修改`pojo.mustache`文件中的`tostring()`方法生成逻辑，开发者可以实现对模型类`tostring()`输出的精细控制，从而避免显示冗余的null值。

在基于OpenAPI规范生成Java模型类时，默认生成的toString()方法通常会包含所有字段，包括那些值为null的字段。这在调试或日志输出时可能会导致信息冗余。为了优化toString()方法的输出，使其仅显示非空字段，我们可以利用OpenAPI Generator提供的自定义模板机制。

1. 理解OpenAPI Generator的模板机制

OpenAPI Generator使用Mustache模板引擎来生成代码。这意味着每个生成的代码文件（如Java类、接口等）都对应一个或多个Mustache模板文件。要修改特定代码的生成方式，例如toString()方法，就需要找到并定制相应的Mustache模板。对于Java模型类（POJO），主要的模板文件是pojo.mustache。

2. 集成OpenAPI Generator Gradle插件并配置模板目录

首先，确保你的项目中已集成了OpenAPI Generator Gradle插件。然后，在build.gradle文件中配置插件，并指定一个自定义模板目录。这个目录将存放你修改后的Mustache模板文件。

plugins {
    id "org.openapitools.openapigenerator" version "7.10.0" // 使用最新版本
}

repositories {
    mavenCentral()
}

dependencies {
    // 确保插件运行时依赖也已声明
    implementation 'org.openapitools:openapi-generator-gradle-plugin:7.10.0'
}

openApiGenerate {
    // 定义生成任务
    generatorName = "spring" // 例如，使用spring生成器
    inputSpec = "$rootDir/path/to/your/openapi.yaml" // 你的OpenAPI规范文件路径
    outputDir = "${buildDir}/generated-src/main/java" // 生成代码的输出目录
    modelPackage = "com.example.model" // 模型类包名
    generateModelTests = false
    globalProperties = [
            modelDocs: "false",
            apis: "false",
            models: ""
    ]
    configOptions = [
            library: "spring-boot",
            dateLibrary: "java8"
    ]

    // 关键配置：指定自定义Mustache模板的目录
    templateDir = "$rootDir/src/main/resources/templates"
}

登录后复制

在上述配置中，templateDir = "$rootDir/src/main/resources/templates" 指示生成器在src/main/resources/templates目录下查找自定义模板。如果在这个目录中找到了与内置模板同名的文件，生成器将优先使用自定义版本。

3. 创建并配置自定义模板目录

根据上一步的配置，在你的项目根目录下创建src/main/resources/templates目录。

your-project/
├── src/
│   └── main/
│       └── resources/
│           └── templates/
│               └── Java/  // 通常需要根据语言/框架结构创建子目录
│                   └── pojo.mustache
├── build.gradle
└── ...

登录后复制

注意： OpenAPI Generator的模板通常是按语言和生成器类型组织的。例如，Spring Boot的Java模板可能位于Java/子目录下。你需要根据你使用的generatorName（例如spring）和语言（Java）来确定pojo.mustache的正确路径。最稳妥的方法是查看OpenAPI Generator的GitHub仓库中对应生成器的模板结构。

4. 修改 pojo.mustache 以定制 toString() 方法

这是实现目标的核心步骤。

获取原始 pojo.mustache: 首先，你需要获取OpenAPI Generator默认的pojo.mustache文件内容作为起点。你可以在OpenAPI Generator的GitHub仓库中找到它们： https://www.php.cn/link/e0f5a669360c464e40e60b459157c73e 导航到你所使用的生成器（例如spring）对应的模板目录，找到pojo.mustache文件，并将其内容复制到你自定义的src/main/resources/templates/Java/pojo.mustache文件中。
定位并修改 toString() 方法块: 在复制的pojo.mustache文件中，查找负责生成toString()方法的代码块。它通常会包含@Override注解和public String toString()方法签名。

原始的toString()方法可能类似于：

法语写作助手
法语助手旗下的AI智能写作平台，支持语法、拼写自动纠错，一键改写、润色你的法语作文。

31

查看详情
```
@Override
public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class {{classname}} {\n");
    {{#vars}}
    sb.append("    ").append("{{name}}: ").append({{getter}}()).append("\n");
    {{/vars}}
    sb.append("}");
    return sb.toString();
}
```
登录后复制
为了排除空值，你需要为每个字段添加条件判断。OpenAPI Generator的Mustache上下文通常会提供一些辅助函数，例如isNotNull或直接通过{{#name}} ... {{/name}}来判断字段是否存在或非空（这取决于具体模板上下文的实现）。

一个通用的修改思路是：
```
@Override
public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class {{classname}} {\n");
    {{#vars}}
    // 假设OpenAPI Generator的Mustache上下文提供了isNotNull辅助函数
    // 或者字段本身作为Mustache section时，如果为null则不渲染其内容
    {{#name}} // 尝试使用字段名作为section，如果为null则不进入此块
    if ({{getter}}() != null) { // 显式添加Java null检查
        sb.append("    ").append("{{name}}: ").append({{getter}}()).append("\n");
    }
    {{/name}}
    {{/vars}}
    sb.append("}");
    return sb.toString();
}
```
登录后复制
重要提示：
- {{#name}} ... {{/name}}在Mustache中表示一个“section”，如果name的值是null、false、空列表或空字符串，则该section内部的内容不会被渲染。这是一种在Mustache层面排除空值的方法。
- 为了更健壮，可以在Mustache模板中结合Java代码进行显式null检查（如if ({{getter}}() != null)），确保即使Mustache上下文处理不完全，生成的Java代码也能正确处理。
- 你可能需要根据你所使用的OpenAPI Generator版本和具体生成器（如spring、java等）的pojo.mustache结构来调整上述代码。仔细研究原始模板中toString()方法是如何遍历字段的。

5. 重新生成代码

完成pojo.mustache的修改后，运行Gradle任务重新生成代码：

./gradlew clean openApiGenerate

登录后复制

检查生成的模型类文件，其toString()方法现在应该只包含非null的字段。

注意事项与总结

模板版本兼容性: 确保你从GitHub获取的pojo.mustache版本与你使用的OpenAPI Generator插件版本相匹配，以避免不必要的兼容性问题。
模板依赖性: 有些模板可能依赖于其他模板或特定的上下文变量。在修改时，请确保不破坏这些依赖关系。
调试模板: 如果生成的代码不符合预期，可以尝试在模板中添加临时的调试输出（例如，打印{{name}}、{{dataType}}等变量的值）来理解模板上下文。
持续集成: 将自定义模板纳入版本控制，并确保CI/CD流程中包含代码生成步骤。

通过上述步骤，你可以灵活地定制OpenAPI Generator生成的代码，使其更符合项目的特定需求，提高代码的可读性和实用性。

以上就是生成OpenAPI Generator中不输出空值的toString()方法的详细内容，更多请关注php中文网其它相关文章！