在现代 web 开发中，API 扮演着至关重要的角色，而 GraphQL 和 Apollo Server 能够帮助我们快速构建高度可扩展、可定制、可维护的 API。在本文中，我们将详细介绍如何使用 Apollo Server 和 GraphQL 创建可扩展的 API，并提供有深度的学习和指导意义。
GraphQL 简介
GraphQL 是一种查询语言，用于编写 API 查询和操作的语言。相较于传统的 RESTful API，GraphQL 允许客户端指定返回的数据字段、关联数据和数据结构，从而提供更加灵活和精细的数据获取能力。由于 GraphQL 与前端和后端的解耦，因此具有很高的可扩展性和灵活性。
GraphQL 由 Facebook 开发并开源，目前已成为一个独立的标准并得到广泛应用。在使用 GraphQL 前，你需要了解 GraphQL 的相关知识：
- GraphQL 查询语言：包括查询、变量、输入类型、查询别名、操作名称等。
- GraphQL Schema：GraphQL Schema 描述了服务器的可查询类型、可变更类型、查询和变更的输入参数等信息。
- GraphQL 操作：GraphQL 操作包括查询、变更、订阅等。
Apollo Server 简介
Apollo Server 是一个用于构建 GraphQL API 的开源库。它提供了可扩展、高度定制和易于使用的 API 服务框架，可以与 Node.js、Express、Koa、Lambda 等常见 Node.js 框架无缝集成。
使用 Apollo Server 构建 GraphQL API，需要进行以下步骤：
- 定义 GraphQL Schema。
- 实现 Schema 中的 Resolver 函数。
- 构建 Apollo Server 并将 Schema 和 Resolver 函数传入。
以下是一个使用 Apollo Server 构建最简单的 Hello World GraphQL API 的示例代码：
-- -------------------- ---- -------
----- - ------------- --- - - -------------------------
----- -------- - ----
---- ----- -
------ ------
-
--
----- --------- - -
------ -
------ -- -- ------ --------
--
--
----- ------ - --- -------------- --------- --------- ---
----------------------- --- -- -- -
--------------- ------ ----- -- ---------
---如何创建可扩展的 GraphQL API
- 定义清晰的 GraphQL Schema
创建一个清晰的 GraphQL Schema 是创建可扩展的 GraphQL API 的关键。一个好的 Schema 应该是精细、清晰、易于维护的，要考虑数据模型和业务逻辑，包括可查询类型、可变更类型、输入类型、枚举类型、联合类型等。Schema 中应该准确定义类型之间的关系和字段之间的关系，并尽可能地避免查询或变更的冗余或不必要的复杂性。
以下是一个清晰的 Schema 的示例代码：
-- -------------------- ---- -------
----- -------- - ----
------ ----
---- -------------- -
---
----
-
---- ---- -
--- ---
----- -------
------ -------
---------- -----
---------- -----
-
---- ---- -
--- ---
------ -------
-------- -------
------- -----
---------- -----
---------- -----
-
---- ----- -
------ --------
-------- ----- -----
--------------- ---- -------- -------- --------------- ---------------- ------ ----- ------- ------ --------
-------- --------- -----
-
----- --------- -
----- -------
------ -------
-
----- --------- -
------ -------
-------- -------
--------- ---
-
---- -------- -
----------------- ------------ -----
-------------- ---- ------ ------------ -----
-------------- ----- ---
----------------- ------------ -----
-------------- ---- ------ ------------ -----
-------------- ----- ---
-
--- 优化数据查询
GraphQL 具有非常强大的查询能力，然而不得不承认的是，一个错误的查询可以对服务器性能造成很大的影响。优化数据查询的目的是提高查询效率和扩展性，减少资源占用。
以下是一些优化数据查询的建议：
- 只请求需要的数据：使用 GraphQL 的查询别名和查询的作用域进行精细控制，只获取客户端请求的数据字段。
- 合并查询：使用 GraphQL 的 alias 和 fragment 可以方便地合并多个查询，从而减少请求数量。
- 使用 DataLoader：DataLoader 是一个数据缓存和批处理工具，可以有效地减少重复查询和数据越权查询的问题。
- 实现 GraphQL Resolver
GraphQL Resolver 是一个非常关键的组件，它用于处理前端发起的 GraphQL 请求。有了业务逻辑和数据操作，我们就可以写出适当的 Resolver 函数，这将使代码逻辑更加清晰明了，并提高代码的可维护性。
以下是 Resolver 函数的示例代码：
-- -------------------- ---- -------
----- --------- - -
------ -
------ ----- ------ ----- -------- -- -
----- ----- - ----- -------------------------
------ ------
--
----- ----- ------ - -- -- -------- -- -
----- ---- - ----- -----------------------------
------ -----
--
------ ----- ------ - --------- -------- --------------- ------ ------ -- -------- -- -
----- ----- - ----- ---------------------- -------- -- ----- -
----- - ---------- -------------- --- ----- - - - -- --
------
----- -------
---
------ ------
--
----- ----- ------ - -- -- -------- -- -
----- ---- - ----- ------------------------------------------------
------ -----
--
--
--------- -
----------- ----- ------ - ----- -- -------- -- -
----- ---- - ----- ------------------------------
------ -----
--
----------- ----- ------ - --- ----- -- -------- -- -
----- ---- - ----- ------------------------------------- ------ - ---- ---- ---
------ -----
--
----------- ----- ------ - -- -- -------- -- -
----- --------------------------------------
------ ---
--
----------- ----- ------ - ----- -- -------- -- -
----- ---- - ----- ------------------------------
------ -----
--
----------- ----- ------ - --- ----- -- -------- -- -
----- ---- - ----- ------------------------------------- ------ - ---- ---- ---
------ -----
--
----------- ----- ------ - -- -- -------- -- -
----- --------------------------------------
------ ---
--
--
--- 使用 DataLoader 进行查询优化
为了避免过多的查询，我们可以使用 DataLoader 来缓存已查询的数据。DataLoader 是一个 JavaScript 库，用于对加载和查询多个数据源的数据进行缓存和批处理。对于复杂的查询场景，它可以显著提高查询效率，并降低服务器负载。使用 DataLoader，需要先安装并导入该库进入项目。
以下是一个使用 DataLoader 进行数据查询的示例代码：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- ---------- - --- ---------------- ----- -- -
----- ----- - ----- ---------------------- ---- - ---- --- - ---
------ ------------ --
----------------- -- ------------------ --- --------------
--
---
----- ---------- - --- ---------------- ----- -- -
----- ----- - ----- ---------------------- ---- - ---- --- - ------------
--------
--
------ ------------ --
----------------- -- ------------------ --- --------------
--
---
----- --------- - -
------ -
----- ----- ------ - -- -- -------- -- -
----- ---- - ----- --------------------
------ -----
--
----- ----- ------ - -- -- -------- -- -
----- ---- - ----- --------------------
------ -----
--
--
----- -
------- ----- ------ ----- -------- -- -
----- ---- - ----- ------------------------------------------
------ -----
--
--
--- 添加分页和过滤器
分页和过滤器是大多数查询 API 中必须要处理的问题。我们可以通过 GraphQL 中的参数来支持分页和过滤器。通常，我们会使用 limit 和 offset 实现分页，使用 where 子句中的 $in、$nin、$ne、$lt、$lte、$gt 和 $gte 操作符实现过滤器。
以下是一个具有分页和过滤器支持的 GraphQL API 示例代码：
-- -------------------- ---- -------
----- --------- - -
------ -
------ ----- ------ - ----- - --- ------ - -- ------ - -- -- -------- -- -
----- ----- - ----- ---------------------------- ----- -
----- - ---------- -- --
----- -------
------
---
------ ------
--
------ ----- ------ - ----- - --- ------ - -- ------ - -- -- -------- -- -
----- ----- - ----- ---------------------------- ----- -
----- - ---------- -- --
----- -------
------
----------------------
------ ------
--
--
--- 添加 GraphQL Subscriptions
与传统的 RESTful API 不同的是，GraphQL 支持实时数据订阅和推送，这是一个新颖的功能。GraphQL Subscriptions 可以使客户端在不刷新页面的情况下实时接收服务器端的数据更新。对于实时通信和协作应用非常有用。
以下是一个支持 GraphQL Subscriptions 的 GraphQL API 示例代码：
-- -------------------- ---- -------
-- ------- ------ --
----- -------- - ----
---- ------------ -
-------- -----
-
--
-- -------- --
----- --------- - -
------------- -
-------- -
---------- ------ ----- - ------ -- -- -
------ --------------------------------------
--
--
--
--
-- ------ --
----- ------ - --- ---------
----- ---------------- - -------------------
----------------- -- -- -
----- ---- - ----- ------------------------
------ ---- ------
-------- ----- -- - --- ------
--------- ----- ---- ----
---
-------------------------------- - -------- ---- ---
-- ------总结
在本文中，我们探讨了如何使用 Apollo Server 和 GraphQL 创建可扩展的 API，并提供了详细的示例代码。我们强调了定义清晰的 GraphQL Schema、优化数据查询、实现 GraphQL Resolver、使用 DataLoader 进行查询优化、添加分页和过滤器和添加 GraphQL Subscriptions 等关键步骤。在现代 web 开发中，GraphQL 和 Apollo Server 已成为创建高度定制、可扩展、灵活且易于维护的 API 的优秀选择。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6653b12bd3423812e4822ef5