当前位置：首页 > news >正文

如何使用GraphQL和Apollo构建一个宝可梦应用

news 来源：原创 2024/9/21 11:28:15

宝可梦是一个由视频游戏、动画系列与电影、交换卡牌游戏以及其他相关媒体组成的日本媒体特许经营权。

在本文中，我们将使用一个宝可梦GraphQL API，该API提供有关不同宝可梦的数据。

我们将使用Apollo和GraphQL来处理数据获取，以及React来构建我们的前端应用程序。

如果您不了解这些技术，也不用担心，我将会在您阅读的过程中为您介绍基础知识。

（本文内容参考：java567.com）

先决条件

您的计算机上应该有以下内容以便跟着做：

Nodejs v18+
一个代码编辑器
一个网页浏览器

让我们创建我们的React应用程序。

React应用程序设置

要创建您的React应用程序，请转到您的终端，并使用命令提示符。打开您的命令提示符，并选择您喜欢创建React项目的位置。让我们选择桌面。

cd Desktop

上述命令将导航到您的桌面。

npm create vite@latest pokemon-app -- --template react

npm create vite@latest 将开始使用Vite构建一个新项目。但是，我们附加了我们项目的名称（pokemon-app）以及我们应用程序将使用的技术或框架（-- – template react）。

您可以设置另一个模板，如svelte、vanilla或vue，项目将使用该框架创建。在其官方网站上关于Vite的信息。

安装Vite之后，运行以下命令：

cd pokemon-app
npm install
npm run dev

我们将使用上述命令完成React设置。

运行第一个命令cd pokemon-app，以导航到pokeman-app文件夹。

运行code .来在您的代码编辑器中打开该文件夹。

在这里插入图片描述

如果弹出对话框要求信任文件的作者，请标记信任作者复选框。

