GraphQL 是一种用于 API 的查询语言，它提供了一种更高效、更强大的方式来获取和修改数据。与 REST API 不同，GraphQL 允许客户端指定需要的数据，从而减少了不必要的网络请求和数据传输，提高了应用程序的性能和响应速度。本文将介绍 Node.js 中实现 GraphQL API 的最佳实践。
1. 安装和配置 GraphQL
首先，需要安装和配置 GraphQL。可以使用 npm 安装 graphql 和 express-graphql 模块：
npm install graphql express-graphql
接下来，需要在 Node.js 应用程序中配置 GraphQL。可以使用以下代码创建一个 GraphQL 服务器：
-- -------------------- ---- -------
----- ------- - -------------------
----- ----------- - ---------------------------
----- - ----------- - - -------------------
----- ------ - -------------
---- ----- -
------ ------
-
---
----- ---- - -
------ -- -- ------ -------
--
----- --- - ----------
------------------- -------------
------- -------
---------- -----
--------- ----
----
---------------- -- -- -
-------------------- - ------- --- ------ -- --------------------------------
---在这个示例中，定义了一个 hello 查询和一个 root 对象来处理该查询。graphiql: true 选项启用了 GraphiQL 工具，它提供了一个交互式的 GraphQL IDE，可以帮助测试和调试 GraphQL API。
2. 定义 Schema 和 Resolver
GraphQL API 的核心是 Schema 和 Resolver。Schema 定义了可查询的字段和类型，Resolver 则负责实现这些字段的查询逻辑。以下是一个示例 Schema 和 Resolver：
-- -------------------- ---- -------
----- ------ - -------------
---- ----- -
-------- ----- ----
------ ------
-
---- ---- -
--- ---
----- -------
------ -------
-
---
----- ----- - -
- --- ---- ----- -------- ------ ------------------- --
- --- ---- ----- ------ ------ ----------------- --
- --- ---- ----- ---------- ------ --------------------- --
--
----- ---- - -
----- -- -- -- -- --------------- -- ------- --- ----
------ -- -- ------
--在这个示例中，定义了一个 user 查询和一个 users 查询，它们返回单个用户和用户列表。User 类型定义了用户对象的字段和类型。root 对象实现了 user 和 users 查询的逻辑，从 users 数组中查找并返回相应的用户。
3. 处理数据
在实际应用中，通常需要从数据库或其他数据源中获取数据，并将其转换为 GraphQL 可以理解的格式。以下是一个示例，展示如何使用 mongoose 模块从 MongoDB 数据库中获取数据：
-- -------------------- ---- -------
----- -------- - --------------------
----- - ----------- - - -------------------
--------------------------------------------------- - ---------------- ---- ---
----- ---- - ---------------------- -
----- -------
------ -------
---
----- ------ - -------------
---- ----- -
-------- ----- ----
------ ------
-
---- ---- -
--- ---
----- -------
------ -------
-
---
----- ---- - -
----- ----- -- -- -- -- ----- ------------------
------ ----- -- -- ----- ------------
--在这个示例中，定义了一个 User 模型，它映射到 MongoDB 数据库中的 users 集合。user 和 users 查询使用 async 和 await 关键字，以异步方式从数据库中获取数据。
4. 处理错误
在 GraphQL API 中，错误通常以异常的形式返回。可以使用 try...catch 块捕获异常，并将其转换为 GraphQL 可以理解的格式。以下是一个示例：
-- -------------------- ---- -------
----- ------ - -------------
---- ----- -
-------- ----- ----
------ ------
-
---- ---- -
--- ---
----- -------
------ -------
-
---
----- ---- - -
----- ----- -- -- -- -- -
--- -
----- ---- - ----- ------------------
-- ------- -
----- --- ----------- --- --------
-
------ -----
- ----- ------- -
----- --- ---------------------
-
--
------ ----- -- -- -
--- -
------ ----- ------------
- ----- ------- -
----- --- ---------------------
-
--
--在这个示例中，使用 try...catch 块捕获可能抛出的异常，并将其转换为 GraphQL 可以理解的格式，以便客户端可以正确处理错误。
5. 使用 DataLoader 进行数据加载
在 GraphQL API 中，通常需要从多个数据源中获取数据，并将它们组合成一个响应。这可能会导致 N+1 查询问题，即每个查询都需要向数据源发出一个单独的请求。可以使用 DataLoader 模块来解决这个问题。以下是一个示例：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- - ----------- - - -------------------
----- ------ - -------------
---- ----- -
-------- ----- ----
------ ------
-
---- ---- -
--- ---
----- -------
------ -------
------ ------
-
---- ---- -
--- ---
------ -------
----- -------
------- -----
-
---
----- ----- - -
- --- ---- ----- -------- ------ ------------------- --
- --- ---- ----- ------ ------ ----------------- --
- --- ---- ----- ---------- ------ --------------------- --
--
----- ----- - -
- --- ---- ------ ----- --- ----- ----- --- --------- --- --
- --- ---- ------ ----- --- ----- ----- --- --------- --- --
- --- ---- ------ ----- --- ----- ----- --- --------- --- --
- --- ---- ------ ----- --- ----- ----- --- --------- --- --
- --- ---- ------ ----- --- ----- ----- --- --------- --- --
--
----- ----------- - ---- -- --------------- -- ------- --- ----
----- ------------------- - ----- ----------- -- ----------------- -- -----------------------------------
----- ---------- - --- --------------------------------
----- ---- - -
----- -- -- -- -- ----------------
------ -- -- ------
----- -
------ ----- ------ -- ----- -------------------------
--
----- -
------- ----- ------ -- ----- ---------------------------
--
--在这个示例中，定义了一个 Post 类型和一个 getPostsByAuthorIds 函数，它从 posts 数组中获取所有与给定作者 ID 相关的帖子。使用 DataLoader 创建了一个 postLoader 实例，它可以批量加载帖子，以避免 N+1 查询问题。在 User 和 Post 类型的 Resolver 中使用 postLoader.load 和 getUserById 函数加载帖子和用户数据。
6. 使用 Apollo Server
最后，我们介绍一下如何使用 Apollo Server 来实现 GraphQL API。Apollo Server 是一个开源的 GraphQL 服务器，它提供了许多有用的功能，如查询缓存、Schema stitching、数据源和身份验证等。以下是一个示例：
-- -------------------- ---- -------
----- - ------------- --- - - -------------------------
----- -------- - ----
---- ----- -
-------- ----- ----
------ ------
-
---- ---- -
--- ---
----- -------
------ -------
-
--
----- ----- - -
- --- ---- ----- -------- ------ ------------------- --
- --- ---- ----- ------ ------ ----------------- --
- --- ---- ----- ---------- ------ --------------------- --
--
----- --------- - -
------ -
----- -- -- -- -- --------------- -- ------- --- ----
------ -- -- ------
--
--
----- ------ - --- -------------- --------- --------- ---
----------------------- --- -- -- -
--------------- ------ ----- -- ---------
---在这个示例中，使用 ApolloServer 创建了一个 GraphQL 服务器，并定义了一个 typeDefs 常量和一个 resolvers 对象。ApolloServer 会自动将 typeDefs 和 resolvers 编译成一个可执行的 Schema，并提供一个 Web 界面，可以用于测试和探索 GraphQL API。
结论
本文介绍了 Node.js 中实现 GraphQL API 的最佳实践，包括安装和配置 GraphQL、定义 Schema 和 Resolver、处理数据、处理错误、使用 DataLoader 和使用 Apollo Server。使用这些最佳实践，可以构建出高效、可扩展、易于维护的 GraphQL API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6739c044317fbffedf18899f