理解 GraphQL:GraphQL 简介

理解 graphql:graphql 简介

概述

GraphQL 是一个令人兴奋的全新 API,用于即席查询和操作。它非常灵活并提供许多好处。它特别适合公开以图形和树形式组织的数据。 Facebook 于 2012 年开发了 GraphQL,并于 2015 年开源。

它迅速发展并成为最热门的技术之一。许多创新公司在生产中采用并使用了 GraphQL。在本教程中,您将学习:

GraphQL 的原理与 REST 相比如何如何设计架构如何设置 GraphQL 服务器如何实现查询和变更以及一些其他高级主题

GraphQL 的亮点在哪里?

当您的数据按层次结构或图形组织并且前端希望访问该层次结构或图形的不同子集时,GraphQL 处于最佳状态。考虑一个公开 NBA 的应用程序。你有球队、球员、教练、冠军,以及每一项的大量信息。以下是一些示例查询:

金州勇士队目前名单上的球员姓名是什么?华盛顿奇才队先发球员的姓名、身高和年龄是多少?哪位现役教练获得的冠军最多?教练在哪几年为哪些球队赢得了冠军?哪位球员获得 MVP 奖项最多?

我可以提出数百个这样的查询。想象一下,您必须设计一个 API 将所有这些查询公开给前端,并且当您的用户或产品经理提出新的令人兴奋的查询内容时,能够使用新的查询类型轻松扩展 API。

这并不是一件小事。 GraphQL 旨在解决这个确切的问题,并且通过单个 API 端点,它提供了巨大的功能,您很快就会看到。

GraphQL 与 REST

在深入了解 GraphQL 的具体细节之前,我们先将其与 REST 进行比较,后者是目前最流行的 Web API 类型。

REST 遵循面向资源的模型。如果我们的资源是球员、教练和球队,那么可能会有这样的端点:

/玩家/玩家/ /教练/教练/ /团队/团队/

通常,没有 id 的端点仅返回 id 列表,而具有 id 的端点则返回一个资源的完整信息。当然,您可以以其他方式设计 API(例如 /players 端点可能还返回每个玩家的姓名或有关每个玩家的所有信息)。

在动态环境中,这种方法的问题在于,您要么获取不足(例如,您只获取 id 并且需要更多信息),要么过度获取(例如,在你只是对名字感兴趣)。

这些都是难题。获取不足时,如果您获取 100 个 id,则需要执行 100 个单独的 API 调用才能获取每个玩家的信息。当过度获取时,您会浪费大量后端时间和网络带宽来准备和传输大量不需要的数据。

有多种方法可以通过 REST 来解决这个问题。您可以设计许多定制端点,每个端点都准确返回您需要的数据。该解决方案不可扩展。保持 API 的一致性是很困难的。很难进化它。很难记录和使用它。当这些定制端点之间存在大量重叠时,很难维护它。

考虑这些额外的端点:

/玩家/姓名/players/names_and_championships/团队/首发

另一种方法是保留少量通用端点,但提供大量查询参数。该解决方案避免了多端点问题,但它违背了 REST 模型的原则,而且难以一致地发展和维护。

你可以说 GraphQL 已经将这种方法发挥到了极限。它并不考虑明确定义的资源,而是考虑整个域的子图。

GraphQL 类型系统

GraphQL 使用由类型和属性组成的类型系统对域进行建模。每个属性都有一个类型。属性类型可以是 GraphQL 提供的基本类型之一,例如 ID、String 和 Boolean,也可以是用户定义的类型。图的节点是用户定义的类型,边是具有用户定义类型的属性。

例如,如果“玩家”类型具有“团队”类型的“团队”属性,则意味着每个玩家节点到团队节点之间存在一条边。所有类型都在描述 GraphQL 域对象模型的架构中定义。

这是 NBA 域的一个非常简化的架构。球员有一个名字,与他最相关的球队(是的,我知道球员有时会从一支球队转到另一支球队),以及球员赢得的冠军数量。

