GraphQL 中的订阅操作指南

GraphQL 是一个先进的 API 查询语言和运行时,它可以让开发者按需获取并组合他们需要的数据。GraphQL 的优势在于可以大大减少数据传输的冗余,提升 API 的性能和用户体验。但是传统的 GraphQL API 只能查询,不能订阅。为了解决这个痛点,GraphQL 新增了订阅操作,让开发者可以订阅数据的变化,实时获取最新的数据。

1. 订阅操作简介

GraphQL 的订阅操作是一种非常新颖的操作,它允许开发者可以订阅一个数据源的变化,并且在数据源发生变化时,能够及时地推送数据到客户端。这种操作非常适合于实时数据的场景,如实时聊天、在线协作等。

GraphQL 订阅操作的语法如下:

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

上述语法中,subscription 关键字指定了这是一个订阅操作。subscriptionName 是订阅的名称,可以带上参数。field1field2 是订阅的字段。

2. 如何实现订阅操作?

GraphQL 的订阅操作可以通过一些库或框架来实现。本文将以 Apollo Server 为例来演示如何实现 GraphQL 的订阅操作。

2.1 安装 Apollo Server

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

2.2 创建 Apollo Server

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

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

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

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

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

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

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

以上代码中定义了一个 Query 类型,其中包含一个 hello 字段,它的值为字符串 "Hello World"。同时定义了一个 Subscription 类型,其中包含一个 message 字段,它可以被订阅。

resolvers 中实现了 hello 字段的解析方法,它会返回一个字符串。在 resolvers 中还实现了 message 字段的 subscribe 方法,该方法会返回一个可观察对象。

2.3 实现订阅逻辑

Subscription 类型中定义的 message 字段,需要有一个 subscribe 函数来处理订阅逻辑。该函数需要返回一个可观察对象,用于推送数据。

在 Apollo Server 中,我们可以使用 PubSub 类来实现订阅逻辑。PubSub 是一个发布订阅模式的实现类,它能够和 GraphQL 的订阅操作很好地集成在一起。

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

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

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

上面代码中,在 GraphQL Schema 中定义了一个 Mutation 类型,并实现了一个 postMessage 字段。当 postMessage 字段被调用时,它会调用 pubsub.publish 方法,该方法会发送一条消息给所有订阅了 NEW_MESSAGE 主题的客户端。

Subscription 类型中,我们使用 apollo-server 中提供的 asyncIterator 方法来返回一个可观察对象,该对象会监听 NEW_MESSAGE 主题的变化,一旦有新的消息到来,就会将消息推送给客户端。

2.4 订阅操作的实现及使用

我们使用 apollo-server 提供的工具 graphql-ws 来实现订阅操作的推送功能。

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

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

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

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

使用 SubscriptionServer.create 方法创建一个订阅服务,该服务将 GraphQL 的执行和订阅设置成 WebSocket 的方式。

在客户端中,我们可以使用 subscriptions-transport-ws 工具来实现订阅操作的传输。

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

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

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

以上代码实现了一个 message 字段的订阅操作,并输出了它的数据内容。客户端连接到 ws://localhost:4000/graphql 的 WebSocket 服务器,发送订阅请求,并通过 subscription.next(callback) 来接收数据。

3. 总结

从本文中我们了解到 GraphQL 的订阅操作是一种有效地提供实时数据的方法,使用 Apollo Server 和 PubSub 类我们可以很方便地实现订阅操作。如果你正在构建一个需要实时数据的应用,那么 GraphQL 的订阅操作是一个非常好的选择。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/653718087d4982a6ebf6db4d


