在 React 中为 graphQL 请求设置 Apollo 客户端

介绍

本文将演示如何使用 ApolloClient 库为 graphQL 请求设置 React 应用程序。目标是展示如何配置应用程序并提供如何发出请求的示例。

库

• @apollo/client：启用状态管理并发出 graphQL 请求的库
• graphql：允许解析 GraphQL 查询的库

将库添加到项目中：

yarn add @apollo/client graphql --dev

配置

下面，我将展示如何配置 ApolloClient 来启用 graphQL 请求。
首先，将创建一个 ApolloClient 上下文，以便其子级包含的所有内容都可以发出 graphQL 请求：

import {
  ApolloClient,
  ApolloProvider,
  HttpLink,
  InMemoryCache
} from '@apollo/client'

function ExampleApolloProvider({ children, token, uri }) {
  const httpLink = new HttpLink({
    uri: uri,
    headers: {
      authorization: `Bearer ${token}`,
    },
  })

  const client = new ApolloClient({
    cache: new InMemoryCache(),
    link: httpLink,
  })

  return <ApolloProvider client={client}>{children}</ApolloProvider>
}

export { ExampleApolloProvider as ApolloProvider }

在 const 客户端中，ApolloClient 被初始化，通过定义的链接指定端点，并使用 InMemoryCache 实例指定缓存，ApolloClient 使用 InMemoryCache 来缓存查询结果。
在 httpLink 中，设置了 graphQL api 的 uri，以及请求所需的标头。在此示例中，使用了 Bearer 令牌。
最后，定义返回和导出以允许其在应用程序内使用。

考虑到这是一个登录后将令牌保存在 localStorage 中的应用程序，并且目标是在整个应用程序中启用 graphQL 请求，因此使用上一个文件中定义的 ApolloProvider：

import { ApolloProvider } from './contexts/ApolloContext'
import AppContent from './components/AppContent'

const token = localStorage.getItem('@tokenId')
// endpoint of your graphQL api
const graphqlURI = 'https://www.example.com'

const App = () => {
  return (
    <ApolloProvider token={token} uri={graphqlURI}>
      <AppContent />
    </ApolloProvider>
  )
}

在此示例中，从 localStorage 检索令牌（在本例中，就好像它是使用键 @tokenId 保存的），并且 uri 在同一文件中定义，然后传递给 ApolloProvider。 AppContent 作为 ApolloProvider 的子级传递，这意味着其中包含的所有内容（整个应用程序）将能够发出 graphQL 请求。
实际上，当测试和生产环境不同时，graphqlURI 可以来自环境变量，并相应地定义每个环境的 uri。

从 api 公开的名为 user 的查询开始，该查询返回用户的姓名和职业，将使用要调用的查询定义一个文件：

import { gql } from '@apollo/client'

const GET_USER = gql`
  query GetUser {
    user {
      name
      occupation
    }
  }
`

export default GET_USER

GET_USER 对应于 React 应用程序中如何调用查询，user 是要从 api 使用的查询的名称。

在定义AppContent的文件中，将调用GET_USER查询并使用其返回：

import {
  ApolloClient,
  ApolloProvider,
  HttpLink,
  InMemoryCache
} from '@apollo/client'

function ExampleApolloProvider({ children, token, uri }) {
  const httpLink = new HttpLink({
    uri: uri,
    headers: {
      authorization: `Bearer ${token}`,
    },
  })

  const client = new ApolloClient({
    cache: new InMemoryCache(),
    link: httpLink,
  })

  return <ApolloProvider client={client}>{children}</ApolloProvider>
}

export { ExampleApolloProvider as ApolloProvider }

useQuery 钩子将执行 GET_USER 中定义的查询，在请求仍在进行时返回 load true，如果请求失败则返回错误，并在请求成功完成时返回数据。在数据返回之前，屏幕上会显示“正在加载...”消息。如果请求以错误结束，则会显示消息“请求失败”。如果请求成功，屏幕上会显示用户的姓名和职业（name and jobs）。
这样，ApolloClient 就已针对 graphQL 请求进行了配置并可供使用。

结论

这个想法是演示如何配置 ApolloClient 以允许 React 应用程序进行 graphQL 调用，显示上下文的定义、此上下文的用法以及如何执行查询的示例。
这是 ApolloClient 文档的链接，供想要深入了解的人使用。

以上是在 React 中为 graphQL 请求设置 Apollo 客户端的详细内容。更多信息请关注PHP中文网其他相关文章！