GraphQL 如何实现由前端控制后端返回字段?

GraphQL 是一种新兴的查询语言,它允许前端应用程序通过发送查询来准确地获取所需的数据。与传统的 REST API 相比,GraphQL 允许前端控制后端返回的字段,帮助你优化数据传输,减少无用的数据返回。

本文将介绍如何使用 GraphQL 实现由前端控制后端返回字段,包括以下内容:

  • GraphQL 基础概念
  • GraphQL 核心功能
  • GraphQL 如何由前端控制后端返回字段

GraphQL 基础概念

GraphQL 是一种新兴的 API 查询语言,它最初在 Facebook 上开发并于 2015 年开源。GraphQL 具有以下几个特点:

  • 它是一种强类型语言,可以定义 API 中支持的查询和变更类型。
  • 它允许客户端向服务器发送查询,服务器返回与查询匹配的精确数据。
  • GraphQL 允许控制查询的响应数据,以便返回最小数据集。

GraphQL 核心功能

GraphQL 有三个核心的功能:

  • 查询
  • 变更
  • 订阅

查询用于从服务器检索数据,变更用于向服务器发送数据,订阅用于为服务器事件注册事件处理程序。

GraphQL 查询语言

GraphQL 查询语言用于客户端向服务器发送查询,格式如下:

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

查询由一个或多个字段组成,每个字段表示对象的属性或关系。可以使用参数和变量来动态设置查询。

GraphQL 变更语言

GraphQL 变更语言用于向服务器发送数据更新请求,格式如下:

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

变更由一个或多个操作组成,每个操作表示需要更新的数据项。与查询类似,变更也可以使用参数和变量来动态设置数据更新。

GraphQL 订阅语言

GraphQL 订阅语言用于订阅服务器事件,格式如下:

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

订阅由一个或多个事件组成,每个事件表示一个需要跟踪的服务器事件。当事件触发时,GraphQL 将向客户端发送更新。

GraphQL 如何由前端控制后端返回字段

GraphQL 允许前端控制后端返回的字段,主要通过 GraphQL 中的查询语言进行实现。以下是如何使用 GraphQL 实现由前端控制后端返回字段的步骤:

步骤 1:定义 GraphQL 模式

为了让 GraphQL 理解 API,我们需要定义 GraphQL 模式。GraphQL 模式是一个描述类型和字段的对象。以下是一个例子:

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

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

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

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

此模式定义了一个查询类型 Query,该类型包含一个名为 book 的字段,其参数为 id,返回类型为 Book

步骤 2:实现 Resolver 函数

Resolver 函数用于确定查询字段的返回值。Resolver 函数接受输入参数并使用该参数解析查询,最终将结果作为输出返回。

以下是一个书的解析器函数示例:

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

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

此解析器函数接受 id 作为参数并查询“books”数组以查找匹配的书,最终返回该书的详细信息。

步骤 3:使用前端控制查询返回的字段

GraphQL 允许前端通过 query 中指定的字段来控制后端返回数据的字段。例如,Query对象定义了Book类型,该类型具有一个包含“作者”详细信息的字段。如果我们想只返回作者的姓名,则可以指定需要的字段。

以下是前端控制后端返回字段的示例代码:

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

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

在查询中,我们指定了需要返回的字段 authorname 属性。这使查询更加精细,从而消除了不必要的数据。

结论

GraphQL 为前端与后端之间的数据传输提供了更多的精确度和控制,使前端可以精确控制后端返回的数据字段。在实现 GraphQL 查询时,我们需要定义 GraphQL 模式并实现 Resolver 函数,然后在查询中指定我们需要返回的字段。使用 GraphQL 可以帮助你增强 Web 应用程序的响应性能,提升交互体验和效率。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/671354f9ad1e889fe20c2884