球队有名字、球员阵容以及球队赢得的冠军数量。

type Player {    id: IDname: String!team: Team!championshipCount: Integer!}type Team {id: IDname: String!players: [Player!]!championshipCount: Integer!}

还有预定义的入口点。它们是查询、变更和订阅。前端通过入口点与后端进行通信,并根据需要进行自定义。

这是一个简单返回所有玩家的查询:

type Query {    allPlayers: [Player!]!}

感叹号表示该值不能为空。对于 allPlayers 查询,它可以返回空列表,但不能返回 null。另外,这意味着列表中不能有空玩家(因为它包含 Player!)。

设置 GraphQL 服务器

这是一个基于 Node-Express 的成熟 GraphQL 服务器。它有一个内存中的硬编码数据存储。通常,数据将位于数据库中或从其他服务获取。数据定义如下(如果您最喜欢的球队或球员未能入选,请提前致歉):

UP简历 UP简历

基于AI技术的免费在线简历制作工具

UP简历 128 查看详情 UP简历

let data = {  "allPlayers": {    "1": {      "id": "1",      "name": "Stephen Curry",      "championshipCount": 2,      "teamId": "3"    },    "2": {      "id": "2",      "name": "Michael Jordan",      "championshipCount": 6,      "teamId": "1"    },    "3": {      "id": "3",      "name": "Scottie Pippen",      "championshipCount": 6,      "teamId": "1"    },    "4": {      "id": "4",      "name": "Magic Johnson",      "championshipCount": 5,      "teamId": "2"    },    "5": {      "id": "5",      "name": "Kobe Bryant",      "championshipCount": 5,      "teamId": "2"    },    "6": {      "id": "6",      "name": "Kevin Durant",      "championshipCount": 1,      "teamId": "3"    }  },  "allTeams": {    "1": {      "id": "1",      "name": "Chicago Bulls",      "championshipCount": 6,      "players": []    },    "2": {      "id": "2",      "name": "Los Angeles Lakers",      "championshipCount": 16,      "players": []    },    "3": {      "id": "3",      "name": "Golden State Warriors",      "championshipCount": 5,      "players": []    }  }}

我使用的库是:

const express = require('express');const graphqlHTTP = require('express-graphql');const app = express();const { buildSchema } = require('graphql');const _ = require('lodash/core');

这是构建架构的代码。请注意,我向 allPlayers 根查询添加了几个变量。

