如何在Habarta TypeScript Generator中按需区分null与undefined？

一、Habarta TypeScript Generator 局部配置方案 #

Habarta支持通过类注解@TypeScript为单个类覆盖全局配置，正好匹配你的需求：

1. 给PersonPatch类添加类级注解，指定仅该类使用questionMarkAndNullableType规则：

import io.habarta.typescriptgenerator.TypeScript;
import io.habarta.typescriptgenerator.OptionalPropertiesDeclaration;

@TypeScript(optionalPropertiesDeclaration = OptionalPropertiesDeclaration.questionMarkAndNullableType)
public class PersonPatch {
    private Optional<String> name;
    // 其他字段...
}

2. 全局配置保持原有设置（比如默认的questionMark），确保普通Person类的生成结果不受影响：

<!-- 全局配置示例 -->
<plugin>
    <groupId>io.habarta</groupId>
    <artifactId>typescript-generator-maven-plugin</artifactId>
    <configuration>
        <optionalPropertiesDeclaration>questionMark</optionalPropertiesDeclaration>
        <!-- 其他全局配置 -->
    </configuration>
</plugin>

配置完成后，PersonPatch生成的TS接口会是name?: string | null，支持未传(undefined)、传null、传值三种状态；而普通Person类仍保持原有生成逻辑（如name?: string或必填字段）。

二、Java建模替代方案 #

如果不想修改Java代码添加注解，也可以通过类的分组规则实现局部配置：

• 将所有PATCH专用DTO放在单独包（如com.yourproject.dto.patch）
• 在Maven/Gradle插件配置中，通过正则匹配该包并单独设置规则：

<plugin>
    <groupId>io.habarta</groupId>
    <artifactId>typescript-generator-maven-plugin</artifactId>
    <configuration>
        <defaultOptionalPropertiesDeclaration>questionMark</defaultOptionalPropertiesDeclaration>
        <typeConfigurations>
            <typeConfiguration>
                <pattern>com\.yourproject\.dto\.patch\..*</pattern>
                <optionalPropertiesDeclaration>questionMarkAndNullableType</optionalPropertiesDeclaration>
            </typeConfiguration>
        </typeConfigurations>
    </configuration>
</plugin>

三、替代生成工具方案 #

如果Habarta的配置仍无法满足需求，可以考虑以下工具：

1. OpenAPI Generator #

通过OpenAPI规范（YAML/JSON）精确定义每个字段的nullable和required属性，从规范生成TS接口：

• 普通Person类对应的Schema：

Person:
  type: object
  properties:
    name:
      type: string
      nullable: true # 对应TS的string | null
  required: [] # 对应TS的可选字段?:

• PersonPatch类对应的Schema：

PersonPatch:
  type: object
  properties:
    name:
      type: string
      nullable: true # 同时支持null和undefined
  required: []

生成的TS接口会严格遵循规范，完美区分null和undefined，且支持更细粒度的字段控制。

2. J2TS (Java to TypeScript) #

J2TS支持通过自定义注解或配置文件为单个类设置生成规则，可灵活控制字段的可选性和nullability，适合需要高度定制化的场景。

内容的提问来源于stack exchange，提问作者Gobanit