在前端开发中，使用 Restful API 是非常常见的方式来获取数据和与后端进行交互。然而，随着 Web 应用的复杂度的提高，在某些情况下，Restful API 的设计可能会变得非常的复杂和冗长。而 GraphQL ，一种新兴的 API 查询语言，能够很好的解决这个问题。本文将介绍 GraphQL 集成 Restful API 的最佳实践。
什么是 GraphQL?
GraphQL 是一种由 Facebook 开发的 API 查询语言。与传统的 Restful API 不一样，GraphQL 允许客户端请求一个特定的数据集，从而减少了数据冗余和额外的请求。GraphQL 具有以下优点:
- 灵活性: GraphQL 允许客户端自定义请求数据的结构和内容，
- 一次请求多个数据: 在一个 GraphQL 请求中，客户端可以请求一系列相关联的数据。
- 自描述性: GraphQL 接口自描述，即客户端可以根据服务端提供的 schema 来获取支持的操作和数据结构。
- 强类型: GraphQL 接口具有强类型系统，这意味着客户端在编写查询语句时就能发现许多错误。
随着 GraphQL 的流行，许多实现和库已经被开发用于各种编程语言和 Web 框架，包括 React, Vue 和 Angular。
Restful API 的缺点
虽然 Restful API 越来越流行，但是在某些情况下，其设计可能变得非常冗长和复杂。以下是一些 Restful API 的缺点:
- 过多的请求: 对于一些情况下，可能需要从多个 URL 加载相同的信息。
- 冗余数据: 在 Restful API 中，客户端经常需要返回与请求相关联的其他元数据。
- 不同端点之间的协调: API 端点可能会与软件开发周期中的不同迭代版本相关联，这可能会导致数据存储的不一致。
- 需要处理大量的响应数据: Restful API 通常会以深层嵌套的形式返回数据，这可能不利于处理。
GraphQL 的优点
GraphQL 的设计解决了许多 Restful API 的缺点。GraphQL 规范允许模块化、可维护的代码，并提供多个端点的 unique and customizable entry points。GraphQL 架构允许客户端发送更少的请求，减少网络流量、提高查询效率，并更严格的确保数据的一致性。
以下是一些 GraphQL 的优点:
- 减少资源消耗: GraphQL 允许客户端一次请求获取所有相关联的数据，减少了网络流量和服务器消耗。
- 精准数据: GraphQL 允许客户端指定其期望的资料，而不会包含任何不必要的信息。
- 适应性: GraphQL 是一种灵活的协议，易于构建满足各种不同编程语言、数据库和 Web 应用程序架构的特定应用场景的端点，也可与其他协议相互集成。
通常情况下，GraphQL 不能完全替代 Restful API。在某些情况下，如非结构化搜索、排序和分页，Restful API 可能仍然是首选。此外，当与遗留代码、数据库或其他数据集成时，GraphQL 可作为一种服务的中间件。
以下是 GraphQL 集成 Restful API 的最佳实践:
1. 确定使用 GraphQL 的最佳场景
确定标准场景，使用 Restful API 或 GraphQL 的优点，以确保最佳使用。
2. 定义 GraphQL schema
定义清晰的 GraphQL schema 非常重要，它会将类型、字段、参数和查询一致地描述为 GraphQL API 的入口。
3. 集成方法
选择可以将 REST 和 GraphQL API 编写为一个 API 网关的工具。这些工具可确保所有请求均经过网关，从而减轻了前端需要理解实际 API 的负担。因此，这样整个应用程序和生态系统可以更轻松地缓解潜在的重构问题。
4. 分离数据处理逻辑
GraphQL schema 剥离了逻辑层，注重于功能的暴露，RPC 的请求-响应借口，有一个好的实现方式就是将数据处理逻辑与 GraphQL schema 分离。
示例代码
使用 GraphQL 查询 Github REST API：
// javascriptcn.com 代码示例
query getUser($username: String!) {
user(login: $username) {
name
email
location
repositories {
totalCount
nodes {
name
description
}
}
}
}
总结
GraphQL 在许多领域都有着强大的表现，尤其是在减少网络资源使用、减少网络性能问题和提高代码可维护性方面。但是，为了将其用于现实世界的场景，可能需要与常规的 RESTful API 一起使用。在合理的情况下，根据这些最佳实践，将 GraphQL 集成到 Restful API 中，可以带来卓越的结果，并取悦那些寻求适度性能增强的客户端。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65360dd67d4982a6ebde3231