如何在 React 中使用 Apollo Client 和 GraphQL

阅读时长 8 分钟读完

前言

在前端开发中,通常需要从后端获取数据。而在过去,我们往往使用 RESTful API 来获取数据。但是 RESTful API 的使用会导致一些问题,例如在获取相关资源时需要使用多个请求,同时需要对数据的组合和关联进行管理,从而增加了代码的复杂度。为了解决这个问题,GraphQL 应运而生。

GraphQL 是一种用于 API 的查询语言,它可以更好地管理复杂的数据请求,并为开发人员提供了更精确、更灵活的数据获取方法。而 Apollo Client 是一个完整的 GraphQL 解决方案,它可以用于管理和查询 GraphQL API,同时也支持多种框架和库,包括 React。

本文将介绍如何在 React 中使用 Apollo Client 和 GraphQL,帮助你更好地管理数据请求,提高开发效率。

安装

首先,我们需要安装 Apollo Client 和相关依赖。在终端中输入以下命令:

  • apollo-boost 是我们的 Apollo 客户端。
  • react-apollo 是 Apollo 的 React 封装版。
  • graphql 是 GraphQL 查询语言和类型系统的框架。

配置

在使用 Apollo Client 之前,我们需要进行一些配置。我们需要创建一个客户端,告诉它如何访问我们的 GraphQL API。

首先,在你的 React 应用程序的根目录中,创建一个名为 apollo.js(也可以是其他名字)的文件。在文件中,输入以下代码:

这里,我们创建了一个名为 client 的 Apollo 客户端,并指定了访问我们的 GraphQL API 的地址。

接下来,在你的应用程序的 index.js(或其他入口文件)中,引用 apollo.js

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

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

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

这里我们引用了 ApolloProvider 组件,并使用 client 作为参数,将整个应用程序包装在 ApolloProvider 中。这告诉 Apollo Client 在整个应用程序中使用该客户端。在这里,我们使用 ReactDOM.render 方法将应用程序渲染到 HTML 元素上。

查询

现在,我们已经设置好所需的配置,可以开始实际查询数据了。在这里,我们将查询一个待办事项列表。在 GraphQL 中,我们使用 query 标签来定义查询语句。

在你的组件中,输入以下代码:

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

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

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

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

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

我们首先导入了 Query 组件、gql 标签和我们的 GraphQL 查询。

在组件中,我们定义了名为 GET_TODOS 的 GraphQL 查询,并通过 Query 组件将其传递到 React 应用程序中。然后,我们渲染一个包含查询结果的列表。

需要注意的是,Query 组件接受一个函数作为子组件,并将查询结果作为该函数的参数传递。在这里,我们使用 loadingerror 属性来显示加载状态和错误信息。如果查询成功,我们将返回一个表示待办事项列表的 ul 元素,并将查询结果作为其中的 li 元素渲染出来。

变量

通常情况下,我们需要在查询语句中使用变量。变量可用于向查询语句传递参数。

在 GraphQL 中,我们使用 $ 符号来定义变量。例如:

在这里,我们定义了一个名为 $id 的整数变量,并将其传递给 user 查询。需要注意的是,我们在定义变量时需要指定其类型,以及使用 ! 符号表示该变量为非空变量。

在 React 应用程序中,我们可以使用 variables 属性来指定变量。例如:

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

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

在这里,我们将 variables 属性传递给 Query 组件,并将它的值设为包含变量 id 的对象。然后,在 GraphQL 查询中,我们可以使用 $id 变量来引用该变量。

修改数据

在 GraphQL 中,我们使用 mutation 标签来执行修改操作。在 React 应用程序中,我们可以使用 Mutation 组件来执行修改操作。

例如,我们可以使用 Mutation 组件来添加新的待办事项:

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

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

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

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

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

在代码中,我们首先定义了名为 ADD_TODO 的 GraphQL 变量,并通过 Mutation 组件将其传递到 React 应用程序中。然后,我们渲染一个包含表单的组件。

表单中的 onSubmit 方法将调用 addTodo 方法,并将文本输入框的值作为参数传递给该方法。addTodo 方法将发送一个包含变量 text 的 GraphQL 变量,并将返回结果作为 Mutation 组件的属性传递给表单。

接下来,我们使用 update 方法更新缓存中的数据。update 方法将被调用,以便检索待办事项列表,并将新增事项添加到该列表中。

结论

现在,你已经了解了如何在 React 中使用 Apollo Client 和 GraphQL。Apollo Client 是一个灵活、易于使用的 GraphQL 解决方案,可以帮助你更好地管理数据请求,提高开发效率。希望本文对你有所帮助。

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

纠错
反馈