Graphql入门

GraphQL是一个查询语言，由Facebook开发，用于替换RESTful API。服务端可以用任何的语言实现。具体的你可以查看Facebook关于GraphQL的文档和各种语言的实现

GraphQL的小历史

早在2012年，Facebook认为人们只有在离开PC的时候才会用智能手机，很快他们就发现这个认识是多么的错误！于是Facebook把注意力从Web移到了智能终端上。在那个时候，他们严重的依赖于RESTful API。大量的并发请求和对补充数据的二次请求给他们造成了很大的麻烦，尤其是响应时间。一个解决方案是设计足够多的资源来满足单次的请求。但是，这造成了服务端的扩展和维护困难。

在寻找更好的解决方案的过程中，Facebook的工程师发现开发人员不应该先入为主的把数据看成RESTful一样的集合。如何更好地存储和获取数据不应该是他们要主要考虑的内容。他们应该更多的考虑数据的关系，网状的关系。

在这个情况下GraphQL应运而生。

GraphQL工作机制

一个GraphQL查询可以包含一个或者多个操作（operation），类似于一个RESTful API。操作（operation）可以使两种类型：查询（Query）或者修改（mutation）。我们看一个例子：

query {client(id: 1) {id
name
}
}

你的第一印象：“这个不是JSON？”。还真不是！就如我们之前说的，GraphQL设计的中心是为客户端服务。GraphQL的设计者希望可以写一个和期待的返回数据schema差不多的查询。

注意上面的例子有三个不同的部分组成:

client是查询的operation
(id: 1)包含了传入给Query的参数
查询包含id和name字段，这些字段也是我们希望查询可以返回的

我们看看server会给这个查询返回什么：

{"data": {"client": {"id": "1",
"name": "Uncle Charlie"
}
}
}

就如我们期望的，server会返回一个JSON串。这个JSON的schema和查询的基本一致。

我们再看看另一个例子：

query {products(product_category_id: 1, order: "price DESC") {name
shell_size
manufacturer
price
}
}

这次我们查询products，并传入两个参数：product_category_id用于过滤，一个指明按照price字段降序排列。查询中包含的字段是：name、shell_size、manufacturer和price）。

你可能已经猜到返回的结果是什么样子的了：

{"data": {"products": [
{"name": "Mapex Black Panther Velvetone 5-pc Drum Shell Kit",
"shell_size": "22\"x18\" Bass Drum, 10\"x8\" & 12\"x9\" Toms, 14\"x14\" & 16\"x16\" Floor Toms",
"manufacturer": "Mapex",
"price": 2949.09
},
{"name": "Pearl MCX Masters Natural Birdseye Maple 4pc Shell Pack with 22\" Kick",
"shell_size": "22x18\" Virgin Bass Drum 10x8\" Rack Tom 12x9\" Rack Tom 16x16\" Floor Tom",
"manufacturer": "Pearl",
"price": 1768.33
}
]
}
}

从这几个初级的例子里你可以看出来GraphQL允许客户端明确指定它要的是什么，避免了数据后去的冗余或者不足。和RESTful API对比一下，每一个客户端都会对应很多个RESTful API或者一个API要服务很多个客户端。所以说GraphQL是很好的查询语言。所有的operation、参数和所有可以查询的字段都需要在GraphQL server上定义、实现。

GraphQL还解决了另外一个问题。假设我们要查询product_categories和相关的products。在一个RESTful server上你可以实现一个API，返回全部的数据。但是，大多数的情况下，客户端会先请求product_categories之后在其他的请求中获取相关的某些products。

我们看看使用GraphQL可以怎么做：

query {product_categories {name
products {name
price
}
}
}

我们这一次没有使用参数。在查询中我们指定了我么需要每一个product_category的name，还有所有的这个类别下的产品，每个产品的字段也都分别指定。返回的结果：

{"data": {"product_categories": [
{"name": "Acoustic Drums",
"products": [
{"name": "Mapex Black Panther Velvetone 5-pc Drum Shell Kit",
"price": 2949.09
},
{"name": "Pearl MCX Masters Natural Birdseye Maple 4pc Shell Pack with 22\" Kick",
"price": 1768.33
}
]
},
{"name": "Cymbals",
"products": [
{"name": "Sabian 18\" HHX Evolution Crash Cymbal - Brilliant",
"price": 319
},
{"name": "Zildjian 20\" K Custom Dry Light Ride Cymbal",
"price": 396.99
},
{"name": "Zildjian 13\" K Custom Dark Hi Hat Cymbals",
"price": 414.95
}
]
}
]
}
}

