GraphQL 是一种用于构建 API 的查询语言和运行时环境,于 2015 年由 Facebook 发布,目前已经成为前端开发的重要工具之一。相比于传统的 RESTful API,GraphQL 具有更高灵活性、更好的性能和更好的开发体验,因此越来越多的开发者开始使用 GraphQL 构建应用。
本文将从架构设计模式的角度来解析 GraphQL,包括 GraphQL 的基本概念、GraphQL 的架构设计、数据源的处理和几种常见的 GraphQL 架构设计模式。
GraphQL 基本概念
- Schema(模式):由类型定义、查询和变量定义组成,表示可以被客户端查询的属性和操作。
- Query(查询):由客户端指定的根类型,查询通常在客户端发起。
- Mutation(变异):可修改数据或执行带副作用的操作,例如写入数据库。
- Subscription(订阅):类似于 WebSockets,允许客户端接收服务器端实时数据推送。
GraphQL 的架构设计
GraphQL 通过定义数据模型、查询语言、解析器和类型定义等方式,将应用程序中的数据和操作暴露给客户端。下面是一个基本的 GraphQL 架构设计图:
-- -------------------- ---- ------- ---------------------------- - - - ------- - - - ---------------------------- ----- - - -------- ----------------- ------ -------------------------- - - - ---------------------------- - - - - -------- - - ---- ------ - ----------------- ------------------------- - - - ---------------------------- - - - - ------------ - - - ----------------- -------------------------- - - - ---------------------------- - - - - - -- - - - - - -----------------------------------------------------
- GraphQL Schema(模式):客户端的请求将相应地由 Schema 将其解析成 Query、Mutation 或 Subscription,并将其分发到其所需的 Resolver 上。Schema 定义了服务器端应用的 API 接口,GraphQL 查询会被映射到特定的 Resolver。Resolver 是处理具体操作逻辑的地方。GraphQL Schema 可以从 GraphQL 查询或者 SDL(Schema Definition Language)中构建而来。
- GraphQL Query(查询):SQLite 从客户端发送过来的请求。查询可以嵌套,查询语句可以包含嵌套字段,对于关系数据,可以在查询中指定多级嵌套关系。
- GraphQL Mutation(变异):与查询类似,mutation 用于执行写操作,如创建、更新、删除等。
- GraphQL Subscription(订阅):Subscription 可以用于向客户端推送实时数据。在 GraphQL WebSocket 中,数据推送的过程是通过 GraphQL Subscription 被订阅和执行。
数据源的处理
在 GraphQL 体系结构中,通常有许多数据源,可以是数据库、文件或任何 HTTP 端点。要将这些数据源暴露给客户端,请使用 Resolver。Resolver 是在 API 中定义的查询或 mutation 字段的实现。数据源通常定义在 Resolver 中,其中 Resolver 处理从数据源检索数据的逻辑。Resolver 可以帮助我们从不同的数据源中组合数据,也可以帮助我们遵循请求已经执行的顺序。
例如,我们可以定义一个简单的 Resolver,用于从数据库中获取用户列表:
-- -------------------- ---- ------- ----- - ------------ - - ------------------------- ----- ------ - --- -------------- ----- --------- - - ------ - ------ ----- -------- ----- -------- -- - ------ ----- -------------------------- -- -- -
常见的 GraphQL 架构设计模式
- 基本查询:查询返回最基本的用户数据,例如名称和电子邮件。
query { user { name email } }
- 嵌套查询:查询嵌套相应实体的子实体,例如用户的帖子。
-- -------------------- ---- ------- ----- - ---- - ---- ----- - ----- ------- - - -
- 连接查询:连接查询是嵌套查询的变体,它可以从两个或多个实体之间建立连接,并返回与此连接相关的数据,例如用户的帖子评论。
-- -------------------- ---- ------- ----- - ---- - ---- ----- - ----- -------- - ----- - - - -
- 分页查询:分页查询返回结果的一页,通常用于在 Web 应用程序中显示优化的用户界面。
-- -------------------- ---- ------- ----- - ---- - ---- ------------ --- ------ ------ - ----- ------- - - -
- 过滤查询:过滤查询允许从结果集中排除或仅包括满足某些条件的结果。
-- -------------------- ---- ------- ----- - ---- - ---- ------------ - ---------- ---- -- - ----- ------- - - -
- 变异操作:变异操作是一种写操作,通常用于更新或删除实体。
mutation { updateUser(id: "1", name: "Alice") { name } }
- 订阅操作:订阅操作用于流 API 中使用,它允许客户端订阅服务器端的实时事件并接收推送通知。
subscription { newMessage { content author { name } } }
结论
GraphQL 架构设计模式可以帮助我们更好地理解 GraphQL 的使用,同时构建更高效、更灵活的 API。随着 GraphQL 在前端工具箱中的不断增加,它以不同的形式和场景成为一种物美价廉的解决方案。前端工程师应该掌握 GraphQL 实现和工具链的使用,以便更好地构建现代 Web 应用程序。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/66fa931644713626014dbf64