schema = buildSchema(`  type Player {    id: ID    name: String!    championshipCount: Int!    team: Team!  }    type Team {    id: ID    name: String!    championshipCount: Int!    players: [Player!]!  }    type Query {    allPlayers(offset: Int = 0, limit: Int = -1): [Player!]!  }`

关键部分来了:连接查询并实际提供数据。 rootValue 对象可能包含多个根。

这里,只有 allPlayers。它从参数中提取偏移量和限制,对所有玩家数据进行切片,然后根据团队 ID 设置每个玩家的团队。这使得每个玩家都是一个嵌套对象。

rootValue = {  allPlayers: (args) => {    offset = args['offset']    limit = args['limit']    r = _.values(data["allPlayers"]).slice(offset)    if (limit > -1) {      r = r.slice(0, Math.min(limit, r.length))    }    _.forEach(r, (x) => {      data.allPlayers[x.id].team   = data.allTeams[x.teamId]    })    return r  },}

最后,这是 graphql 端点,传递架构和根值对象:

app.use('/graphql', graphqlHTTP({  schema: schema,  rootValue: rootValue,  graphiql: true}));app.listen(3000);module.exports = app;

graphiql 设置为 true 使我们能够使用出色的浏览器内 GraphQL IDE 来测试服务器。我强烈推荐它来尝试不同的查询。

使用 GraphQL 进行临时查询

万事俱备。让我们导航到 http://localhost:3000/graphql 并享受一些乐趣。

我们可以从简单的开始,只包含玩家姓名列表:

query justNames {    allPlayers {    name  }}Output:{  "data": {    "allPlayers": [      {        "name": "Stephen Curry"      },      {        "name": "Michael Jordan"      },      {        "name": "Scottie Pippen"      },      {        "name": "Magic Johnson"      },      {        "name": "Kobe Bryant"      },      {        "name": "Kevin Durant"      }    ]  }}

好吧。我们这里有一些超级巨星。毫无疑问。让我们尝试一些更奇特的东西:从偏移量 4 开始,有 2 名玩家。对于每个球员,返回他们的名字和他们赢得的冠军数量以及他们的球队名称和球队赢得的冠军数量。

query twoPlayers {    allPlayers(offset: 4, limit: 2) {    name    championshipCount    team {      name      championshipCount    }  }}Output:{  "data": {    "allPlayers": [      {        "name": "Kobe Bryant",        "championshipCount": 5,        "team": {          "name": "Los Angeles Lakers",          "championshipCount": 16        }      },      {        "name": "Kevin Durant",        "championshipCount": 1,        "team": {          "name": "Golden State Warriors",          "championshipCount": 5        }      }    ]  }}

所以科比·布莱恩特随湖人队赢得了 5 个总冠军,湖人队总共获得了 16 个总冠军。凯文·杜兰特在勇士队只赢得了一次总冠军,而勇士队总共赢得了五次总冠军。

GraphQL 突变

魔术师约翰逊无疑是场上的魔术师。但如果没有他的朋友卡里姆·阿卜杜勒·贾巴尔,他不可能做到这一点。让我们将 Kareem 添加到我们的数据库中。我们可以定义 GraphQL 突变来执行从图表中添加、更新和删除数据等操作。

首先,让我们向架构添加突变类型。它看起来有点像函数签名:

type Mutation {    createPlayer(name: String,                  championshipCount: Int,                  teamId: String): Player}

然后,我们需要实现它并将其添加到根值中。该实现只是获取查询提供的参数并将一个新对象添加到 data['allPlayers']。它还确保正确设置团队。最后,它返回新的玩家。

  createPlayer: (args) => {    id = (_.values(data['allPlayers']).length + 1).toString()    args['id'] = id    args['team'] = data['allTeams'][args['teamId']]    data['allPlayers'][id] = args    return data['allPlayers'][id]  },

要实际添加 Kareem,我们可以调用突变并查询返回的玩家:

mutation addKareem {  createPlayer(name: "Kareem Abdul-Jabbar",                championshipCount: 6,                teamId: "2") {    name    championshipCount    team {      name    }  }}Output:{  "data": {    "createPlayer": {      "name": "Kareem Abdul-Jabbar",      "championshipCount": 6,      "team": {        "name": "Los Angeles Lakers"      }    }  }}

这是一个关于突变的黑暗小秘密……它们实际上与查询完全相同。您可以在查询中修改数据,并且可能只从突变中返回数据。 GraphQL 不会查看您的代码。查询和突变都可以接受参数并返回数据。它更像是语法糖,可以使您的架构更具人类可读性。

高级主题

订阅

订阅是 GraphQL 的另一个杀手级功能。通过订阅,客户端可以订阅每当服务器状态发生变化时就会触发的事件。订阅是后来引入的,不同的框架以不同的方式实现。

验证

GraphQL 将验证针对架构的每个查询或突变。当输入数据具有复杂形状时,这是一个巨大的胜利。您不必编写烦人且脆弱的验证代码。 GraphQL 将为您处理好它。

架构自省

您可以检查和查询当前架构本身。这为您提供了动态发现架构的元能力。下面是一个返回所有类型名称及其描述的查询:

query q {  __schema {    types {      name      description                }  }

结论

GraphQL 是一项令人兴奋的新 API 技术,与 REST API 相比,它具有许多优势。它背后有一个充满活力的社区,更不用说Facebook了。我预测它将很快成为前端的主要内容。试一试。你会喜欢的。

以上就是理解 GraphQL:GraphQL 简介的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/537678.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
vscode的提示如何设置成中文
上一篇 2025年11月9日 13:31:55
解决电商购物车商品选项丢失问题,SprykerProductOptionCartConnector助你实现无缝集成
下一篇 2025年11月9日 13:32:14

相关推荐

  • XML的DOM的DocumentFragment有什么用?

    documentfragment通过批量操作dom节点显著提升页面性能。它作为内存中的虚拟容器,允许开发者在不触发重绘和回流的情况下构建或修改节点结构,待所有操作完成后一次性插入文档。相较于逐个添加节点会引发多次渲染,使用documentfragment可减少浏览器的计算压力。其与普通元素节点不同之…

    2025年12月17日
    100
  • XPath的string()函数转换规则是什么?

    要提取特定元素的文本内容,可使用string()函数。对于给定html片段,提取div全部文本的方法是string(//div[@class=’content’]),结果包含所有后代文本节点;若只想提取p标签内文本而不包括a标签,则使用string-join(//div[@c…

    2025年12月17日
    100
  • XSLT的document()函数怎么加载外部XML?

    xslt的document()函数用于加载外部xml文件数据。1. 它通过xpath表达式调用,传入uri参数,返回外部xml文档的节点集;2. 典型用法包括整合多源数据、配置与查找表、模块化与重用以及处理大型xml文档;3. 路径解析支持绝对路径和相对路径,但需注意部署环境差异;4. 错误处理需检…

    2025年12月17日
    100
  • XML的DOM接口中NodeList怎么遍历?

    nodelist的遍历核心是利用length属性和索引访问节点,最稳妥的方式是使用传统for循环;1. nodelist分为“活的”和“死的”两种类型,“活的”会随dom变化实时更新,常见于getelementsbytagname、getelementsbyclassname和childnodes,…

    2025年12月17日
    200
  • XSD的substitutionGroup如何实现元素替换?

    xsd的substitutiongroup机制通过元素替代实现xml文档结构的多态性,使某个元素能被其“家族”中的其他成员替代,同时保持schema验证有效。具体步骤为:1. 定义头部元素(如vehicle),作为通用接口;2. 定义替代成员元素(如car、motorcycle),它们必须是全局元素…

    2025年12月17日
    100
  • XML的SAX解析器如何处理开始标签事件?

    sax解析器在开始标签事件中能提供uri、localname、qname及attributes四个关键信息。1. uri表示命名空间uri,用于区分不同命名空间下的同名标签;2. localname是不带命名空间前缀的本地标签名;3. qname是包含命名空间前缀的完整标签名;4. attribut…

    2025年12月17日
    000
  • XSLT的key()函数如何建立节点索引?

    xslt的key()函数通过预索引机制提升xml节点查找效率。1. 使用xsl:key声明索引,定义name(唯一名称)、match(匹配节点)、use(键值来源)属性;2. 在模板中调用key()函数,传入索引名和查找值,快速获取对应节点集。它解决了xpath//操作符在大型文档中重复遍历导致的性…

    2025年12月17日
    000
  • XQuery的validate表达式如何校验文档?

    xquery的validate表达式用于根据xml schema校验xml数据是否合规,其核心作用是确保数据结构和内容符合预期。它提供两种验证模式:1. strict模式要求数据完全符合schema定义,任何不匹配都会导致错误;2. lax模式仅验证schema中明确定义的部分,忽略未定义的内容。v…

    2025年12月17日
    100
  • RSS的item元素的guid有什么作用?

    guid在rss中的核心作用是为每个条目提供唯一标识以实现去重、更新追踪和稳定识别。具体包括:1.去重防漏:聚合器通过记录已处理的guid避免重复显示相同条目;2.内容更新追踪:当内容小幅修改但guid不变时,阅读器能识别为同一内容的更新而非新条目;3.作为永久链接:默认ispermalink=&#…

    2025年12月17日
    100
  • XPath的namespace轴在什么情况下使用?

    xpath的namespace轴关键在于处理带命名空间的xml/html文档,通过注册前缀与uri映射实现精准定位。1. 命名空间用于避免元素冲突,如book:title与cd:title属不同空间;2. xpath中直接使用前缀会失败,因需通过namespace context明确前缀对应uri;…

    2025年12月17日
    000
  • XSLT的apply-templates选择节点有哪些方式?

    xslt中apply-templates选择节点的方式主要有两种:1.通过select属性指定xpath表达式精准选择节点;2.不指定select属性时默认处理当前上下文的所有子节点。此外,结合mode属性可实现对相同节点的不同处理逻辑。使用select属性时,xpath表达式可以是相对路径、绝对路…

    2025年12月17日
    100
  • XSLT的mode属性在模板中起什么作用?

    xslt中的mode属性通过为模板提供“模式”概念,使同一xml节点在不同模式下可被不同模板处理。1. 定义模板时,在xsl:template上使用mode属性,如mode=”summary-view”或mode=”detail-view”,以区分不同…

    2025年12月17日
    000
  • XML的DOM的Attr接口有哪些属性?

    xml dom中的attr接口暴露了name、value、specified和ownerelement四个核心属性。name是只读字符串,表示属性名称;value是可读写字符串,用于获取或设置属性值;specified是布尔值,指示属性是否在文档中明确指定;ownerelement指向拥有该attr…

    2025年12月17日
    000
  • XLink的show属性有哪些可选值?

    xlink的show属性用于定义链接资源的展示方式,主要有五个值:new、replace、embed、other和none。new表示在新窗口打开;replace表示替换当前内容;embed表示将资源嵌入当前文档;other由应用程序自定义行为;none则不预设任何显示行为。相比html的targe…

    2025年12月17日
    000
  • XSL-FO的block-container如何定位内容?

    block-container在xsl-fo中用于创建独立布局上下文以实现高级定位和局部排版控制。1. 它为内部元素提供新的坐标系,支持绝对定位,允许子元素相对于容器进行left、top等属性的精确定位;2. block-container可设定width、height、边距等属性,与主文档流分离,…

    2025年12月17日
    000
  • XSD的restriction元素如何限制简单类型?

    xsd中restriction元素用于对简单类型进行约束,通过刻面限制值域。常用刻面包括:1.length、minlength、maxlength限制长度;2.pattern使用正则定义格式;3.enumeration限定可选值;4.mininclusive/maxinclusive等定义数值范围;…

    2025年12月17日
    000
  • XSLT的number元素如何格式化序号?

    xslt的number元素通过format、level、count等核心属性实现灵活的序号控制。1. format定义输出格式,如1、a、a、i、i及混合格式;2. level指定计数级别,包括single(默认)、multiple(多级编号)和any(全局连续计数);3. count设定要计数的节…

    2025年12月17日
    000
  • XSD的key和keyref如何定义数据关系?

    xsd中key和keyref机制用于定义xml文档内部数据的唯一性和引用完整性,其核心在于通过唯一键(key)和引用键(keyref)确保数据一致性。1. key用于定义唯一标识符,由selector指定目标元素集,field指定构成唯一值的属性或子元素,确保所选范围内该值全局唯一;2. keyre…

    2025年12月17日
    000
  • SOAP消息的Envelope元素有什么作用?

    soap消息的envelope元素是整个消息的根元素,它定义了消息的结构、协议版本和扩展性。1.envelope必须包含body元素,header为可选;2.通过xmlns:soap属性指定soap版本,如soap 1.1或soap 1.2;3.header用于传递元数据,如安全信息、路由信息等,并…

    2025年12月17日
    000
  • XML如何定义别名机制?

    xml没有官方的“别名机制”,但通过命名空间、实体引用和schema的ref属性实现了类似功能。1.命名空间通过前缀绑定uri,避免元素名冲突,如soap:envelope中的soap是uri的别名;2.实体引用通过定义通用或参数实体实现内容复用,如用&copyright;代替固定文本;3.…

    2025年12月17日
    100

发表回复

登录后才能评论
关注微信