使用 Apollo Server 构建 GraphQL 服务器

GraphQL 是一种用于 API 的查询语言，它通过定义类型和字段来描述 API 中允许查询和修改的数据。与 RESTful API 相比，GraphQL 具有更高的灵活性和可扩展性。Apollo Server 是一个流行的 GraphQL 服务器库，它支持多种数据源、插件和中间件。

在本文中，我们将介绍如何使用 Apollo Server 构建一个 GraphQL 服务器，并使用它来查询和修改数据。我们将从安装 Apollo Server 开始，然后定义 GraphQL Schema、实现查询和修改操作、使用中间件和插件、以及处理错误和异常。

安装 Apollo Server

安装 Apollo Server 可以使用 npm 或 yarn：

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

安装完成之后，我们可以创建一个最简单的 Apollo Server 实例：

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

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

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

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

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

这个例子定义了一个名为 hello 的查询，它返回一个字符串。我们可以使用 GraphiQL 工具来测试这个查询，GraphiQL 是一个 GraphQL 开发工具，它提供了查询编辑器、结构文档、变量输入等功能。

打开浏览器并访问 http://localhost:4000/graphql，可以看到 GraphiQL 页面。在编辑器中输入以下查询：

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

然后按下运行按钮，你会看到返回值为：

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

这个例子非常简单，但它演示了 Apollo Server 的基本用法。接下来，我们将介绍如何定义 GraphQL Schema、实现查询和修改操作，以及使用更多的功能。

定义 GraphQL Schema

GraphQL Schema 定义了 GraphQL API 的类型和字段，它是一个基于类型系统的协议。我们可以使用 GraphQL Schema Language 来定义 Schema。

例如，我们可以定义一个类型为 Book，包括 title 和 author 两个字段：

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

我们还可以定义一个类型为 Query，包括 books 和 book 两个查询：

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

其中，books 返回一个数组类型，每个元素是 Book 类型；book 接收 id 参数，返回一个 Book 类型。

我们可以把这些类型定义存储在一个字符串中，并传递给 Apollo Server 实例：

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

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

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

这个例子中的 resolvers 对象中定义了 Query 的实现，books 返回一个空数组，book 返回一个包含 id、title 和 author 字段的对象。

现在，我们可以测试这个 Schema，例如查询所有的书籍：

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

我们会得到一个空数组。

实现查询和修改操作

除了查询外，GraphQL 还支持修改操作。我们可以定义一个类型为 Mutation 的根节点，它包括多个可变操作。例如，我们可以定义一个 createBook 操作：

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

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

其中，createBook 接收一个 BookInput 类型的参数，并返回一个 Book 类型的结果。

我们可以在 resolvers 中定义 Mutation 的实现，例如使用一个数组来存储书籍：

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

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

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

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

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

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

这个例子中，books 数组保存书籍，createBook 实现通过将输入对象添加到数组中来创建新书籍。我们可以测试这个操作，例如创建一本新书：

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

这个操作会返回一个包含 id、title 和 author 字段的对象。

使用中间件和插件

Apollo Server 支持使用中间件和插件来扩展功能。中间件指的是在请求处理过程中执行的函数，例如身份验证、日志记录、缓存等。插件是 Apollo Server 的扩展，可以添加新的功能，例如支持数据源、文档生成、错误处理等。

我们可以使用 ApolloServer 的 applyMiddleware 和 applyPlugins 方法来添加中间件和插件。例如，我们可以添加 cors 中间件和 ApolloServerPluginSchemaReporting 插件：

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

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

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

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

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

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

这个例子中，我们使用 cors 中间件允许跨域请求，使用 ApolloServerPluginSchemaReporting 插件收集 GraphQL Schema 相关指标。

处理错误和异常

最后，我们需要处理错误和异常，以便客户端能够得到明确的错误信息。在 GraphQL 中，我们可以使用 GraphQLNonNull 类型来定义非空字段，并使用 GraphQLScalarType 类型来验证输入类型。

例如，我们可以修改上面的 BookInput 类型，强制 title 和 author 字段不能为 null：

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

这个修改之后，如果客户端不提供 title 或 author 字段，服务端就会返回一个错误，而不是返回一个值为 null 的字段。如果我们想定制错误信息，可以定义一个自定义的错误类型：

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

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

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

这个例子中，我们在 createBook 实现中检查 input 是否缺少 title 或 author 字段，如果是，则抛出一个带有错误信息和错误码的 ApolloError 错误。

总结

本文介绍了如何使用 Apollo Server 构建一个 GraphQL 服务器，并使用它来查询和修改数据。我们学习了如何定义 GraphQL Schema、实现查询和修改操作、使用中间件和插件、以及处理错误和异常。无论是构建 Web 应用、移动应用还是其他类型的应用，GraphQL 都是一个非常有用的 API 技术，特别是在数据模型复杂和需要多种数据源的情况下。如果你还没有尝试过 GraphQL，不妨试一试，相信它会让你的开发更加高效和愉悦。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/65b8e0e3add4f0e0ff170e1a

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐

    暂无文章