Spring Boot GraphQL 中处理可选参数的正确方式

在 spring boot 的 graphql 服务中，使用 `@argument` 注解时，java 原生基本类型（如 `int`）无法表示缺失值，导致可选参数缺失时报错；解决方案是改用对应的包装类型（如 `integer`）并设为可空，或在 kotlin 中利用 `?` 语法声明可空类型。

Spring Boot 官方 GraphQL 支持（基于 GraphQL Java Tools 或 Spring for GraphQL）要求所有 @Argument 参数严格匹配查询字段——若客户端未提供某参数，而方法签名中又声明为非空基本类型（如 int、boolean），则会抛出 CoercingParseValueException 或 IllegalArgumentException，因为 GraphQL 解析器无法将“缺失”映射到 int 这类不可空类型。

✅ 正确做法：统一使用包装类型 + 显式 null 检查

@QueryMapping
public List getRecord(
    @Argument String email,
    @Argument Integer dateFrom,        // ✅ 包装类型，可为 null
    @Argument Integer dateTo) {         // ✅ 同样可为 null
    // 处理可选逻辑：dateTo 未传入时视为默认值（如 0 或当前时间戳）
    int actualDateTo = Optional.ofNullable(dateTo).orElse(0);
    return repository.findSpecific(email, 
        Optional.ofNullable(dateFrom).orElseThrow(() -> new IllegalArgumentException("dateFrom is required")),
        actualDateTo);
}

⚠️ 注意事项：

IBM Watson

IBM Watson文字转语音

下载

• ❌ 不要使用 @RequestParam：它仅适用于 REST 控制器（@RestController），在 @Controller 或 GraphQL 查询方法中无效；
• ❌ 避免基本类型（int, long, boolean）作为可选 @Argument 参数；
• ✅ GraphQL Schema 中对应字段需声明为可空类型（即不加 !），例如：

  getRecord(email: String!, dateFrom: Int, dateTo: Int): [Record!]!

• ✅ 若使用 Kotlin，可直接写 Int?，编译后自动对应 java.lang.Integer，语义更清晰：

  @QueryMapping
  fun getRecord(
      @Argument email: String,
      @Argument dateFrom: Int,
      @Argument dateTo: Int?  // ✅ Kotlin 可空 Int，天然适配
  ): List {
      val actualDateTo = dateTo ?: 0
      return repository.findSpecific(email, dateFrom, actualDateTo)
  }

? 总结：GraphQL 参数的“可选性”由 schema 类型定义（是否带 !）与 Java/Kotlin 方法签名共同决定。保持类型可空、配合 Optional 或空安全操作，才能稳健支持灵活的查询场景。