猜你喜欢

  • ES6 中的项解构操作方法指南

    在 JavaScript 开发中,解构赋值是一个非常常用且便捷的操作,我们可以利用解构赋值从数组或者对象中快速提取所需的变量或属性并赋值给变量。 在 ES6 中,项解构(Destructuring)操...

    1 年前
  • Koa2 中使用 Redis 解决缓存问题

    在前端开发中,缓存是一个很重要的问题。缓存可以大大提高程序的运行速度,减轻服务器的负担,提高用户体验。在使用 Koa2 框架开发时,可以使用 Redis 来解决缓存问题。

    1 年前
  • 基于 Vue Cli 3 实现 PWA 开发的详细教程

    Progressive Web App (PWA) 是一种基于网页技术开发的应用程序,可以像本地应用程序一样提供快速流畅的用户体验。在移动设备上,PWA 可以像本地应用程序一样安装并在主屏幕上使用。

    1 年前
  • 如何在小程序中使用 LESS?

    如何在小程序中使用 LESS? LESS 是一种动态样式语言,它为 Web 开发人员提供了更加顺畅、高效的样式定义方式。大多数前端工程师都熟练掌握它,因为它具有许多特殊功能,提供了 CSS 语言之外的...

    1 年前
  • RESTful API 的错误码设计及常见错误解决方案

    在使用 RESTful API 进行应用程序开发的过程中,错误很难避免。好的错误码设计和错误处理方案可以显著提高应用程序的健壮性和用户体验。本文将介绍 RESTful API 的错误码设计原则,解释常...

    1 年前
  • MongoDB 大数据查询优化

    在大数据环境下,MongoDB 数据库的查询优化显得尤为重要。本文将介绍 MongoDB 大数据查询优化的几个方面,包括索引、查询语句优化以及数据模型设计。 索引 MongoDB 索引是用于加速查询操...

    1 年前
  • 如何写出高效的 Deno 应用程序?

    Deno 是一个新兴的运行时环境,它由 Node.js 的创始人 Ryan Dahl 开发,并且在许多方面都与 Node.js 很相似。Deno 还提供了一些先进的功能,如内置的 TypeScript...

    1 年前
  • Cypress 测试如何模拟网络不稳定情况

    前言 Cypress 是一个流行的自动化测试工具,可以轻松地对 Web 应用程序进行端到端(E2E)测试。在测试过程中,模拟真实场景非常重要。这包括模拟网络不稳定情况,例如网络延迟、网络断开等。

    1 年前
  • 在使用 Enzyme 的 shallow 渲染时,如何将事件传递给子组件?

    在使用Enzyme的shallow渲染时,有时候我们需要模拟事件的触发,特别是当我们想测试一个组件的行为时,这时候就需要一种方法把事件传递给子组件。在这篇文章中,我将介绍如何在进行shallow渲染时...

    1 年前
  • RxJS 中的 Error Handling 小贴士

    引言 RxJS(Reactive Extensions for JavaScript)是一种全新的异步编程方式,它通过一系列的操作符来简化异步操作,从而让我们更容易地编写自己所需的代码。

    1 年前
  • Redis 中 key 过期的设置及解决方案

    在使用 Redis 时,经常需要对数据进行过期处理,以释放服务器内存空间和避免数据的过时使用。Redis 通过设置过期时间,自动删除过期的数据,方便高效的处理过期数据。

    1 年前
  • TypeScript 中的类型操作符

    TypeScript 是一种静态类型检查的 JavaScript 变体,提供了强大的类型系统来帮助开发者编写更加健壮、可维护的代码。在 TypeScript 中,类型操作符是一种非常重要的工具,它们可...

    1 年前
  • 如何在 SASS 中使用占位选择器

    如何在 SASS 中使用占位选择器 占位选择器是 SASS 中一个非常方便的工具,它能够帮助我们更好地组织 CSS 代码。本文将详细介绍 SASS 中占位选择器的用法,并给出一些实用示例代码。

    1 年前
  • Serverless 框架中的 API Gateway 参数传递说明

    随着 Serverless 时代的到来,越来越多的开发者转向使用无服务器架构来构建自己的应用程序。而在使用 Serverless 架构时,API Gateway 是我们经常使用的一种服务。

    1 年前
  • 如何使用 Redux Hook 简化状态管理

    在前端开发中,状态管理是一项非常重要的工作。Redux 是一个非常好用的状态管理工具,但是在使用它时,每次都需要编写大量的模板代码,这给开发带来了很大的困扰。为了解决这个问题,Redux 推出了一个新...

    1 年前
  • 如何使用 Promise 实现数据的深度合并和去重?

    Promise 是 JavaScript 中一种常用的异步编程解决方案,它可以帮助我们优雅地处理异步代码。在前端开发中,我们经常需要对数据进行操作,而数据的操作通常会涉及到数据的深度合并和去重。

    1 年前
  • 利用 Docker Compose 部署 Elasticsearch+Logstash+Kibana

    前言 Elasticsearch+Logstash+Kibana(ELK) 组合已经成为了处理大规模数据的热门方案之一,但是搭建 ELK 环境时存在很多挑战: 安装、配置、调优难度大,需要大量专业...

    1 年前
  • 如何在 Chai 和 SuperTest 中处理多线程和并发请求的问题

    前言 在进行前后端分离的开发过程中,前端经常需要使用到一些测试框架,如 Chai 和 SuperTest。这两个框架在单线程的情况下可以很好的处理测试数据和请求,但在多线程和并发请求的情况下,可能会出...

    1 年前
  • 如何用 ES9 展开运算符将数组转化为参数

    在前端开发中,我们经常需要将一个数组作为函数的参数传递,但是数组和函数的参数列表之间貌似缺了点什么。使用 ES9 中的展开运算符可以很好地解决这个问题,它可以将一个数组转换为参数列表,使得代码更加简洁...

    1 年前
  • 如何在 ES11 中优雅地使用可选链操作符

    在前端开发中,我们经常需要对对象的属性或方法进行访问,然而,在对象链较长的情况下,如果没有对对象的存在性进行判断,就会出现无法读取其属性或方法的情况,导致代码出现错误。

    1 年前

相关推荐

    暂无文章