前端应该知道的GraphQL

本文主要结合GitHub GraphQL API,从前端使用者的角度来谈GraphQL,没有GraphQL项目的同学可以拿GitHub GraphQL API练手,具体代码可参见我的GitHub Blog,欢迎star、fork。

为什么需要GraphQL?

以我的博客为例,目前列表页,每篇文章需要的数据结构如下:

{
    "title": "前端应该知道的GraphQL",
    "updatedAt": "2018-04-22T03:46:34Z",
    "bodyText": "本文主要结合...",
}

而文章详情页的数据结构为:

{
    "title": "前端应该知道的GraphQL",
    "updatedAt": "2018-04-22T03:46:34Z",
    "bodyHTML": "<p>本文主要结合...",
}

又想记录下文章的浏览量,日后成为大V,再展示出来 hhh~

{
    "title": "前端应该知道的GraphQL",
    "updatedAt": "2018-04-22T03:46:34Z",
    "bodyHTML": "<p>本文主要结合...",
    "view": "29898",
}

那么问题来了:两个页面的数据结构title和updateAt的数据是重复的,而body是不同的,并且还有一个希望现在就设计好以后需要的时候再用到的view字段。如果为了方便,只写一个接口,同时返回bodyText和bodyHTML,那总有数据是多余的,这样也不合理。但如果分两个接口,又显的有点麻烦和浪费。

这还只是一个简单的例子,平时开发过程中,需求变化特别频繁,遇到的问题也会更复杂,目前主流的RESTful API所暴露出来的问题也越来越明显。

如果能从源头出发,接口返回的数据不是由生产方(后端),而是由使用方(前端)来决定,就可以达到所见即所得的效果,这时候GraphQL也就应运而生了。

什么是GraphQL?

先贴官网:英文 | 中文

GraphQL 既是一种用于 API 的查询语言,也是一个满足你数据查询的运行时。 GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述,使得客户端能够准确地获得它需要的数据,而且没有任何冗余,也让 API 更容易地随着时间推移而演进,还能用于构建强大的开发者工具。

也就是说,GraphQL能够在你调用api的时候来决定api返回的数据结构,以此达到精准、没有冗余的拿到所需要的数据。GraphQL这么厉害,是如何做到的呢?我们先从我的博客文章详情页接口入手来揭示GraphQL的庐山真面目:

let data = {
  query: `query {
      repository(owner:"simbawus", name: "blog") {
        issue(number: ${articleId}) {
          title
          updatedAt
          bodyHTML
        }
      }
    }`
};

Actions.getIssues(data).then((res) => {
  let issue = res.data.data.repository.issue;

  this.setState({
      title: issue.title,
      updatedAt: new Date(issue.updatedAt).format('yyyy-MM-dd'),
      bodyHTML: issue.bodyHTML
  })
})

这就是一个基于GitHub GraphQL API的请求,跟普通请求唯一的区别就在请求参数data,并不是 JSON 对象,而是一个字符串,这个字符串描述了客户端希望服务端返回数据的具体结构,如下JSON:

{
    "data": {
        "repository": {
            "issue": {
                "bodyHTML": "<p>本文主要结合...",
                "title": "前端应该知道的GraphQL",
                "updatedAt": "2018-04-22T03:46:34Z",
            }
        }
    }
}

结合这个例子,我来介绍GraphQL的几个核心概念:

query & mutation

query的中文意思是查询,也就对应RESTful标准中的get,而mutation的意思是变更,对应post、delete、patch和put。

connection

connection让你能在同一个请求中查询关联的对象。通过connection,你只需要一个GraphQL请求就可以完成RESTful API中多个请求才能做的事。

比如,GitHub GraphQL API文档中,我们在查询issue对象的同时,还可以查labels对象。

let data = {
  query: `query {
      repository(owner:"simbawus", name: "blog") {
        issue(number: ${articleId}) {
          title
          updatedAt
          bodyHTML
        }
        labels(first: 100){
          nodes{
            name
          }
        }
      }
    }`
};

field

field是你可以从对象中获取的数据单元。正如GraphQL官方文档所说:“GraphQL查询语言本质上就是从对象中选择field”。所有的GraphQL操作必须指明到最底层的field,并且返回值为标量,以确保响应结果的结构明白无误。

argument

argument跟RESTful API标准中一致,表示我们在请求该接口是传的参数,比如上面issue的number 参数,表示请求的第${articleId}个issue。

对于前端来说,在查询GraphQL API的时候基本都要了解上面说的这几个概念,具体应用可参见我的这篇文章如何利用GitHub GraphQL API开发个人博客?。详情代码可查看我的github:simbawus/blog,欢迎star、fork。

GraphQL的未来

GraphQL的优势想必大家都了解了,但为何这么好的技术并没有得到广泛的应用和推广呢?

  1. 要在前端爽爽地使用 GraphQL,必须得在服务端搭建符合 GraphQL spec 的接口,基本上是整个改写服务端暴露数据的方式。痛点是前端的,却要后端来改造,谁会去做?
  2. 改成GraphQL对用户体验来说并没有什么提升,而且对后端水平要求也高,改起来不简单,需要花费大量的时间,老板不用付你工资的吗?
  3. GraphQL意味着一个中心化的API网关,中心化流量要求巨大的中心化集群,技术上运维上又是一个难题。

基于以上,GraphQL目前基本也就一些比较有技术追求和实力的创业公司和一线大厂在使用,希望Facebook能更进一步,给出一个基于云端的解决方案,解放前端。

欢迎讨论,点个赞再走吧~

文章同步于以下社区,可以选一个关注我噢 。◕‿◕。

simbawu | github | segmentfault | 知乎 | 简书 | 掘金

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,387评论 25 707
  • 作者: 一字马胡 转载标志 【2017-11-03】 更新日志 初识GraphQL GraphQL是一种强大的D...
    一字马胡阅读 12,574评论 10 24
  • 有的人活着不清不楚,但至少单纯无害,而又有的人看似正义阳光,实则阴暗卑鄙,让那些少有的看到真相的人不寒而栗,但又无...
    Unfriendly阅读 110评论 0 0
  • 经营华莱事业,沟通,体验是最重要的,同品人和同品人沟通,同龄人与同龄人沟通成功率大。需要联络感情,找到对方的优点。...
    爱可调节心情_冯1393阅读 214评论 0 0
  • 元旦三天假,难得我们家三个人一起出门散步。一路上,街市繁忙,天气温和,走着走着,身上都有些热了。女儿在我和老公...
    寒山君阅读 161评论 0 0