GraphQL - Apollo 客户端


我们使用 Apollo Server 在服务器端构建 graphql 规范。构建生产就绪的 GraphQL 服务器既快速又简单。现在让我们了解客户端。

Apollo Client 是使用 GraphQL 构建客户端应用程序的最佳方式。该客户端旨在帮助开发人员快速构建一个使用 GraphQL 获取数据的 UI,并且可以与任何 JavaScript 前端一起使用。

Apollo 客户端支持以下平台 -

先生。 平台与框架
1

JavaScript

React、Angular、Vue、Meteor、Ember

2

Web组件

聚合物,lit-apollo

3

本地移动

原生 Android 与 Java,原生 iOS 与 Swift

缓存是 Apollo Client 的主要功能之一。apollo-boost 是一个方便的包,它引入了许多其他依赖项。

插图

让我们看看如何使用 Apollo Client 来构建客户端应用程序,步骤如下 -

设置服务器

我们必须按照以下步骤设置服务器 -

第 1 步 - 下载并安装项目所需的依赖项

创建文件夹 apollo-server-app。 从终端将目录更改为 apollo-server-app 。然后,按照环境设置一章中说明的步骤 3 到 5 进行操作。

第 2 步 - 创建架构

在项目文件夹 apollo-server-app中添加schema.graphql文件 并添加以下代码 -

type Query
{
   students:[Student]
}

type Student {
   id:ID!
   firstName:String
   lastName:String
   college:College
}

type College {
   id:ID!
   name:String
   location:String
   rating:Float
}

步骤 3 - 添加解析器

在项目文件夹中创建文件resolvers.js并添加以下代码 -

const db = require('./db')

const Query = {
   //resolver function for students returns list
   students:() => db.students.list(),
}

const Student = {
   college:(root) => {
      return db.colleges.get(root.collegeId);
   }
}
module.exports = {Query,Student}

第 4 步 - 运行应用程序

创建一个server.js文件。请参阅环境设置一章中的步骤 8。 在终端中执行命令 npm start 。服务器将在 9000 端口上启动并运行。在这里,我们将使用 GraphiQL 作为客户端来测试应用程序。

打开浏览器并输入 URL  http://localhost:9000/graphiql。在编辑器中键入以下查询。

{
   students{
      id
      firstName
      college{
         name
      }
   }
}

查询的响应如下 -

{
   "data": {
      "students": [
         {
            "id": "S1001",
            "firstName": "Mohtashim",
            "college": {
               "name": "CUSAT"
            }
         },
         
         {
            "id": "S1002",
            "firstName": "Kannan",
            "college": {
               "name": "AMU"
            }
         },
         
         {
            "id": "S1003",
            "firstName": "Kiran",
            "college": {
               "name": "AMU"
            }
         }
      ]
   }
}

设置客户端

为客户端打开一个新终端。在执行客户端应用程序之前,服务器终端应保持运行。React 应用程序将在端口号 3000 上运行,服务器应用程序将在端口号 9000 上运行。

第 1 步 - 创建一个 React 应用程序

在客户端中,输入以下命令 -

npx create-react-app hello-world-client

这将安装典型反应应用程序所需的一切。npx 实用程序和 create-react-app 工具创建一个名为hello-world-client 的项目。安装完成后,在VSCode中打开项目。

步骤 2 - 启动 hello-world-client

将终端中的当前文件夹路径更改为hello-world-client。输入 npm start 启动项目。这将在端口 3000 运行开发服务器,并自动打开浏览器并加载索引页面。

这显示在下面的屏幕截图中 -

创建 Rat 项目.jpg

步骤 3 - 安装 Apollo 客户端库

要安装 Apollo 客户端,请打开一个新终端并位于当前项目文件夹路径中。输入以下命令 -

npm install apollo-boost graphql

这将下载客户端的 graphql 库以及 Apollo Boost 包。我们可以通过在 apollo-boost 依赖项中输入 npm view 来交叉检查。这将有许多依赖项,如下所示 -

