如何在GraphQL中表示灵活/未知类型的TypeScript数据

你的TypeScript接口是典型的动态嵌套键值结构，而GraphQL本身是强类型、静态定义的，确实没法直接映射TS的索引签名。下面给你几个可行的实现方案：

方案1：使用JSON标量类型 #

这是最直接的方案，利用GraphQL的JSON标量来容纳整个动态结构，完全保留原数据的嵌套格式。

类型定义 #

如果用Apollo Server这类框架，可以直接引入@graphql-scalars/json提供的JSON标量：

scalar JSON

type Query {
  getChangedAttributes: JSON
}

示例返回结果 #

返回的结构和你TS里的示例完全一致：

{
  "data": {
    "getChangedAttributes": {
      "second_attribute": {
        "disabled": { "from": false, "to": true },
        "value": { "from": "test", "to": "test2" }
      },
      "first_attribute": {
        "name": { "from": "fred", "to": "george" }
      }
    }
  }
}

优缺点 #

• ✅ 完全保留原数据结构，开发成本极低
• ❌ 失去GraphQL的类型校验能力，客户端无法自动推导类型，需要手动处理JSON解析后的类型

方案2：扁平化结构+联合类型 #

把动态的嵌套结构拆成扁平的条目，用GraphQL的联合类型来覆盖from和to的任意类型，兼顾类型安全和业务需求。

类型定义 #

# 定义from/to可能的类型
scalar JSON # 兜底用JSON处理复杂对象
type StringValue { value: String }
type BooleanValue { value: Boolean }
type NumberValue { value: Float }

union ChangeValue = StringValue | BooleanValue | NumberValue | JSON

# 单个字段的变更记录
type FieldChange {
  fieldName: String!
  from: ChangeValue!
  to: ChangeValue!
}

# 单个属性的变更集合
type AttributeChange {
  attributeName: String!
  fieldChanges: [FieldChange!]!
}

type Query {
  getChangedAttributes: [AttributeChange!]!
}

示例返回结果 #

原数据会被转成扁平数组结构：

{
  "data": {
    "getChangedAttributes": [
      {
        "attributeName": "second_attribute",
        "fieldChanges": [
          {
            "fieldName": "disabled",
            "from": { "__typename": "BooleanValue", "value": false },
            "to": { "__typename": "BooleanValue", "value": true }
          },
          {
            "fieldName": "value",
            "from": { "__typename": "StringValue", "value": "test" },
            "to": { "__typename": "StringValue", "value": "test2" }
          }
        ]
      },
      {
        "attributeName": "first_attribute",
        "fieldChanges": [
          {
            "fieldName": "name",
            "from": { "__typename": "StringValue", "value": "fred" },
            "to": { "__typename": "StringValue", "value": "george" }
          }
        ]
      }
    ]
  }
}

优缺点 #

• ✅ 完全符合GraphQL的强类型规范，客户端可以获得完整的类型推导
• ❌ 需要修改原数据的结构，后端需要做一层转换逻辑，对复杂对象的处理依赖JSON标量兜底

方案3：自定义标量类型 #

如果上面的方案都不满足，可以自定义一个专门处理ChangedAttributes结构的标量，自己实现序列化和反序列化逻辑。

核心步骤 #

1. 定义标量类型：scalar ChangedAttributes
2. 在后端实现标量的serialize、parseValue、parseLiteral方法，确保能正确处理动态嵌套结构
3. 客户端对应实现类型解析逻辑

优缺点 #

• ✅ 完全定制化，完美匹配原数据结构
• ❌ 开发成本高，需要维护自定义标量的解析逻辑，失去GraphQL的类型自省能力

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