查询的嵌套没有限制，全看我们的查询和server的实现。比如西面的例子完全合法：

{purchases(client_id: 1) {date
quantity
total
product {name
price
product_category {name
}
}
client {name
dob
}
}
}

这里我们请求server返回某个客户的purchases。查询里不仅指定了purchase的字段，还指定了相关的product，product_category的名称。

GraphQL有非常重要的一个特点：强类型。

每一个GraphQL server都要定义类型系统。查询实在这个类型系统的上下文中执行的。

也就是说，你可以查询值类型：Int, Float, String, Boolean和ID。

而上例中的purchase里的字段，product、client和product_category都是对象类型（Object Type）的。这些类型都需要我们自己定义。

由于GraphQL查询都是结构化的，信息也是类树结构展示的。值类型（Scalar Type）的可以理解为叶子，对象类型（Object Type）可以理解为树干。

操作（Operation）和字段别名

在GraphQL查询中可以为Operation里的字段指定别名。比如查询里指定了字段cymbal_size，但是客户端只能接受diameter。另外查询的返回结果都包含在以operation名称为key的对象里，所以这个名称也可以设置一个别名：

{my_product: product(id: 3) {id
name
diameter: cymbal_size
}
}

返回的数据：

{"data": {"my_product": {"id": "3",
"name": "Zildjian 13\" K Custom Dark Hi Hat Cymbals",
"diameter": "13\""
}
}
}

Fragments

现在，客户端APP要获取另个分开的list： drum sets和cymbals。在GraphQL里你不会被限制在一个operation里。同时我们也可以像设置字段别名那样设置返回结果的别名：

query {drumsets: product(product_category_id: 1) {id
name
manufacturer
price
pieces
shell_size
shell_type
}
cymbals: products(product_category_id: 2) {id
name
manufacturer
price
cymbal_size
}
}

你可能已经注意到，在查询的两个对象中都包含了字段：id、name、manufacturer、price。

为了避免重复字段，我们可以使用GraphQL提供的Fragments。我们来把重复的字段都提出来，放到一个fragment里：

query {drumsets: products(product_category_id: 1) {...ProductCommonFields
prices
shell_size
shell_type
}
cymbals: products(product_category_id: 2) {...ProductCommonFields
cymbal_size
}
}
fragment ProductCommonFields on Product {id
name
manufacturer
price
}

要使用一个Fragment就使用操作符：...。

变量（Variable）

我们要减少查询语句中的重复，我们来看看另外的一个例子该如何处理：

client(id: 1) {name
dob
}
purchasses(client_id: 1) {date
quantity
total
product {name
price
product_category {name
}
}
client {name
dob
}
}

我们使用两个operation查询server，并且每个都包含了client_id参数。如果可以把这个集中到一起就非常好了。我们可以使用GraphQL的变量来实现这个效果。我们来添加一个clientID变量。

query($clientId: Int) {client(id: $clientId) {name
dob
}
purchases(client_id: $clientId) {date
quantity
total
product {name
price
product_category {name
}
}
client {name
dob
}
}
}

我们在operation的前面定义了变量，然后我们就可以在整个查询中使用这个变量了。 为了使用变量的定义，我们需要在查询的时候附带变量值的JSON。

{"clientId": 1
}

当然，我们也可以指定一个默认值：

query ($date: String = "2017/01/28") {purchases(date: $date) {date
quantity
total
}
}

Mutation（修改）

GraphQL不仅可以用来查询数据，也可以创建、更新和销毁数据。当然和查询一样，这些也需要server端有对应的实现。增、删、改一类的operation在GraphQL里统称为Muration（修改）。我们就通过几个例子来演示一下mutation。

mutation {create_client (
name: "查理大叔"
dob: "2017/01/28"
) {id
name
dob
}
}

我们现在指定operation的类型为mutation，而不是query。在create_client操作里我们传入了创建一个client需要的数据，并最终返回一个查询集合：

{"data": {"create_client": {"id": "5",
"name": "查理大叔",
"dob": "2017/01/28"
}
}
}

上面的数据有一点错误，生日不对。下面就来用更新来fix这个错误：

mutation {update_client (
id: 5
dob: "1990/01/01"
) {id
name
dob
}
}

最后，如果我们要删除这个数据可以这样：

mutation {destroy_client(id: 5) {name
dob
}
}

注意：create_client、update_client和destroy_client这些operation都是在GraphQL server实现好的。如果有什么方法可以知道GraphQL server都实现了什么方法不是很好，是的有GraphQL的doc可以查看。