{
   'apollo-cache': '^1.1.15',
   'apollo-cache-inmemory': '^1.2.8',
   'apollo-client': '^2.4.0',
   'apollo-link': '^1.0.6',
   'apollo-link-error': '^1.0.3',
   'apollo-link-http': '^1.3.1',
   'apollo-link-state': '^0.4.0',
   'graphql-tag': '^2.4.2'
}

我们可以清楚地看到 Apollo-Client 库已安装。

步骤 4 - 修改 index.js 文件中的应用程序组件

有了 Apollo Client,我们可以直接调用服务器,而不需要使用 fetch API。此外,查询和突变不应嵌入使用反勾符号组成的字符串中。这是因为,gql函数直接解析查询。这意味着,程序员可以像在 GraphiQL 工具中编写查询一样直接编写查询。 gql 是一个标签函数,它将解析以反勾号表示法编写的模板字符串到 graphql 查询对象。Apollo 客户端查询方法返回一个承诺。

以下代码片段显示了如何导入 Apollo 客户端 -

import {ApolloClient, HttpLink, InMemoryCache} from 'apollo-boost'

const endPointUrl = 'http://localhost:9000/graphql'
const client = new ApolloClient({
   link: new HttpLink({uri:endPointUrl}),
   cache:new InMemoryCache()
});

在上一章中,我们讨论了如何使用 fetch API 来处理 HTTP 请求。以下代码展示了如何使用gql函数。loadStudentsAsync函数使用graphql客户端来查询服务器。

async function loadStudentsAsync() {
   const query = gql`
   {
      students{
         id
         firstName
         lastName
         college{
            name
         }
      }
   }`
   const {data} = await client.query({query}) ;
   return data.students;
}

只需要保留src文件夹中的index.js和public文件夹中的index.html即可;可以删除自动生成的所有其他文件。

目录结构如下 -

hello-world-client /
   -->node_modules
   -->public
         index.html
   -->src
         index.js
   -->package.json

以下是 React应用程序中的index.js  -

import React, {Component} from 'react';
import ReactDOM from 'react-dom';

// apollo client

import {ApolloClient, HttpLink, InMemoryCache} from 'apollo-boost'
import gql from 'graphql-tag'

const endPointUrl = 'http://localhost:9000/graphql'
const client = new ApolloClient({
   link: new HttpLink({uri:endPointUrl}),
   cache:new InMemoryCache()
});

async function loadStudentsAsync() {
   const query = gql`
   {
      students{
         id
         firstName
         lastName
         college{
            name
         }
      }
   }
   `
   const {data} = await client.query({query}) ;
   return data.students;
}
class  App  extends Component {
   constructor(props) {
      super(props);
      this.state = {
         students:[]
      }
      this.studentTemplate =  [];
   }
   async loadStudents() {
      const studentData =  await loadStudentsAsync();
      this.setState({
         students: studentData
      })
      console.log("loadStudents")
   }
   render() {
      return(
         <div>
            <input type = "button"  value = "loadStudents" onClick = {this.loadStudents.bind(this)}/>
            <div>
               <br/>
               <hr/>
               <table border = "3">
                  <thead>
                     <tr>
                        <td>First Name</td>
                        <td>Last Name</td>
                        <td>college Name</td>
                     </tr>
                  </thead>
                  
                  <tbody>
                     {
                        this.state.students.map(s => {
                           return (
                              <tr key = {s.id}>
                                 <td>
                                    {s.firstName}
                                 </td>
                                 <td>
                                    {s.lastName}
                                 </td>
                                 <td>
                                    {s.college.name}
                                 </td>
                              </tr>
                           )
                        })
                     }
                  </tbody>
               </table>
            </div>
         </div>
      )
   }
}
ReactDOM.render(<App/>, document.getElementById('root'));

一旦我们点击 loadStudents 按钮,React 应用程序将从 GraphQL 服务器加载学生,如下所示 -

浏览器输出 React 应用程序