如何使用 Apollo Client 在 React 中集成 GraphQL

阅读时长 8 分钟读完

GraphQL 是一种新兴的 API 查询语言,它可以帮助开发者更快捷地构建应用程序的后端。目前,GraphQL 越来越受欢迎,越来越多的开发者也开始学习并使用它。

在前端领域中,使用 GraphQL 的最大好处就是提高应用程序性能,由于只返回需要的数据,因此可以减少不必要的数据传输,从而节省带宽和提高加载速度。与此同时,我们也可以使用像 Apollo Client 这样的库来帮助我们更加快捷地集成 GraphQL 到我们的 React 应用程序中。

在本文中,我们将会探索如何使用 Apollo Client 在 React 中集成 GraphQL API。我们会很详细地讲解每一个步骤并提供示例代码。

安装必要的库

在开始使用 Apollo Client 之前,我们需要安装必要的库。这里,我们将使用 React、Apollo Client、GraphQL 和 graphql-tag 库,这些库可以使用 npm 包管理器进行安装:

安装完成后,我们就可以开始使用 Apollo Client 了!

创建 Apollo Client 实例

在将 GraphQL 集成到 React 应用程序中之前,我们需要先创建一个 Apollo Client 实例。这个实例可以被应用程序的不同组件共享,这样我们可以更加方便地访问数据。

在创建实例之前,我们需要导入 ApolloClient 和 InMemoryCache 对象:

接下来,我们可以创建一个简单的 Apollo Client 实例了:

在这里,我们需要指定远程 GraphQL 服务器的 URI,这里使用的是 example.com 的 GraphQL API。另外,我们也需要新创建一个 InMemoryCache 对象,它负责缓存从远程服务器获取的数据。

在 React 中使用 Apollo Client

创建 Apollo Client 实例后,我们就可以在 React 应用程序中使用它了。我们需要使用 ApolloProvider 组件来将 client 对象传递给应用程序的所有组件。在使用 ApolloProvider 组件之前,我们需要导入它:

接下来,在 App.js 中,我们可以使用 ApolloProvider 组件来包装应用程序的根组件(比如 <app>)。在这里,我们将 Apollo Client 实例传递给 ApolloProvider 组件的 client 属性中:

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

现在,我们已经成功地将 Apollo Client 集成到了 React 应用程序中。

发送 GraphQL 查询

在将 Apollo Client 集成到 React 应用程序中后,我们可以开始发送 GraphQL 查询了。在这里,我们需要使用 @apollo/react-hooks 库中提供的 useQuery 钩子函数。这个钩子函数可以帮助我们更加方便地发送 GraphQL 查询,并将返回的数据存储在组件的本地状态中,从而方便我们进行渲染。

在使用 useQuery 之前,我们需要先导入 gql 函数和 useQuery 钩子函数:

接下来,我们可以使用 gql 函数来定义我们的 GraphQL 查询语句:

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

在这里,我们定义了一个名为 GET_USERS 的 GraphQL 查询,它将会返回用户列表。这个查询将会返回每一个用户的 ID、名称和电子邮件地址。

接下来,我们可以在 React 组件中使用 useQuery 钩子函数来发送这个查询,并将返回的数据存储在组件的本地状态中:

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

在这里,我们首先调用 useQuery(GET_USERS) 函数来发送 GraphQL 查询。这个函数将会返回一个包含 loading、error 和 data 属性的对象。

loading 表示当前是否正在加载数据,error 表示是否存在错误,而 data 则表示返回的数据。在这里,我们使用 data.users.map() 方法来遍历每一个用户,并渲染出他们的名称和电子邮件地址。

发送 GraphQL 变量

除了查询外,我们还可以使用 Apollo Client 来发送 GraphQL 变量。在这里,我们需要使用 useMutation 钩子函数。这个钩子函数可以帮助我们更加方便地发送 GraphQL 变量,并执行 GraphQL 突变操作。

在使用 useMutation 之前,我们需要导入 useMutation 钩子函数:

除此之外,我们还需要定义一个名为 ADD_USER 的 GraphQL 突变操作:

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

在这里,我们定义了一个名为 ADD_USER 的 GraphQL 突变操作,它需要两个参数:$name 和 $email。这两个参数都是字符串类型,其中 $name 是必填项,而 $email 则为可选项。

接下来,我们可以在 React 组件中使用 useMutation 钩子函数来发送这个突变操作:

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

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

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

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

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

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

在这里,我们调用 useMutation(ADD_USER) 函数来发送 GraphQL 突变操作。这个函数将会返回一个名为 addUser 的函数和一个名为 data 的对象。addUser 函数可以帮助我们发送突变操作,而 data 对象用于存储返回的数据。

接下来,在提交表单时,我们可以调用 addUser 函数并将用户输入的 $name 和 $email 传递给它。这个例子中我们直接将用户的输入值以变量的形式传递给 addUser。在真实场景中,防止应用程序遭受攻击,我们需要在 GraphQL Server 进行参数的校验,防止有SQL injection attack。在这里,我们也将清空输入框。

到这里,我们已经成功地使用 Apollo Client 在 React 中集成 GraphQL 了。

总结

在本文中,我们详细地讨论了如何使用 Apollo Client 在 React 中集成 GraphQL。我们探索了如何创建 Apollo Client 实例、在 React 中使用 Apollo Client、发送 GraphQL 查询和发送 GraphQL 变量。通过这些知识,我们可以很方便地使用 GraphQL 来优化我们的 React 应用程序。

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

纠错
反馈