Skip to main content
目录

标量

GraphQL 对象类型有一个名称和字段，但这些字段最终必须解析为某些具体的数据。 这就是标量类型发挥作用的地方：它们表示查询的叶子节点（阅读更多）。 GraphQL 包括以下默认类型：Int、Float、String、Boolean 和 ID。 除了这些内置类型外，您可能需要支持自定义原子数据类型（例如 Date）。

首选代码方式​

代码优先方法提供了五个标量，其中三个是现有 GraphQL 类型的简单别名。

  • ID（GraphQLID 的别名） - 表示唯一标识符，通常用于重新获取对象或作为缓存的键
  • Int（GraphQLInt 的别名） - 32 位有符号整数
  • Float（GraphQLFloat 的别名） - 64 位双精度浮点值
  • GraphQLISODateTime - UTC 时间的日期时间字符串（默认用于表示 Date 类型）
  • GraphQLTimestamp - 表示日期和时间的有符号整数，作为从 UNIX 纪元开始的毫秒数

默认情况下，GraphQLISODateTime（例如 2019-12-03T09:54:33Z）用于表示 Date 类型。 要改用 GraphQLTimestamp，请将 buildSchemaOptions 对象的 dateScalarMode 设置为 'timestamp'， 如下所示：

GraphQLModule.forRoot({
  buildSchemaOptions: {
    dateScalarMode: 'timestamp',
  }
}),

同样，默认情况下，GraphQLFloat 用于表示number类型。 要改用 GraphQLInt，请将 buildSchemaOptions 对象的 numberScalarMode 设置为 'integer'， 如下所示：

GraphQLModule.forRoot({
  buildSchemaOptions: {
    numberScalarMode: 'integer',
  }
}),

此外，您还可以创建自定义标量。

覆盖默认标量​

要为 Date 标量创建自定义实现，只需创建一个新类。

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

@Scalar('Date', (type) => Date)
export class DateScalar implements CustomScalar<number, Date> {
  description = 'Date custom scalar type';

  parseValue(value: number): Date {
    return new Date(value); // 从客户端获取的值
  }

  serialize(value: Date): number {
    return value.getTime(); // 发送到客户端的值
  }

  parseLiteral(ast: ValueNode): Date {
    if (ast.kind === Kind.INT) {
      return new Date(ast.value);
    }
    return null;
  }
}

有了这个，将 DateScalar 注册为提供程序。

@Module({
  providers: [DateScalar],
})
export class CommonModule {}

现在我们可以在我们的类中使用 Date 类型。

@Field()
creationDate: Date;

导入自定义标量​

要使用自定义标量，导入并将其注册为解析器。 我们将使用 graphql-type-json 包作为演示目的。此 npm 包定义了 JSON GraphQL 标量类型。

首先安装该包：

npm i --save graphql-type-json

安装包后，我们将一个自定义解析器传递给 forRoot() 方法：

import GraphQLJSON from 'graphql-type-json';

@Module({
  imports: [
    GraphQLModule.forRoot({
      resolvers: { JSON: GraphQLJSON },
    }),
  ],
})
export class AppModule {}

现在我们可以在我们的类中使用 JSON 类型。

@Field((type) => GraphQLJSON)
info: JSON;

对于一套有用的标量，可以查看 graphql-scalars 包。

创建自定义标量​

要定义自定义标量，请创建一个新的 GraphQLScalarType 实例。我们将创建一个自定义的 UUID标量。

const regex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;

function validate(uuid: unknown): string | never {
  if (typeof uuid !== "string" || !regex.test(uuid)) {
    throw new Error("invalid uuid");
  }
  return uuid;
}

export const CustomUuidScalar = new GraphQLScalarType({
  name: 'UUID',
  description: 'A simple UUID parser',
  serialize: (value) => validate(value),
  parseValue: (value) => validate(value),
  parseLiteral: (ast) => validate(ast.value)
})

