GraphQL:构建开发者友好型 API 的教程

概述

GraphQL 是一种由 Facebook 开发的数据查询语言和运行时,旨在为 API 定义并提供了更好的方式,以取代传统的 REST API。GraphQL 允许客户端定义自己所需要的数据模型,而不是由服务端决定。它还提供了更高效的数据查询方式,减少了网络传输和响应时间。

GraphQL 适用于不同的开发场景,包括 Web 和移动应用、IoT 和即时通讯。无论您是构建一个全新的应用程序还是改进您的现有应用程序的数据查询和选择性能,GraphQL 都是值得考虑的技术。

在本教程中,我们将深入研究如何使用 GraphQL 构建前端开发者友好型的 API。我们将介绍如何定义模式、执行查询、进行数据分析和优化性能等方面。

安装

在开始之前,您需要在本地安装 GraphQL,您可以使用 npm 或 yarn 安装它:

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

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

定义模式

GraphQL 的 API 在开始使用之前需要先定义模式。模式是通过使用 GraphQL 的类型系统来定义的。类型系统有两个主要的构建块:对象类型和字段。

对象类型表示您的 API 中的实体,例如用户、文章、评论等。每个对象类型都有一组字段,它们代表对象的属性。字段可以是另一个对象类型,例如文章可以有评论。

下面是如何定义一个用户对象类型:

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

这定义了 User 对象类型和它可用的字段(id、name、email 和 posts)。注意,每个字段后面有一个感叹号,这表示该字段是必需的。

另一个对象类型,Post:

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

这个对象类型有一个作者字段,它引用了一个 User 对象,以及一个评论字段,它包含了一个或多个 Comment 对象。

您也可以定义标量类型,例如在上面的例子中,ID、String 是标量类型,它们是 GraphQL 默认提供的。但是,您还可以定义您自己的标量类型:

------ ----

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

上述代码定义了一个名为 Date 的标量类型,并在事件对象中使用它。

执行查询

一旦您定义了您的模式,您就可以使用 GraphQL 查询来获取您需要的数据。与 REST 不同的是,GraphQL 允许客户端定义自己所需要的字段和数据模型,而不是服务端决定。

对于上述示例,下面是如何执行一次查询:

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

在这个查询中,我们请求一个 User 对象,其中我们只需要返回 name、email 和 posts 字段。在 posts 字段中,我们请求 title、content 和一组评论。评论字段包含两个子字段,一个是作者的名称,另一个是评论的内容。

当您在客户端执行查询时,您需要使用 GraphQL 客户端库发送请求。如果您使用 React,则可以使用 Apollo 客户端库,它提供了针对 React 的完整支持。

让我们看一个例子:

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

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

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

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

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

在这个示例中,我们使用了 useQuery 钩子来发送我们的查询,并将返回的数据呈现在页面上。

分析数据

GraphQL 为您提供了一些有用的工具来分析 API 的性能和数据使用情况。其中一个工具是 GraphQL Playground,它是一个可交互的查询控制台,可以让您轻松地探索 API 和在实时查询中尝试查询。

要将 GraphQL Playground 集成到您的应用程序中,在您的后端服务的节点端口下添加以下代码:

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

然后在 http://localhost:4000/graphql 上打开它。

优化性能

GraphQL 提供了更高效的数据查询方式,通过让客户端决定需要哪些数据和它们的形式,它可以减少网络传输和响应时间。除此之外,您还可以采用以下方法来优化性能:

  • 批处理:通过查询多个对象来减少查询次数,并批量处理它们的响应。

  • 数据缓存:存储最常查询的响应,以避免在多个查询之间发送相同的请求。

  • 分页:仅查询所需的页面数据并减少响应量。

  • 压缩:使用 Gzip 或其他压缩算法将响应压缩到更小的尺寸。

结论

GraphQL 是一个强大的工具,可以让您构建开发者友好型的 API。在本教程中,我们了解了如何定义模式、执行查询、进行数据分析和优化性能,以便更好地使用它。

在实践中,如果您想快速构建一个 GraphQL API,您可以使用现有的框架,例如 Apollo Server。它提供了完整的 GraphQL 集成和中间件解决方案。

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