如何优雅地定义 GraphQL Schema

面试官：小伙子，你的代码为什么这么丝滑？

GraphQL 是一种用于 API 的查询语言，它类型系统让 API 端点更加可靠，并支持客户端驱动的 API 端点设计。在 GraphQL 中，定义 schema 是一个非常重要的步骤，因为 schema 定义了 API 所包含的数据类型和数据结构，以及对这些数据类型的查询和变更操作。

在本文中，我们将会介绍如何通过一些技巧和最佳实践来优雅地定义 GraphQL Schema，并通过示例代码演示如何使用这些技巧来提高开发效率和代码的可读性和可维护性。

1. 分层设计

为了使 GraphQL Schema 易于理解和维护，我们建议将 schema 分层。我们可以将 schema 分为以下三个层次：

  • 根级别 (Root-Level): 定义 Query 和 Mutation 类型，并指向其他模块。
  • 模块级别 (Module-Level): 定义模块特定的类型、查询和变更操作。 它们可能有各自的小模块或者是动态加载的模块。
  • 实现级别 (Implementation-Level): 定义类型的具体实现细节，例如数据库连接或 API 端点调用。

下面是一个简单的例子：

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

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

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

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

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

2. 使用 GraphQL Tools

GraphQL Tools 是一个用于构建和管理 GraphQL Schema 的工具包。它可以帮助我们轻松地集成 schema，拆分 schema，组合 schema，重命名类型名称和字段名称，甚至还可以混合其他类似 REST API 的数据源。

以下是一个完整的示例代码：

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

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

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

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

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

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

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

3. 好好设计类型

在 GraphQL Schema 中，类型是 schema 的核心组成部分。好的类型设计可以使 schema 更具可读性和可维护性。以下是一些类型设计的最佳实践：

  • 使用简洁的名称 - 命名应清晰、简洁、有意义，最好使用名词，例如 User、Post 等。
  • 使用单数形式 - 标量类型应使用单数形式，例如 String、Int、Boolean 等。
  • 让类型明确 - 你的类型应该确保数据的类型和内部的结构明确和一致。
  • 利用枚举类型 - 枚举类型可以帮助开发人员在特定的列表中定义所有值，并通过一致的方式对外部表示。
  • 使用自定义标量 - 自定义标量可以使我们轻松定义新类型，并可以重用它们。例如，URL、Date、Currency 等。

以下是一个定义 User 类型的示例代码：

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

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

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

4. 使用 Interfaces

GraphQL 支持类型系统的接口定义，这可以帮助我们定义共享特性的类型，并在不同类型之间共享这些特性。

以下是一个定义共享特性的 User 和 Admin 类型的示例代码：

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

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

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

5. 多态类型 (Union Types)

多态类型是一种特殊的类型，可以帮助我们将多个类型组成统一的类型并对外暴露。在 GraphQL Schema 中，多态类型通常在查询的返回类型中使用。例如，在博客站点上，我们可能需要查询所有博客文章和所有用户，将它们合并为单个返回类型，如：阅读文章或者用户的 feed。

以下是一个定义 User 和 Post 联合类型的示例代码：

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

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

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

结论

在本文中，我们介绍了如何通过分层设计、使用 GraphQL Tools、好好设计类型、使用接口和联合类型等技术来优雅地定义 GraphQL Schema。这些技巧不仅可以使您的 schema 更加清晰，易于理解和维护，而且也可以提高代码的可读性、可维护性和重用性。使用这些技巧，可以让您和您的团队在开发 GraphQL API 时更加高效和愉快。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/66faabb544713626014ec530

阅读全文

