前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >从Rest到Graphql

从Rest到Graphql

原创
作者头像
用户6884826
修改2021-07-08 14:40:17
5111
修改2021-07-08 14:40:17
举报

正文

RestFul的缺陷

假设,此时我们有两个资源分别是Book和Author,这两个资源对应的ER图如下

file
file

相应的API有

POST /books GET /books/{id} POST /authors GET /authors/{id}

我们有一个需求,需要查询id=1的图书信息! 那我们的请求地址是这样的

GET /books/1

返回结果是这样的

代码语言:javascript
复制
[{
    "id": 1,
    "bookname": Harry Potter,
    "price": 56.00,
    "author_id": 2
}]

这时候前端MM拿到这个结果后,傻了眼!这里怎么能直接返回author_id呢,难道直接把author_id显示在界面上么?不可能啊,界面上要显示的是author_name才行!

OK,那么在这种情况下,有两种方式可以解决问题! (1) 跟后端沟通,让他增加一个接口 嗯,我们复习一下什么是VO对象。 VO(View Object):视图对象,用于展示层,它的作用是把某个指定页面(或组件)的所有数据封装起来。 那可以让后端封装一个接口,后端帮你把数据拼装好,提供API如下

GET /bookVOs/1

这样直接返回的结果就是

代码语言:javascript
复制
[{
    "id": 1,
    "bookname": Harry Potter,
    "price": 56.00,
    "author_name": J. K. Rowling
}]

当然,因为你这是临时让后端加接口,可能会有如下情形产生

file
file

OK,回到正题,这样做的缺点主要有两个

前后端强耦合在一起,前端界面发生变动,后端VO对象跟着一起变 如果BookVO对象在手机端、PC端、APP端的显示内容都不一样,你可能在项目中会有BookPcVO类、BookH5VO类、BookAppVO类,VO类大大膨胀!

(2) 自己做适配 这个也很简单,前端获得结果后,取出author_id: 2这条记录,然后再去调用地址

GET /authors/2

得到结果,然后进行组装显示!

当然,这个时候会有如下情形产生(这就是我注孤生的原因!)

file
file

当然,这种做法的缺点也很明显

  • 返回了一堆前端并不需要的数据
  • 徒增前后端的交互次数

ok,通过上面的描述,大家应该能体会到Rest的缺点:REST接口时返回的数据格式、数据类型都是后端预先定义好的,如果返回的数据格式并不是调用者所期望的,调用者在处理上比较麻烦!

那么,有没有办法让前端自定灵活的使用查询语句,自己想捞什么数据就捞什么数据呢? 有的,那就是Graphql!

Graphql的出现

Graphql其实要这样理解 Graphql=grap(图)+query+lanage 是一种基于图的查询语言!那么,这张图长什么样?

OK,首先你要声明一下,你的图结构,嗯,用的就是Graphql的语法啦,像下面这样

代码语言:javascript
复制
type Book {
  id: Int
  bookname: String
  authors: [Author]
}
type Author {
  id: Int
  name: String
  age: String
}
type Query {
  getBook(id: Int): Book
}
schema {
  query: Query
}

对上面的语句进行一下解释。这里一共声明了三个类Book、Author、Query!其实,Book和Author大家都可以猜都出来是指啥,需要注意的一点是authors: [Author]这个地方,用了一个[]的语法,这代表Author是一个数组! 唯一需要说明的是,Query是什么鬼? Query在这儿表明了该类型是这张图的入口,也就是根节点!我们的查询必须从根节点里的属性开始!这里我为了便于说明,只列了一个属性,也就是getBook,该属性是入口,必须从入口开始查!

那么,生成的图是长下面这样的

file
file

这里还有一个Resolver的概念,就是说,GragphQL解析到getBook方法的时候,方法体内容是啥?是在Resovler中定义的,我这里就不贴配置了,感兴趣的可以自己去官网阅读!

OK,接下来就是第二个问题,怎么查? 根据上面我说的,只能从根开始,根是getBook,那语句怎么写呢?如下所示

file
file

那你想加个字段,显示作者名字呢?直接像下面这么写

file
file

采用这种语法结构,后端的数据模型就变成了一张图,前端可以定制化自己的输出结构,同时可以减少前后端的沟通成本,提高灵活性!

一些疑问

(1)java语言中,对Graphql的支持如何? 在java中,有个jar包为graphql-java-tools提供了对Java的支持。 另外,考虑到现在大多是springboot项目,有大神封装好了starter包,供你们的springboot项目使用! 只需在项目中引入

代码语言:javascript
复制
<!-- graphql -->
<dependency>
    <groupId>com.graphql-java</groupId>
    <artifactId>graphql-spring-boot-starter</artifactId>
    <version>4.0.0</version>
</dependency>
<dependency>
    <groupId>com.graphql-java</groupId>
    <artifactId>graphql-java-tools</artifactId>
    <version>4.3.0</version>
</dependency>

即可让你的springboot项目拥有graphql的功能,非常方便!

(2)这样做不会加重前后端工作量么? 说句实在话,摸着良心说,前期确实加重了前后端的工作量! 对前端而言:需要去了解Graphql的语法! 对后端而言:不仅需要了解Graphql的语法,还需要去编写Schema和Resovler!

所以短期内,确实增加了工作量!但是从长远来看,同时降低了前后端的工作量! 第一,前端不用了解后端的数据结构,GraphQL自己生成可交互式的接口文档,前端可以自己测试调用 第二,后端不用在编写什么接口文档,GrapQL自动帮你生成,用起来非常舒心!

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 正文
    • RestFul的缺陷
      • Graphql的出现
        • 一些疑问
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档