GraphQL 是一个由 Facebook 开源的数据查询和操作语言，它提供一种更高效、强大和灵活的方式来访问和操纵 API 数据，已经成为了现代 Web 开发的重要技术之一。
在本文中，我们将探讨 GraphQL 的基础概念、使用方法和最佳实践，以便能够更好地利用其功能进行 API 开发。
1. GraphQL 基础概念
GraphQL 的核心概念包括 Schema、Query、Mutation 和 Subscription。
Schema
GraphQL Schema 是一个类型定义的集合，描述了 GraphQL API 支持的数据类型和操作。它是 API 开发的基础，通过定义类型和字段，使客户端能够查询、修改或订阅数据。Schema 通常由一组 GraphQL 类型定义组成，包括对象类型、枚举类型、接口类型、联合类型和标量类型。
例如，下面是一个简单的 GraphQL Schema 定义：
-- -------------------- ---- ------- ---- ---- - --- --- ----- ------- ---- --- - ---- ----- - -------- ----- ---- -
在这个例子中，定义了一个 User 类型和一个 Query 类型。User 类型包含三个字段：id、name 和 age，其中 id 和 name 是必须返回的非空字段，age 是可选的整数。Query 类型包含一个 user 函数，它接收一个 ID 参数，并返回一个 User 类型的对象。
Query
Query 是 GraphQL 规范中的操作类型之一，用于查询数据。它定义了客户端可以执行的数据查询，描述了如何获取所需的数据，同时也定义了所返回的数据类型。
GraphQL Query 可以包含多个字段，每个字段可以进一步包含子字段。通过 Query 可以指定查询的目标对象和相关字段，可以嵌套对象以便获取所需的数据。
例如，下面是一个简单的 GraphQL Query 示例：
query {
user(id: "123") {
id
name
age
}
}在这个例子中，Query 包含一个 user 函数，它接收一个 ID 参数并返回一个 User 类型的对象。在 user 对象中，指定了三个字段：id、name 和 age，这些字段将在查询结果中被返回。
Mutation
Mutation 是 GraphQL 规范中的操作类型之一，用于修改数据。它定义了客户端可以执行的数据修改操作，描述了如何修改数据，同时也定义了所返回的数据类型。
GraphQL Mutation 可以包含多个字段，每个字段可以进一步包含子字段。通过 Mutation 可以指定需要修改的对象和相关字段，可以传递参数以便进行数据更新。
例如，下面是一个简单的 GraphQL Mutation 示例：
mutation {
updateUser(id: "123", name: "Tom", age: 25) {
id
name
age
}
}在这个例子中，Mutation 包含一个 updateUser 函数，它接收一个 ID 参数和一个包含 name 和 age 字段的对象。这个函数将更新指定 ID 的用户对象的 name 和 age 字段，并返回更新后的用户对象。
Subscription
Subscription 是 GraphQL 规范中的操作类型之一，用于订阅数据。它定义了客户端可以执行的数据订阅操作，描述了如何获取实时数据更新，同时也定义了所返回的数据类型。
GraphQL Subscription 可以包含多个字段，每个字段可以进一步包含子字段。通过 Subscription 可以指定需要订阅的对象和相关字段，可以监听实时数据更新，以便在数据更新时得到通知。
例如，下面是一个简单的 GraphQL Subscription 示例：
subscription {
userUpdate(id: "123") {
id
name
age
}
}在这个例子中，Subscription 包含一个 userUpdate 函数，它接收一个 ID 参数并返回一个 User 类型的对象。客户端可以进行订阅以获得实时数据更新，当指定 ID 的用户对象的数据更新时，将触发 userUpdate 函数并返回更新后的用户对象。
2. GraphQL 使用方法
GraphQL 可以在多种编程语言和开发框架中使用，包括 JavaScript、Python、Ruby、Java 和 PHP 等。在使用 GraphQL 进行 API 开发时，通常需要依次执行以下步骤：
步骤 1：定义 Schema
首先需要定义 GraphQL Schema，包括类型定义、字段定义和相应的操作类型。可以使用 GraphQL Schema Language 或编程语言实现来定义 Schema。
例如，使用 JavaScript 实现一个简单的 GraphQL Schema：
-- -------------------- ---- -------
----- - ----------- - - -------------------
----- ------ - -------------
---- ---- -
--- ---
----- -------
---- ---
-
---- ----- -
-------- ----- ----
-
---- -------- -
-------------- ---- ----- ------- ---- ----- ----
-
---- ------------ -
-------------- ----- ----
-
---
-------------- - -------在这个例子中，使用 buildSchema 函数创建了一个包含 User、Query、Mutation 和 Subscription 类型的 Schema。
步骤 2：定义 Resolver
接下来需要定义 Resolver，用于处理 GraphQL Query、Mutation 和 Subscription 中的各种请求。Resolver 将查询、修改或订阅请求转换为实际的操作，通常与后端数据存储或第三方服务进行交互。
例如，使用 JavaScript 实现一个简单的 GraphQL Resolver：
-- -------------------- ---- -------
----- - -------- ----------- - - -------------------
----- ------ - --------------------
----- ----- - -
- --- ------ ----- ------ ---- -- --
- --- ------ ----- -------- ---- -- --
--
----- --------- - -
------ -
----- -- -- -- -- -
------ --------------- -- ------- --- ----
--
--
--------- -
----------- -- --- ----- --- -- -- -
----- ---- - --------------- -- ------- --- ----
-- ------ -
--------- - -----
-
-- ----- -
-------- - ----
-
------ -----
--
--
------------- -
----------- -- -- -- -- -
-- ----- --------- ------------ -----
--
--
--
----- ----- - -
-------- -
-------------- ------ ----- -------- ---- --- -
--
----
---
-
-
--
--------------- ------ ----------
------------ -- --------------------
------------ -- --------------------在这个例子中，使用 find 函数查找存储在数组中的用户对象，使用对象属性修改用户数据，并将更新后的用户对象返回给客户端。
步骤 3：定义 API
最后需要定义 GraphQL API，包括请求处理和响应输出。可以使用各种 Web 框架或中间件库来实现 GraphQL API。
例如，使用 Node.js 和 Express 实现一个简单的 GraphQL API：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ---------- - ----------------------- ----- - ----------- - - --------------------------- ----- ------ - -------------------- ----- --------- - ----------------------- ----- --- - ---------- --------------------------- --------------- ------------- ------- ---------- ---------- --------- ----- ---- ----- ---- - ----- ---------------- -- -- - -------------------- --- ------ ------- -- ---- ---------- ---
在这个例子中，使用 graphqlHTTP 中间件并指定 Schema 和 Resolver，同时打开 GraphiQL 调试界面。
3. GraphQL 最佳实践
以下是一些使用 GraphQL 进行 API 开发时的最佳实践：
1. 定义清晰简洁的 Schema
GraphQL Schema 应该清晰、简洁和易于理解，规避歧义和歧义情况。Schema 应该反映 API 实际的数据结构和操作，保持一致性和可维护性。
2. 使用 Type-safe API 客户端
Type-safe API 客户端可以帮助开发人员减少手写 API 客户端时的错误，并改进代码的质量和可维护性。Type-safe API 客户端使得请求和响应数据的类型根据 Schema 自动生成，并提供 IDE 支持和自动补全功能。
例如，使用 JavaScript 和 apollo-client 实现一个简单的 Type-safe API 客户端：
-- -------------------- ---- -------
------ - ------------- ------------- - ---- -----------------
------ - --- - ---- ----------------------
----- ------ - --- --------------
---- ----------------------------
------ --- ----------------
---
----- ----- - ----
----- ------------ ---- -
-------- ---- -
--
----
---
-
-
--
--------------
------
---------- -
--- ------
--
-------------- -- --------------------------在这个例子中，使用 gql 函数定义查询语句，生成 Type-safe 的查询客户端，自动识别查询的参数类型和返回值类型，并自动生成对应的数据结构。
3. 使用分层架构和数据加载器
对于复杂的应用程序，使用分层架构和数据加载器将有助于解决数据查询和操作的难度，并提高 API 的性能和可扩展性。分层架构将大型应用程序切分为多个子应用，使代码保持清晰、易于维护和扩展。数据加载器是一种优化缓存和加载数据的工具，用于将重复的数据请求合并为单个请求，并最小化数据库查询次数。
例如，使用 Node.js 和 DataLoader 实现一个简单的数据加载器：
-- -------------------- ---- -------
----- - ---------- - - ----------------------
----- - ----- - - ----------------
----- ---------- - --- -------------- -- -
----- ------ - ---------- -- ------------- - ---- ----- ----- -- - --- -------
------ --------------------
---
----- ------------ - --- ---------------- -- -
----- ------ - -------------- -- ------------- - ---- ----- ----- ---- - --- ---------
------ --------------------
---
----- --------- - -
------ -
--------- -- -- -- -- -
------ --------------------
--
----------- -- ---- -- -- -
------ ------------------------
--
--
--在这个例子中，定义了两个 DataLoader 实例，用于按 ID 或名称加载用户对象。数据加载器使用数据库查询语句进行查询，并将结果返回给客户端。
4. 总结
本文介绍了使用 GraphQL 进行 API 开发的基本概念、使用方法和最佳实践。GraphQL 是一个强大和灵活的技术，可以极大地改善 API 的性能和可维护性。掌握 GraphQL 的基础知识和最佳实践，将有助于开发人员更好地利用其功能进行 API 开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/645c44e1968c7c53b0e91c80