猜你喜欢

  • ES6 中的 Array.from 和 Array.of 让数组变化不停

    前言 数组是前端开发中非常重要的数据类型之一，它可以帮助我们存储数据，并进行各种操作。ES6 中提供了 Array.from 和 Array.of 方法，让数组的使用变得更加方便和灵活。

    18 天前
  • 如何解决 Promise 中的回调地狱？

    在异步编程过程中，回调地狱是很常见的问题。回调地狱指的是嵌套过多的回调函数，导致代码难以阅读和维护。Promise 是解决回调地狱的一种方式，但是 Promise 本质上仍然是异步回调，所以如何解决 ...

    18 天前
  • Hapi.js 中的用户权限管理和 RBAC 实现

    在现代 Web 应用程序中，用户权限管理及角色-基于访问控制 (RBAC) 是非常重要的一部分。Hapi.js 框架提供了内置的支持，使得我们能够方便地实现用户权限管理和 RBAC。

    18 天前
  • Angular 中可复用的组件设计与实现

    前言 Angular 是一个现代化的前端框架，它的设计与实现非常灵活，可以让我们轻松地将功能进行模块化，组件化。在本篇文章中，我们将介绍如何在 Angular 中设计和实现可复用的组件。

    18 天前
  • Kubernetes 中容器亲和性 (Affinity) 使用详解

    在 Kubernetes 中，容器亲和性是一项非常重要的功能。它可以帮助我们在集群中更好地管理容器，提高资源利用率，保证应用的高可用性等等。下面，本文将详细介绍 Kubernetes 中的容器亲和性，...

    18 天前
  • GraphQL 与 CQRS 结合的实践经验

    什么是 GraphQL？ GraphQL 是一种查询语言和运行时环境，用于构建 API。它由 Facebook 在 2012 年开发，并在 2015 年开源。GraphQL 的一个重要优点是它允许客户...

    18 天前
  • Chai 和 Jasmine 的区别及使用场景对比

    前言 在 JavaScript 前端开发中，单元测试是不可或缺的一环。而在单元测试中，常常需要使用断言库来判断某些条件是否成立，从而判断测试结果是否正确。Chai 和 Jasmine 都是流行的 Ja...

    18 天前
  • 如何优化 CSS Grid 布局的性能

    CSS Grid 布局是一种强大的布局机制，可以轻松地实现复杂的布局设计。然而，过度使用 Grid 布局可能会导致性能问题。本文将介绍如何优化 Grid 布局的性能。

    18 天前
  • 对于 Jest 测试文件扩展名的探究及建议

    作为一名专业的前端开发者，了解 Jest 测试框架是必不可少的。而对于 Jest 测试文件的扩展名，我们可能会有一些疑问，在本文中，我们将探究 Jest 测试文件的扩展名以及如何为我们的项目选择合适的...

    18 天前
  • Cypress 错误解决：如何解决 Cypress 端到端浏览器测试案例失败

    Cypress 是一款非常强大的端到端浏览器测试工具，但是在使用的过程中难免会遇到一些测试案例失败的情况。本文将为大家介绍一些常见的 Cypress 失败情况及其解决方案。

    18 天前
  • 使用 Less Attribute Hack 应对 IE8

    在前端开发中，我们经常要处理兼容性问题，特别是对于老旧的 IE 浏览器。针对 IE8的问题，这篇文章将介绍一种解决方案——使用 Less Attribute Hack。

    18 天前
  • Mongoose Schema 的虚拟属性详解及用法

    在使用 Mongoose 进行 MongoDB 数据库操作的过程中，Schema 是我们必须了解的一个重要概念，它用来定义数据模型的结构和属性。而虚拟属性（Virtual）是 Schema 中一个非常...

    18 天前
  • 如何在 Hapi 中使用 Socket.io 实现实时通信

    Socket.io 是一个基于 Node.js 的实时通信框架，可方便地实现服务端和客户端之间的实时通信。而 Hapi 是一个基于 Node.js 的 Web 开发框架，它提供了一些有用的工具和插件，...

    18 天前
  • 在 ES9 中使用 obj.constructor() 函数创建对象

    在 JavaScript 中，我们通常使用对象字面量或构造函数来创建对象。但在 ES9 中，我们可以使用 obj.constructor() 函数来创建对象。这种方式可以让我们更加灵活地创建对象，并且...

    18 天前
  • 如何使用 Mocha 测试 AngularJS 应用？

    Mocha 是一个流行的 JavaScript 测试框架，可针对多种应用程序和库进行测试。在前端开发领域中，测试是至关重要的一环，特别是对于 AngularJS 应用程序。

    18 天前
  • Next.js 处理外部请求数据的方法和技巧

    Next.js 是一种流行的 React 框架，可以帮助我们构建可靠、可扩展的 Web 应用程序。与许多其他的 React 框架不同，Next.js 还提供了一些处理外部请求数据的方法和技巧，让应用程...

    18 天前
  • 用 Fastify 实现自定义错误处理器

    Fastify 是一个基于 Node.js 的快速和低开销 Web 框架。它专为构建高效和可伸缩的服务而设计，提供了很多强大的功能，如内置的插件系统、路由、中间件等等。

    18 天前
  • Kubernetes 中的 Job 和 CronJob 使用详解

    Kubernetes 是一个用于管理容器化应用程序的开源平台，它有助于在大规模分布式系统中轻松部署、管理和扩展应用。在 Kubernetes 中，Job 和 CronJob 是用于执行批处理任务和定期...

    18 天前
  • 在 Hapi.js 中实现推送通知

    推送通知是现代 Web 应用程序的重要组成部分，使得您可以向用户传递实时信息，而无需用户每次主动获取。在这篇文章中，我们将探讨如何在 Hapi.js 中实现推送通知，以便更好地服务我们的用户。

    18 天前
  • 用 Redis 响应快速的 GraphQL 查询

    GraphQL 是一种用于 API 的查询语言，可以让前端开发人员灵活地请求数据并减少不必要的网络请求。然而，在大型应用程序中，GraphQL 查询可以变得相当复杂和缓慢，尤其是在处理大量数据时。

    18 天前

相关推荐

    暂无文章