定义说明

GraphQL的一个非常好的特性就是，它会根据已经定义好的类型系统来自动生成出一个说明文档。这样你就不用一次一次的翻看代码，而直接查看文档来了解operation的全部实现细节。如果你用的是express-graphql, 并设置graphiql为true的话，那么就会生成一个web的调试界面。在最右侧可以直接使用doc：

app.use('/mobile/egoods', graphqlHTTP({schema: schema,
rootValue: root,
graphiql: true,
pretty: IS_DEVELOPMENT,
}))

或者，也可以使用对于应定义好的schema的查询，如：

{__schema {queryType {name
fields {name
}
}
}
}

结果为：

{"data": {"__schema": {"queryType": {"name": "Query",
"fields": [
{"name": "client"
},
{"name": "clients"
},
{"name": "product"
},
{"name": "product_categories"
},
{"name": "product_category"
},
{"name": "products"
}
]
}
}
}
}

对于mutation类型的操作也是一样的:

{__schema {mutationType {name
fields {name
}
}
}
}

查询的结果为：

{"data": {"__schema": {"mutationType": {"name": "Mutation",
"fields": [
{"name": "create_client"
},
{"name": "destroy_client"
},
{"name": "update_client"
}
]
}
}
}
}

就像上文展示的一样，你还可以查询很多其他的内容。比如：

{__schema {queryType {name
fields {name
args {name
}
}
}
}
}

我们来简单的看看结果是什么样的：

{"data": {"__schema": {"queryType": {"name": "Query",
"fields": [
{"name": "clients",
"args": [
{"name": "ids"
},
{"name": "name"
},
{"name": "dob"
}
]
},
{...
},
{"name": "products",
"args": [
{"name": "ids"
},
{"name": "product_category_id"
},
{"name": "order"
},
{"name": "limit"
}
]
}
]
}
}
}
}

你会看到server实现了一个clients的查询operation，参数为ids、name和dob。第二个操作是products，在这里的参数是ids、product_category_id和order、limit。

最后

GraphQL可以让我们定义更加便捷的查询Server。如果你有兴趣学习的话，我强烈的建议你可以读一读GraphQL的定义说明，然后试着自己实现一个GraphQL server。

Graphql入门_1相关推荐

GraphQL 入门第一篇
GraphQL 入门在接下来的一系列文章中,我们会了解 GraphQL 是什么,它是如何运作以及如何使用它.在找如何搭建 GraphQL 服务的文档?这有一些类库可以帮你用多种不同语言实现 Grap ...
graphql入门_GraphQL入门指南
graphql入门 by Leonardo Maldonado 莱昂纳多·马尔多纳多(Leonardo Maldonado) GraphQL入门指南 (A Beginner's Guide to Gr ...
GraphQL 入门
## GraphQL 入门 GraphQL 是一个用于 API 的查询语言,是一个使用基于类型系统来执行查询的服务端运行时(类型系统由你的数据定义).GraphQL 并没有和任何特定数据库或者存储引擎 ...
【ReactJs+springBoot项目——租房】第3章：OSS存储图片+本地存储+ 房源列表查询+GraphQL入门
图片存储解决方案的分析阿里云OSS存储方案的实现本地存储方案的实现整合前端系统实现图片上传功能实现房源列表查询功能 GraphQL的入门 1.图片存储解决方案在新增房源中, ...
GraphQL入门基础篇教程
历史 GraphQL是由Facebook创造的. 当时,Facebook想在移动端实现新闻推送,这不像检索一个故事.作者.故事的内容.评论列表和喜欢该文章的人这么简单,而是每个故事都相互 ...
GraphQL入门之工程搭建
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://mave ...
GraphQL入门之graphql-java项目的介绍
GraphQL的Java实现通过前面的讲解,我们对GraphQL有了解,官方只是定义了规范并没有做实现,就需要有第三方来进行实现了,关于GraphQL的java实现有几种,我们选择使用官方推荐的实现 ...
GraphQL入门之Schema和类型规范
GraphQL的Schema 和类型规范 Schema 是用于定义数据结构的,比如说,User对象中有哪些属性,对象与对象之间是什么关系等. 参考官网文档:http://graphql.cn/lear ...
GraphQL入门之GraphQL查询的规范
GraphQL查询的规范 GraphQL定义了一套规范,用来描述语法定义,具体参考:http://graphql.cn/learn/queries/ 说明:仅仅是规范,并不是具体实现,需要各种语言进行 ...

Graphql入门_1