如何为graphql-java-codegen生成的GraphQL类型添加Bean Validation注解

我有自定义输入类型，需要对其进行验证，希望采用Bean Validation，但不清楚如何为graphql-java-codegen生成的Java代码添加相关注解。GraphQL自带的验证功能不足，比如缺少长度验证。核心问题是：是否可以为生成的代码添加Bean Validation注解？

我考虑了以下几种方案：

• 为生成的代码添加Bean Validation注解——这是本次问询的核心
• 为生成的代码编写自定义验证器：工作量不小。无法直接使用Bean Validation，需自行编写验证器，工作量可能大于手动维护GraphQL Java类型；若坚持使用Bean Validation，则需先将输入映射到业务逻辑类型再验证，但这种映射前置的方式不符合尽早验证的原则
• 手动维护输入类型（乃至所有GraphQL Java端类型）：工作量不大，或许是不错的替代方案
• 自定义验证指令：我对此持保留态度

可以为graphql-java-codegen生成的代码添加Bean Validation注解，主要有两种实用方式：

1. 利用codegen的自定义注解配置 #

graphql-java-codegen支持通过配置文件（如codegen.yml）直接指定要注入到生成类或字段上的注解，无需修改生成后的代码。示例配置如下：

generateClient: true
customAnnotations:
  # 为特定字段添加长度验证注解
  - target: FIELD
    annotation: "javax.validation.constraints.Size(min = 2, max = 50)"
    when:
      fieldNamePattern: "username|email"
  # 为所有输入类添加非空校验注解
  - target: CLASS
    annotation: "javax.validation.constraints.NotNull"
    when:
      typeNamePattern: ".*Input"

这种方式配置简单，不会在重新生成代码时丢失自定义设置，是最推荐的方案。

2. 自定义代码生成模板 #

如果配置规则无法满足复杂的注解逻辑，可以替换codegen的默认模板（如inputType.ftl），在模板中嵌入Bean Validation注解的生成逻辑。示例模板片段：

<#if field.name == "username">
    @javax.validation.constraints.Size(min = 3, max = 20)
</#if>
private ${field.type} ${field.name};

这种方式灵活性更高，但需要维护自定义模板，升级codegen版本时要注意模板兼容性。

方案对比与建议 #

• 优先选自定义注解配置：无需维护额外模板，能覆盖绝大多数常见验证场景，契合代码生成的自动化优势。
• 复杂场景再用自定义模板：适合有特殊注解规则的需求，但要做好模板版本管理。
• 其他方案的优劣：
  • 自定义验证器：工作量大，且浪费Bean Validation的生态工具支持，不推荐。
  • 手动维护输入类型：短期工作量小，但失去了代码生成带来的一致性和自动更新能力，长期维护成本会上升。
  • 自定义验证指令：无法复用Bean Validation的注解和校验逻辑，额外增加规则维护成本，非跨语言验证需求不建议使用。

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