解析 GraphQL 的 Schema 第一步:Types

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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前