NestJS/GraphQL中如何处理值包含空格的枚举类型问题

该冲突本质是GraphQL枚举命名规范限制和数据库存量值格式的矛盾：GraphQL 规范要求枚举键名只能由字母、数字、下划线组成，且首字符不能是数字，不支持空格、特殊字符，因此无法直接识别带空格的枚举键。除了批量修改数据库存量数据外，有以下3种可行方案：

方案1：使用valuesMap配置枚举值映射（官方推荐最优解） #

registerEnumType 原生支持valuesMap配置项，可以手动指定每个GraphQL枚举键对应的实际运行时值，不需要修改TS枚举结构，也不需要动数据库数据。

enum UserRoles {
  admin = 'admin',
  superAdmin = 'super admin' // TS侧使用合法标识符作为键，值保持和数据库存储一致
}

registerEnumType(UserRoles, {
  name: 'UserRoles',
  // 自定义枚举键和实际值的映射关系
  valuesMap: {
    superAdmin: {
      value: 'super admin'
    }
  }
})

配置完成后：

• GraphQL Schema中依然会生成符合规范的枚举结构：enum UserRoles { admin, superAdmin }
• 框架自动做双向转换：接收前端传入的superAdmin枚举值时，会自动转成'super admin'给业务逻辑/数据库操作；从数据库读取到'super admin'时，会自动序列化为superAdmin返回给前端。

方案2：字段级双向值转换 #

如果只有个别字段需要做值适配，可以在字段定义层配合class-transformer的@Transform装饰器做双向转换，不需要修改全局枚举配置。

import { Transform, TransformationType } from 'class-transformer';
import { Field, ObjectType } from '@nestjs/graphql';
import { UserRoles } from './user-roles.enum';

@ObjectType()
export class User {
  // 其他字段...

  @Field(() => UserRoles)
  @Transform(({ value, type }) => {
    // 数据库 -> GraphQL响应：把存储的'super admin'转成合法枚举值
    if (type === TransformationType.CLASS_TO_PLAIN) {
      return value === 'super admin' ? UserRoles.superAdmin : value;
    }
    // GraphQL入参 -> 业务/数据库：把枚举superAdmin转回存储用的'super admin'
    if (type === TransformationType.PLAIN_TO_CLASS) {
      return value === UserRoles.superAdmin ? 'super admin' : value;
    }
    return value;
  })
  role: UserRoles;
}

该方案灵活度高，适合仅少量字段存在值格式差异的场景。

方案3：自定义标量替代枚举 #

如果后续角色值可能出现更多不符合GraphQL枚举命名规范的格式（比如带特殊字符、中文等），可以直接放弃使用GraphQL枚举，改用自定义标量做类型约束和校验。

import { Scalar, CustomScalar } from '@nestjs/graphql';
import { Kind, ValueNode } from 'graphql';

// 合法角色值集合，和数据库存储值保持一致
const VALID_ROLES = ['admin', 'super admin'] as const;
type UserRole = typeof VALID_ROLES[number];

@Scalar('UserRole')
export class UserRoleScalar implements CustomScalar<UserRole, UserRole> {
  description = '用户角色类型，校验传入值是否为系统支持的角色';

  // 处理客户端传入的变量值
  parseValue(value: string): UserRole {
    if (!VALID_ROLES.includes(value as UserRole)) {
      throw new Error(`无效角色值: ${value}，仅支持${VALID_ROLES.join('、')}`);
    }
    return value as UserRole;
  }

  // 处理返回给客户端的值
  serialize(value: UserRole): UserRole {
    return value;
  }

  // 处理SDL中直接写的字面量值
  parseLiteral(ast: ValueNode): UserRole {
    if (ast.kind !== Kind.STRING || !VALID_ROLES.includes(ast.value as UserRole)) {
      throw new Error(`无效角色值，仅支持${VALID_ROLES.join('、')}`);
    }
    return ast.value as UserRole;
  }
}

使用时直接将字段类型标记为() => UserRoleScalar即可，完全绕开GraphQL枚举的命名限制，支持任意格式的字符串值。

注意：不要尝试在TS枚举中定义带空格的键名（如'super admin' = 'super admin'），这类写法本身不符合GraphQL枚举的语法规范，构建阶段必然报错，没有兼容空间。

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