GraphQL on Rails(一) GraphQL介绍

GraphQL

GraphQL按照官方的说法它是一门声明式的查询语言,实际上它是领域特定查询语 DSQL,它通过定义的schema系统将复杂的逻辑拆分成细粒度的数据结构,来让前端应用的开发者能够通过GraphQL提供的类型查询系统,自由定制请求数据的能力。

GraphQL与RESTful

目前大多数应用的API采用的都是流行的RESTful API,但是对于很多需求变更频繁的,数据查询颗粒的小的应用来说,使用RESTful的API总是在不断的迭代,不断的更新版本。这会导致应用的API系统过于复杂,而且通常最后又大量冗余的API进而变动难以维护。

“The REST interface is designed to be efficient for large-grain hypermedia data transfer…” - Dr Roy T Fielding, Author of REST

其实REST本身更适合数据力度大,需求变更不频繁的应用场景,而在细粒度的应用场景下的解决方案,在Facebook的复杂系统中应运而生,GraphQL被用于解决细粒度的API问题已经3年多了,处理了260多亿次的请求,这注意证明它在真实的场景下是经得起考验的。

整个GraphQL的核心就是一个类型定义系统,通过定义各种可能的查询类型和所有的返回数据的类型,来构建一个查询系统,让客户端通过统一的查询语言,来对系统中的类型进行匹配,并最终返回,相匹配的数据。

GraphQL 由以下组件构成:

  • 类型系统(Type System)
  • 查询语言(Query Language)
  • 执行语义(Execution Semantics)
  • 静态验证(Static Validation)
  • 类型检查(Type Introspection)

类型

GraphQL中类型系统是最重要的组成部分之一,其中提供的类型分为两种,一种是标量类型,用于表示最细粒度的类型,这些类型基本可以和JavaScript,Ruby及其他通用编程语言对应上。
标量类型:

  • Int : 整数,对应 JavaScript 的Number
  • Float :浮点数,对应 JavaScript 的 Number
  • Boolean:布尔值,对应 JavaScript 的 Boolean
  • String : 字符串,对应 JavaScript 的 String
  • ID : D 值,是一个序列化后值唯一的字符串,可以视作对应 ES 2015 新增的 Symbol

其他的高级类型:

  • Object : 对象类型 ,用于表示GraphQL返回类型树的中间层级,标量类型表示的都是叶子节点,在GraphQL基本上所以的类型都是Object类型,它包含有一个name字段来描述定义的类型和fields字段描述该类型的完整数据结构。
var AddressType = new GraphQLObjectType({
    name: 'Address',
    fields: {
      street: { type: GraphQLString },
      number: { type: GraphQLInt },
      formatted: {
        type: GraphQLString,
        resolve(obj) {
          return obj.number + ' ' + obj.street
        }
      }
    }
});
  • Interface : 接口类型 用于描述多个类型中通用的字段
var EntityType = new GraphQLInterfaceType({
    name: 'Entity',
    fields: {
      name: { type: GraphQLString }
    }
});
  • Union : 联合 它有点像可选类型,用于表示这一个字段可能是一个类型集合下的某一种类型。
var PetType = new GraphQLUnionType({
    name: 'Pet',
    types: [DogType, CatType],
    resolveType(value) {
      if (value instanceof Dog) {
        return DogType;
      }
      if (value instanceof Cat) {
        return CatType;
      }
    }
});
  • Enum :枚举类型
var RGBType = new GraphQLEnumType({
    name: 'RGB',
    values: { 
      RED: { value: 0 },
      GREEN: { value: 1 },
      BLUE: { value: 2 } 
    }
});
  • List : 列表类型
var PersonType = new GraphQLObjectType({
   name: 'Person',
    fields: () => ({
      parents: { type: new GraphQLList(Person) },
      children: { type: new GraphQLList(Person) },
    })
});
  • Non-Null : 不为空类型,用于表示返回的字段不为空,如果为空就会发生异常,可用于数据库的主键。
var RowType = new GraphQLObjectType({
    name: 'Row',
    fields: () => ({
      id: { type: new GraphQLNonNull(GraphQLString) }
    })
});

查询

GraphQL的客户端,是通过一个查询字符串通过,GraphQL服务可以解析验证并执行这样的查询请求字符串,一个查询字符串有两部分组成:操作(Operation)和片段(Fragments) 一个 query 可以包含多个操作和片段。只有包含操作的 query 才会被 GraphQL 服务执行。但是不包含操作,只有片段的 query 也会被 GraphQL 服务解析验证,这样一份片段就可以在多个 query 文档内使用。

GraphQL 规范支持两种操作:

let schema = new GraphQLSchema({ query: UserType mutation: UpdateAgeType});
  • query:仅获取数据(fetch)的只读请求
query {
    user(id: 3500401) {
      id,
      name,
      age
    }
}
  • mutation:获取数据后还有写操作的请求
mutation {
    updateAage
}

其中GraphQL对数据的修改称为mutation ,它在GraphQL的查询系统中是按照顺序序列化执行的。

查询请求模型:


总结

GraphQL在技术上提供了区别于REST的解决方案,很好的解决了数据细粒度频繁变更的问题,使得数据和接口得到了解绑,在生态圈方便面,现已经有很多语言的GraphQL实现(Python 、Ruby 等)可以参见 GraphQL Awesome list。在应用方面虽然是2015年才被Facebook公布并且开源的,但是它已经在Facebook的应用系统中工作了快四年之久。而且现在不少国内的团队(比如淘宝)也已经在使用GraphQL构建应用系统的API,这些都足以证明这项技术的市场和潜力了。

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

推荐阅读更多精彩内容