打开您的代码编辑器终端。如果您在Windows上运行VSCode，则快捷键是`Ctrl + ``。

在终端中依次运行其他2个命令。

npm install
npm run dev

您的项目现在应该在浏览器中运行。

我们将使用GraphQL和Apollo来管理我们的数据获取。

如何使用GraphQL和Apollo

GraphQL是一种用于API的查询语言，也是用于使用现有数据执行查询的运行时。它允许您在应用程序中仅请求所需的数据，而不多余，从而使其非常高效和灵活。

Apollo是一个状态管理库，允许您使用GraphQL管理本地和远程数据。它可用于获取、缓存和修改应用程序数据，同时自动更新您的UI。

让我们安装您需要的包。

安装包

在您的终端中运行以下命令以安装Apollo客户端。

npm install @apollo/client

导航到您的main.jsx文件并导入以下内容：

import React from "react";
import ReactDOM from "react-dom/client";
import App from "./App.jsx";
import {ApolloProvider,ApolloClient,InMemoryCache,
} from "@apollo/client";
import "./index.css";

您已经导入了React和ReactDOM用于DOM操作。

ApolloClient负责管理您应用程序的数据获取和状态管理。它负责将GraphQL查询和变异发送到GraphQL服务器并缓存结果。

ApolloProvider将用于包装您的React应用程序，以向所有组件提供Apollo客户端实例，以便您的应用程序可以通过Apollo客户端访问获取的数据。

InMemoryCache是一个缓存实现，用于将GraphQL查询的结果存储在内存中，以便高效地访问和检索。

您还导入了index.css来为您的应用程序设置样式。

如何创建Apollo客户端

const client = new ApolloClient({uri: "https://graphql-pokemon2.vercel.app/",cache: new InMemoryCache(),
});

以上代码使用了一些配置创建了ApolloClient的新实例：

uri：这指定了您的GraphQL API端点的URL。这是您的Apollo客户端将发送GraphQL查询和变异的端点。
cache：这配置了Apollo客户端的缓存实现，以使用内存缓存访问数据并存储GraphQL查询的结果，减少了从服务器重新获取数据的需要。

现在您可以将您的组件与ApolloProvider一起包装：

ReactDOM.createRoot(document.getElementById("root")).render(<React.StrictMode><ApolloProvider client={client}><App /></ApolloProvider></React.StrictMode>
);

请注意，client属性也被传递以提供您的应用程序ApolloClient的配置。

转到您的App.jsx组件并输入以下内容：

import React from "react";
import { PokemonsContainer } from "./components/PokemonsContainer";export default function App() {return (<main><PokemonsContainer /></main>);
}

您导入了React和将要创建的PokemonsContainer。PokemonsContainer组件被包装在main标签中，并将在组件粘贴到DOM中时呈现。

让我们在位于components文件夹中的文件中创建PokemonsContainer组件。即：

📂 src/components/PokemonsContainer.jsx

Pokemons Container组件

import React from "react";
import { useQuery } from "@apollo/client";
import { Pokemon } from "../components/Pokemon";
import { GET_POKEMONS } from "../graphql/get-pokemons";

来自@apollo/client的useQuery用于在Apollo应用程序中执行查询。为此，调用useQuery()并将GraphQL查询字符串作为参数传递。当您的组件渲染时，useQuery返回一个包含loading、error和data属性的对象，您可以使用这些属性来呈现您的UI。

导入了Pokemon组件以渲染Pokemon的用户界面，这将很快构建。

也导入了GET_POKEMONS。这将包含一个GraphQL查询。

在导入了上述函数之后，继续构建您的页面。

export function PokemonsContainer() {const { loading, error, data } = useQuery(GET_POKEMONS, {variables: { first: 5 },});if (loading) return <p>Loading...</p>;if (error) return <p>Error: {error.message}</p>;const pokemons = data?.pokemons || [];return (<div className="container">{pokemons &&pokemons.map((pokemon) => (<Pokemon key={pokemon.id} pokemon={pokemon} />))}</div>);
}

如前所述，useQuery返回一个包含loading、error和data属性的对象。它们在此处被解构，因此您可以在页面中访问它们。

请注意，我们为useQuery挂钩提供了一个配置选项（variables）。第二个参数也传递了{ variables: { first: 5 } }。variables选项是一个对象，其中包含我们要传递给GraphQL查询的所有变量。在这种情况下，我们传递了一个对象{ first: 5 }来指定我们要获取前五个Pokemons。

如果查询仍在加载中，则返回

Loading…

以通知用户，如果有错误，则返回

Error: {error.message}

。

创建了pokemons常量以保存数据对象的Pokemons属性的值。如果data.pokemons不可用，则pokemons常量将是一个空数组。

返回一个具有container类名的div，该div检查pokemons是否可用，并将数组映射到Pokemon组件。

让我们创建Pokemon组件：

📂src/components/Pokemon.jsx

宝可梦组件

import React from "react";export function Pokemon({ pokemon }) {return (<div className="pokemon"><div className="pokemon__name"><p>{pokemon.name}</p></div><div className="pokemon__meta"><span>{pokemon.maxHP}</span><span>{pokemon.maxCP}</span></div><div className="pokemon__image"><img src={pokemon.image} alt={pokemon.name} /></div><div className="pokemon__attacks">{pokemon.attacks.special.slice(0, 3).map((attack) => (<span key={`${attack.name}-${attack.damage}`}>{attack.name}</span>))}</div></div>);
}

此处定义了宝可梦实例的结构，具有用于样式化的类名。将呈现名称、最大HP、最大CP、图像和攻击数组。

让我们创建GET_POKEMONS GraphQL查询。

📂src/graphql/get-pokemons

GraphQL 查询

import gql from "graphql-tag";export const GET_POKEMONS = gql`query pokemons($first: Int!) {pokemons(first: $first) {idnameimagemaxHPmaxCPattacks {special {namedamage}}}}
`;

您从graphql-tag导入了gql并创建了一个名为GET_POKEMONS的GraphQL查询。

将pokemons查询函数包装在字符串中，以便gql函数将它们解析为查询文档。

$first: Int! 表示您的查询期望一个名为first的变量，它是一个整数，! 符号表示该变量是必需的。

回想一下，我们在PokemonsContainer组件中创建了variables对象，在下面有这个对象。

 const { loading, error, data } = useQuery(GET_POKEMONS, {variables: { first: 5 },});

也声明了pokemons(first: $f i rs t) 。这里将$ first分配给了5（我们在上面的代码段中传入了9）。因此，数组将只包含5个对象。每个对象将包含id、name、image、maxHP、maxCP和攻击对象，该对象将包含特殊对象，其中包含name和damage。

GraphQL服务器可能包含更多属性，但只会返回上述列出的属性。这是GraphQL的一个很酷的功能——它只返回您请求的数据。

样式化我们的应用程序

您的index.css应该包含以下内容：

/* 重置
=========================================== */
html {-webkit-box-sizing: border-box;box-sizing: border-box;
}*,
*:before,
*:after {-webkit-box-sizing: inherit;box-sizing: inherit;
}body {margin: 20px 0;padding: 0 20px;line-height: 1;font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;color: #202020;background-color: #fbfbfb;font-smooth: always;-webkit-font-smoothing: antialiased;-moz-osx-font-smoothing: grayscale;
}/* 宝可梦应用程序
=========================================== */
.container {display: flex;max-width: 80%;margin: auto;height: 100vh;justify-content: space-between;align-items: center;gap: 10px;
}.container p {margin: 0;
}.container .pokemon {width: 20%;background-color: #fff;background-clip: border-box;border: 1px solid rgba(0, 0, 0, 0.125);border-radius: 0.25rem;box-shadow: 0 0.125rem 0.25rem rgba(0, 0, 0, 0.075);overflow: hidden;/* margin: 5px; */
}.container .pokemon__name {background-color: #ecd018;text-align: center;padding: 10px;
}.container .pokemon__name p {text-transform: uppercase;font-weight: bold;color: white;letter-spacing: 4px;text-shadow: 0px 1px 2px rgba(0, 0, 0, 0.4);
}.container .pokemon__image {padding: 20px;min-height: 300px;display: flex;align-items: center;justify-content: center;
}.container .pokemon__image img {max-width: 100%;height: auto;
}.container .pokemon__attacks {display: flex;padding-left: 10px;padding-right: 10px;justify-content: space-between;
}.container .pokemon__attacks span {width: 32%;background-color: #f16820;border-radius: 3px;padding: 7px;font-weight: 700;color: #fff;padding-left: 10px;padding-right: 10px;font-size: 12px;margin-bottom: 10px;word-wrap: break-word;text-align: center;line-height: 15px;
}.container .pokemon__meta {display: flex;justify-content: space-between;margin-top: 10px;padding: 0 10px;
}.container .pokemon__meta span {color: white;text-shadow: 0px 1px 2px rgba(0, 0, 0, 0.4);background-color: #7bb7b7;font-weight: bold;margin: 0;padding: 5px 20px;border-radius: 5px;
}