NestJS Code First模式下如何定义GraphQL动态字段

GraphQL 原生强类型系统不支持键名动态的对象结构，所有输出类型必须在Schema生成阶段明确固定字段，你定义的Partial<Record<UserRole, OrderStatus[]>>属于TS层面的动态键类型，NestJS Code First模式无法自动推导为合法GraphQL类型，直接运行会抛出Schema生成错误。

下面按推荐优先级给出可落地的实现方案，兼顾类型安全和开发成本：

方案1：重构为键值对数组结构（优先选择） #

这是最符合GraphQL设计规范的方案，零额外依赖、完全保留前后端类型提示，也不需要你逐个枚举字段查询。
核心思路是把动态键对象，转成「键、值分别作为固定字段」的对象数组，代码实现如下：

import { ObjectType, Field, registerEnumType } from '@nestjs/graphql';

// 先注册已有的枚举类型，Code First模式下枚举必须显式注册
registerEnumType(UserRole, { name: 'UserRole' });
registerEnumType(OrderStatus, { name: 'OrderStatus' });

@ObjectType({ description: '角色与可选订单状态的映射项' })
export class RoleOrderStatusItem {
  @Field(() => UserRole, { description: '用户角色标识' })
  role: UserRole;

  @Field(() => [OrderStatus], { description: '当前角色可选择的订单状态列表' })
  availableStatus: OrderStatus[];
}

@ObjectType({ description: 'project' })
export class Project extends BaseModel {
  @Field(() => [RoleOrderStatusItem], {
    description: '不同角色对应的表单订单状态可选值配置',
    nullable: true // 对应原类型的Partial修饰，允许配置为空
  })
  formSelectOrder: RoleOrderStatusItem[];
}

该方案的优势：

• 完全符合GraphQL强类型校验规则，Schema生成无额外成本
• 前端通过代码生成工具可以拿到100%准确的TS类型，不会丢失任何提示
• 查询时不需要枚举所有可能的角色键，一次查询就能拿到所有配置项，和原动态对象的查询逻辑一致
• 后续扩展成本低，如果需要给单个角色加默认选中状态、排序权重等配置，直接在RoleOrderStatusItem类中加字段即可，不需要改动原有结构
• 业务逻辑改动极小，仅需把原来formSelectOrder[当前角色]的取值方式，改成从数组中匹配对应role的项即可。

方案2：通用Record自定义标量（仅当无法修改数据结构时使用） #

如果因为接口兼容等原因完全不能调整返回结构，不需要为这个字段单独写冗余的专属标量，可以实现一个支持传参的通用Record标量，一次实现可以在所有动态键场景复用，比通用JSON标量多了类型校验能力，也能保留前端类型提示。
简单实现示例：

import { GraphQLScalarType, Kind } from 'graphql';

/**
 * 生成指定键、值类型的动态Record标量
 * @param keyEnum 键对应的枚举对象
 * @param valueGraphQLType 值对应的GraphQL类型
 * @param scalarName 标量在Schema中的唯一名称
 */
export const createGraphQLRecordScalar = <K extends string, V>(
  keyEnum: Record<string, K>,
  valueGraphQLType: any,
  scalarName: string
) => new GraphQLScalarType({
  name: scalarName,
  serialize(value) {
    // 序列化时可加校验：确保key属于指定枚举、value符合对应类型规则
    return value;
  },
  parseValue(value) {
    // 入参解析校验逻辑
    return value;
  },
  parseLiteral(ast) {
    if (ast.kind === Kind.OBJECT) {
      // 查询字面量解析校验逻辑
      return {};
    }
    return null;
  }
});

// 使用时直接在字段上声明即可
@ObjectType({ description: 'project' })
export class Project extends BaseModel {
  @Field(() => createGraphQLRecordScalar(
    UserRole,
    [OrderStatus],
    'UserRoleToOrderStatusRecord'
  ), { nullable: true })
  formSelectOrder: Partial<Record<UserRole, OrderStatus[]>>;
}

不推荐直接使用通用JSON标量的原因 #

通用JSON标量会完全跳过GraphQL层的类型校验，Schema中该字段会被标记为任意JSON值，前端代码生成时会将其识别为any/unknown类型，完全丢失类型提示，后续业务迭代中很容易出现键名写错、枚举值传错等运行时错误，除非是完全无固定结构的扩展属性字段，否则不建议使用。

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