GraphQL 中的 Schema Stitching 理解及实践

GraphQL 是一个深受欢迎的用于构建 API 的技术，它的优势在于可以让前端开发者查询自己所需的数据，而不是收到后端传来的所有数据。在使用 GraphQL 构建 API 时，尤其是在团队协作中，需要组合多个 schema 时，使用 Schema Stitching 可以方便地将这些 schema 融合到一个大 schema 中。

什么是 Schema Stitching

Schema Stitching 即将多个 schema 合并成一个大 schema，使其看起来像单个 schema，从而让客户端能够像发起单一请求一样请求到组合后的数据。在 GraphQL 中，每个 schema 都描述了对应的 API 的数据模型，其中包含了类型定义，查询、变更和订阅等操作。

实际上，在应用程序的不同层级中都可能存在着多个 schema，例如在微服务中，一个 API 服务可能有不同的数据源，每个数据源都有自己的 schema。使用 Schema Stitching 可以将这些 schema 组合成一个大 schema，然后由客户端对它进行查询。这样做的好处在于：

  • 更好的抽象和复用多个 GraphQL API
  • 在 GraphQL API 中引入可重用和可组合的代码和功能
  • 可以更好地支持微服务架构，更灵活地处理 schema 和数据源的组合

实现 Schema Stitching

Schema Stitching 是一个复杂的概念，但我们可以将其拆分成各个部分来更好地理解它的实现细节。

模式通信

首先，让我们建立一个小型的 schema。考虑以下的类型定义，其中包含了一个 Query 类型和一个 Movie 类型：

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

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

怎样合并这个 schema 呢？首先，我们需要将其转换成一个对象。可以使用以下代码将其转换成一个封装了类型定义的对象：

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

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

然后我们需要将所有需要合并的 schema 转换成对象并将它们传递给一个 mergeSchemas 函数：

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

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

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

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

这里，我们使用了 mergeSchemas 函数来合并三个 schema，即 schema1、schema2 和我们之前定义的 schema。该函数将这三个 schema 合并成一个大 schema。我们可以像对待单个 schema 一样对待合并后的 schema，从而获得相同的查询和变更能力。

解析器

其次，我们需要将解析器添加到所有受到合并的 schema 中，从而能够处理查询和变更。一个解析器负责处理某个类型的查询或变更，可以是一个 JavaScript 类或函数。解析器需要从一个 GraphQL 对象中获取所需的数据并将其返回给客户端。

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

对于每个类型字段，我们需要提供一个对应的解析器。解析器需要将某个对象或值映射到该类型的解析函数。

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

按需解析

最后，我们需要确保按需解析返回的字段。这是 GraphQL 的一个强大功能，它能够减少网络请求，快速返回请求结果。

例如，假设我们要查询电影的标题、年份和导演：

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

这就意味着我们需要为每个字段提供一个对应的解析器。但是，如果我们查询以下字段，

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

那么我们便不需要为年份和导演提供解析器。

解决这个问题的方法是使用“添加一些”模式（additive pattern）。我们可以在每个解析器函数中检查 GraphQL 对象中的字段：

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

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

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

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

这里，我们使用了 fieldNodes 属性来检查客户端请求的字段，并返回响应的数据。如果客户端查询所有字段，我们将返回一个完整的电影对象，如果只查询了部分字段，我们只需返回相应的字段即可。

示例代码

下面是一个演示了如何使用 Schema Stitching 的示例代码。我们有两个 schema，分别用于处理用户和文章数据：

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

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

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

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

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

我们可以使用 mergeSchemas 函数将这两个 schema 合并成一个大 schema：

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

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

接下来，我们可以在客户端查询 graphql API，使用以下代码查询用户和文章信息：

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

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

这里，我们查询了用户 Alice 和她的文章 "Hello, GraphQL!"，并打印出了结果：

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

总结

在本文中，我们介绍了什么是 Schema Stitching 及其优势。我们还讨论了如何实现 Schema Stitching，包括模式通信、解析器和按需解析。最后，我们演示了一个使用 Schema Stitching 的示例代码。

如果你正在使用 GraphQL 构建 API，那么 Schema Stitching 是一个非常有用的工具，可以帮助你更好地管理你的 schema，并支持微服务架构。

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

阅读全文

猜你喜欢

  • 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 个月前

相关推荐