解析 GraphQL 的 Schema 第一步:Types

阅读时长 6 分钟读完

GraphQL 是一种用于构建 API 的查询语言。查询由一个特定架构定义,该架构由类型(Type)和它们之间的关系构成。在 GraphQL 中,类型是定义 API 行为的基本组成部分。对于前端开发者,理解 GraphQL 类型架构是至关重要的。本文将介绍 GraphQL 类型系统中最基础的部分:Types(类型)。

概述

在 GraphQL 架构中,定义了许多类型。它们可以是标量类型(例如数字和字符串),也可以是对象类型(例如用户或文章)。类型是由用户定义的,它们定义了查询所能返回的数据的类型。

例如:

上面的代码定义了一个用户类型,它有四个字段:id、name、email 和 age。每个字段都有一个名称和一个类型。名字是字段的标识符,而类型确定了该字段可以返回的值的类型。在这个例子中,id 是一个唯一的标识符,是一个非可选的 ID 类型,表示一个用户的 ID 号。而 name 和 email 是必填的字符串类型,而 age 是整型,可选字段。

Types 有以下几个关键要素:

  • 名称(Name):用于标识该类型,在 GraphQL 架构中必须是唯一的。
  • 字段(Fields):用于描述该类型包含的数据的结构,包括名称和类型。字段可以是标量类型或者是其他自定义类型。可以使用感叹号来表示字段是否可选。
  • 参数(Arguments):用于定义该类型接受的参数及其类型。参数可以是标量类型或其他自定义类型。
  • 枚举(Enum):用于定义数据类型的预定义值。枚举类型描述一系列可接受值,类似于常量列表。
  • 接口(Interfaces):用于描述功能的公共部分,定义了一个接口,并且多个其他类型继承同一个接口,这样方便对多个类型进行统一处理。

自定义类型

GraphQL 中支持自定义类型,这些自定义类型称为 Object Types。Object Types 指代的是自定义的数据类型。

Object Types 包含一组属性(fields)和值类型(value types),值类型可以是标量类型、枚举类型和其他 Object Types。

自定义类型定义的 Name 应该以大写字母开头,以区分预定义的标量类型。

标量类型

GraphQL 中预定义了一组标量类型。标量类型指简单类型,它们的值无法被分解为更小的部分。

以下是 GraphQL 支持的标量类型:

  • Int:32 位有符号整数。
  • Float:有符号浮点数。
  • Boolean:true/false 值。
  • String:UTF-8 字符序列。
  • ID:由字符串或数字表示的唯一标识符。

枚举类型

GraphQL 中的枚举类型可定义一些可选的值,这些值可用于查询中的指定参数。可以使用枚举类型来限制有效的参数集合。

例如下面定义了一个枚举类型 Gender,包含 MALE 和 FEMALE 两个可选值。

接口

接口(Interfaces)用于在 GraphQL 架构中描述一组操作或查询的共通点。类似于面向对象编程中的抽象类,接口定义了功能上的公共部分。例如,我们可以创建一个接口类型 Pets,它描述了所有宠物共通的行为。

该类型添加了 name 字段、weight 字段、isCute 字段以及一个必须的 ID 字段。

实现了此接口的 Object Types,都必须使用 “implements” 命令实现它所继承的接口。例如:

-- -------------------- ---- -------
---- --- ---------- ---- -
  --- ---
  ----- -------
  ------- ------
  ------- --------
  ----------- ----
-

---- --- ---------- ---- -
  --- ---
  ----- -------
  ------- ------
  ------- --------
  ----------- ----
-

Dog 和 Cat 指定了要实现的接口 Pets,这意味着它们接受了必填的 ID 字段,以及 name、weight、isCute 三个共通字段。同时,他们也可以有自己独有的字段。

参数

Arguments 列表允许在一个 Query、Mutation 或 Subscription 中传递变量。

上面代码定义了 Query 类型,拥有一个 users 字段,该字段接受一组参数,包括 first、offset 和 search。同时返回类型为 User 的数组。

当拥有大量参数时,可考虑将参数封装成 Input Object。

例如:

-- -------------------- ---- -------
----- --------- -
  ----- -------
  ------ -------
  ---- ---
-

---- -------- -
  -------------- ------------ -----
-

该代码定义了一组输入参数,即 UserInput,以及将该参数传递给 addUser 方法,该方法返回单个 User 类型的记录。

示例代码

下面是更具体的代码示例,包括完整的 User 和 Query 类型的定义。

-- -------------------- ---- -------
---- ------ -
  -----
  ------
-

---- --- -
  --- ---
  ----- -------
  ---- ----
  ------- -------
-

---- ---- -
  --- ---
  ----- -------
  ------ -------
  ---- ---
  ----- ------
-

---- ----- -
  -------- ----- ----
-

上面的代码定义了三个 GraphQL Types:Pet、User 和 Query。其中,Pet 和 User 表示数据库中的两个表,每个表包含一组字段。Query 表示一个包含 user 方法的操作,该操作接受一个 ID 参数并返回查询对象。pets 是 User 对象的子字段,返回一个 Pet 类型的数组。

总结

GraphQL 类型系统定义了通过 API 访问数据的结构。Types 是 GraphQL 架构的基本构建块,每个 Type 都描述了可查询的数据的一部分。学会正确地定义 Type 是构建强大而灵活的 GraphQL API 的基础。这篇文章详细介绍了类型系统的概念,包括自定义类型、标量类型、枚举类型、接口和参数。希望读者在学习本文后能够正确地定义 Type,并从中受益。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64c856d55ad90b6d04134d76

纠错
反馈