Next.js 中使用 Apollo 客户端实现 GraphQL

阅读时长 9 分钟读完

GraphQL 是一门新兴的 API 查询语言,它具有灵活的数据查询方式、强大的类型检查以及自带文档,因此受到了很多开发者的青睐。而 Next.js 是一款流行的 React 服务端渲染框架,有众多开发者使用。在前端开发过程中,我们不可避免地会用到 GraphQL 和 Next.js,这时我们可以使用 Apollo 客户端为 Next.js 提供 GraphQL 查询的支持。

什么是 Apollo 客户端?

Apollo 客户端是一个用于 JavaScript 应用的 GraphQL 客户端。它可以被用在浏览器、Node.js 或者 React Native 等环境下,帮助我们发送 GraphQL 查询请求并将数据传递给 React 组件。

如何在 Next.js 中使用 Apollo 客户端?

要在 Next.js 中使用 Apollo 客户端,我们需要先安装以下依赖:

接着,我们需要创建一个 Apollo Client 实例并将其传递给 Next.js 应用程序的 Props。我们可以在 _app.js 文件中创建一个高阶组件来完成这个任务。具体实现方法如下:

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

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

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

这里我们创建了一个 Apollo Client 实例,并指定 GraphQL API 的地址。接着,将组件嵌套在 ApolloProvider 中并将 client 作为 props 传递给它,从而让该组件及其所有子组件都能够访问到 Apollo Client 实例。

如何使用 Apollo 客户端进行 GraphQL 查询?

在设置完 Apollo Client 实例后,我们就可以用它来进行 GraphQL 查询了。

首先,我们需要创建一个 GraphQL 查询并将其传递给 Apollo Client。这里我们可以使用 gql 函数来定义 GraphQL 查询,再通过 Apollo Client 发送查询请求。示例代码如下:

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

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

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

这里我们创建了一个名为 GET_BOOKS 的 GraphQL 查询,用于获取所有书籍的详情。接着我们定义了一个名为 Books 的函数组件,通过 Query 组件包装该组件,将 GET_BOOKS 查询传递给 query 属性,接着在返回的 JSX 代码中根据查询结果来呈现数据。在 loading 状态下,我们简单地返回字符串 "Loading...";在 error 状态下,我们将错误信息呈现出来;在正常状态下,我们将查询结果循环遍历,呈现出每本书籍的名称和作者。

如何处理 Apollo 客户端的缓存?

在 Next.js 应用程序中使用 Apollo 客户端时,缓存也是我们需要关注的一个问题。Apollo 客户端本身具有缓存功能,它会将通过查询请求获取到的数据储存在 Apollo Client 实例中。这意味着,每一次通过 GraphQL 查询获取到的数据都会被缓存下来,下一次请求同样的数据时就可以从 Apollo 客户端的缓存中读取,不需要再向服务器发出请求,从而提升了应用程序的性能。

在使用 Apollo Client 缓存时,我们需要在组件中使用 useQuery 钩子函数来定义查询,同时需要设置 fetchPolicy: "cache-and-network" 属性。这个属性的作用是将查询请求既发往服务端获取最新数据,又从缓存中获取将本地数据集成在一起返回,从而保证数据的最新和缓存的一致性。

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

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

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

在这个例子中,我们使用 useQuery 钩子来定义查询,将 GET_BOOKS 查询传递给该钩子函数。并且在钩子函数的第二个参数中,设置了 fetchPolicy: "cache-and-network" 属性,即 cache-and-network 策略。这个策略会在查询本身既会去服务器获取最新数据,也会尝试从缓存中获取数据,并将两者结合起来返回。这样就保证了应用程序总是能够获取到最新的数据,并且能够从缓存中获取已经存在的数据,降低了对服务器的请求次数。

总结

在本文中,我们学习了如何在 Next.js 中使用 Apollo 客户端实现 GraphQL。首先,我们介绍了 Apollo 客户端的概念以及其在 JavaScript 应用程序中的作用。接着,我们讲解了如何在 Next.js 应用程序中安装 Apollo 相关的包以及如何创建 Apollo Client 实例以及如何使用 Apollo 客户端进行 GraphQL 查询。最后,我们详细讨论了 Apollo 客户端缓存的处理方式,让开发者在日常开发中更加高效快捷。

附:完整示例代码如下(使用来自 GraphQL 官网 的数据)

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

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

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

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

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

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64ae59a048841e9894a5dd27

纠错
反馈