GraphQL扫盲

GraphQL 简介

参考资料:

  1. https://juejin.im/post/5d5d2f9ef265da03c02c06ed#heading-25
  2. https://graphql.cn/
  3. https://www.apollographql.com/

实例项目:

  1. https://github.com/ddzyan/graphql-koa-demo

常见依赖模块:

  1. graphql-compose
  2. graphql-compose-mongoose
  3. graphql
  4. apollo-server-koa
  5. dataloader
  6. egg-graphql

是什么

GraphQL 是一种用于 API 的查询语言,对 API 中的数据提供一套易于理解的完整描述,使得客户端能够准确获得它需要的数据,没有任何冗余,也让 API 更容易随着时间推移而演进,还能构建强大的开发者工具(来自官网介绍)

有什么用

在传统 restful 接口开发上,一个功能的开发需要服务端开发人员定义好接口访问方式和返回的消息体,客户端对接后才能进行开发。所有的服务端接口在持续开发中,需要开发人员不断更新迭代,并且同步客户端开发人员保持一致。这当中存在如下问题:

  1. 需要编写接口文档,并且进行单独保存
  2. 在长期开发中需要保障接口文档的一致性
  3. 根据不同版本维护多个 API 文档
  4. 需要描述接口所有可能返回的值

现在可以通过客户端和服务端共享一份数据描述规范:

  1. 数据描述规范也是代码的一部分,参与 API 功能
  2. 数据描述规范本身就是文档,不需要单独编写,维护和迭代
  3. 服务端所有的修改,数据描述规范也将发生变化,无需担心不一致问题
  4. 数据描述规范可以体现应用的结构图,方便客户端快速理解

GraphQL 就是这样的一种数据描述规范

怎么用

数据描述规范包含:数据类型和字段

一个 GraphQL 服务通过定义类数据描述规范创建,然后给数据描述规范的每个类型的每个字段提供解析函数。

GraphQL 的数据描述规范通过 schema 语法编写(schema Definition Language SDL):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
type Query {
book:Book
}

enum BookStatus {
DELETED
NORMAL
}

type Book {
id:ID
name:String!
prire:Float
status:BookStatus
}

解析如下:

  1. Book 称为对象类型 object type
  2. id,name 称为字段 field
  3. ID,String 标量类型 scalar type
  4. enum 枚举类型 enum type
  5. ! 类型描述符 不可为空

特点

SDL 内置了三个特殊的对象类型,分别为:

  1. Query 查询
  2. Mutation 修改
  3. Subscription 定义长链接(不常用)

SDL 有一些基础数据类型如下(支持自定义数据类型):

  1. Int 有符号 32 位整型
  2. Float 有符号双精度浮点型
  3. String UTF-8 字符
  4. Boolean true/false
  5. ID 唯一标识,经常用于重新获取一个对象或缓存的 KEY(重要)

还有一些高级内容如下:

  1. interface
  2. union types
0%