我们传递一个自定义解析器给 forRoot() 方法：

@Module({
  imports: [
    GraphQLModule.forRoot({
      resolvers: { UUID: CustomUuidScalar },
    }),
  ],
})
export class AppModule {}

现在我们可以在我们的类中使用 UUID 类型。

@Field((type) => CustomUuidScalar)
uuid: string;

架构优先​

要定义自定义标量（了解更多关于标量的信息），创建一个类型定义和一个专用的解析器。 这里（与官方文档一样），我们将使用 graphql-type-json 包作为演示目的。 此 npm 包定义了 JSON GraphQL 标量类型。

首先安装该包：

npm i --save graphql-type-json

安装包后，我们传递一个自定义解析器给 forRoot() 方法：

import GraphQLJSON from 'graphql-type-json';

@Module({
  imports: [
    GraphQLModule.forRoot({
      typePaths: ['./**/*.graphql'],
      resolvers: { JSON: GraphQLJSON },
    }),
  ],
})
export class AppModule {}

现在我们可以在我们的类型定义中使用 JSON 标量：

scalar JSON

type Foo {
  field: JSON
}

另一种定义标量类型的方法是创建一个简单的类。假设我们想要使用 Date 类型增强我们的架构。

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

@Scalar('Date')
export class DateScalar implements CustomScalar<number, Date> {
  description = 'Date custom scalar type';

  parseValue(value: number): Date {
    return new Date(value); // 从客户端获取的值
  }

  serialize(value: Date): number {
    return value.getTime(); // 发送到客户端的值
  }

  parseLiteral(ast: ValueNode): Date {
    if (ast.kind === Kind.INT) {
      return new Date(ast.value);
    }
    return null;
  }
}

有了这个，将 DateScalar 注册为提供程序。

@Module({
  providers: [DateScalar],
})
export class CommonModule {}

现在我们可以在类型定义中使用 Date 标量。

scalar Date

默认情况下，所有标量的生成 TypeScript 定义都是 any，这并不特别类型安全。 但是，您可以在指定如何生成类型时配置 Nest 为自定义标量生成 typings：

import { GraphQLDefinitionsFactory } from '@nestjs/graphql';
import { join } from 'path';

const definitionsFactory = new GraphQLDefinitionsFactory();

definitionsFactory.generate({
  typePaths: ['./src/**/*.graphql'],
  path: join(process.cwd(), 'src/graphql.ts'),
  outputAs: 'class',
  defaultScalarType: 'unknown',
  customScalarTypeMapping: {
    DateTime: 'Date',
    BigNumber: '_BigNumber',
  },
  additionalHeader: "import _BigNumber from 'bignumber.js'",
});
note

或者，您可以使用类型引用，例如：DateTime: Date。 在这种情况下，GraphQLDefinitionsFactory 将提取指定类型（Date.name）的 name 属性以生成 TS 定义。 注意：对于非内置类型（自定义类型），需要添加导入语句。

现在，鉴于以下 GraphQL 自定义标量类型：

scalar DateTime
scalar BigNumber
scalar Payload

我们现在将在 src/graphql.ts 中看到以下生成的 TypeScript 定义：

import _BigNumber from 'bignumber.js';

export type DateTime = Date;
export type BigNumber = _BigNumber;
export type Payload = unknown;

在这里，我们使用了 customScalarTypeMapping 属性提供我们希望为自定义标量声明的类型的映射。 我们还提供了 additionalHeader 属性，以便我们可以添加这些类型定义所需的任何导入。 最后，我们添加了一个 defaultScalarType， 将未在 customScalarTypeMapping 中指定的任何自定义标量别名为 unknown， 而不是 any（TypeScript 从 3.0 版本开始推荐使用 unknown 以增加类型安全性）。

note

请注意，我们从 bignumber.js 导入了 _BigNumber； 这是为了避免循环类型引用。