GraphQL的探索之路 – SpringBoot集成GraphQL之Query篇三 - 第316篇

 

相关历史文章(阅读本文之前,您可能需要先看下之前的系列👇

国内最全的Spring Boot系列之三

2020上半年发文汇总「值得收藏」

打破双亲委派【JVM:类加载机制深度剖析】 - 第9篇

JVM整体结构及内存模型【JVM:内存模型深度剖析】 - 第10篇

GraphQL的探索之路 – 一种为你的API而生的查询语言 - 第314篇

GraphQL的探索之路 – SpringBoot集成GraphQL小栗子篇二 - 第315篇

 

师傅:徒儿,研究如何了,看你最近都悠哉悠哉的,没啥动静呐。

悟纤:师傅,徒儿现在那是:了如指掌、一清二楚、一目了然….

 

师傅:不知道你这是自信呐,还是飘了呐?

悟纤:自信如我,快乐前行。

师傅:那好,为师在考考你。

悟纤:尽管放马过来。

师傅:有这么介个问题哦

Q1:对于GraphQL使用curl如何发送请求?

Q2:是否可以建立多个.graphql文件进行管理呐?

Q3:合并查询、复杂查询你懂么?

悟纤:这个嘛…. , 这个嘛….

 

师傅:看来你还是没有研究明白,还不赶紧去搞明白,搞不明白,晚饭就别吃了。

悟纤:┭┮﹏┭┮ ,师傅….. ,我这就去…

章节大纲

  • 多个.graphqls文件探索
  • 如何加注释
  • 使用curl如何进行查询
  • 合并查询
  • 复杂查询

 

 

一、多个.graphqls文件探索

1.1 说明

       我们项目如果有Book和Author的查询的话,那么我们应该不会把配置都放到一个root.graphqls和schema.graphqls文件中吧,这样不利于团队配合开发,那么是否可以book放到book.graphqls中,author放到author.graphqls中呐?

1.2 建立多个.grphqls文件

建立/resources/graphql/author.graphqls,内容如下:

type Author {
    id: Int!
    name: String
    photo: String
}

extend type Query{
    findAuthorById(id: Int!):Author
}

说明:这里使用extend继承Root Query,如果不使用extend的话,多个文件的话就不能都生效了。另外对于类型的声明也移到了一起统一管理。

建立/resources/graphql/book.graphqls,内容如下:

type Book {
    id: Int!
    name: String
    isbn: String
}

extend type Query{
    findBookById(id: Int!):Book
}

       对于root.graphqls和schema.graphqls文件内容为空或者删除掉文件。

1.3 运行测试

       我们这时候启动运行测试,会报一个异常信息:

SchemaClassScannerError: Type definition for root query type 'Query' not found!

       意思我们没有定义Root Query,解决的方式很简单在root.graphqls文件中天极爱一个空的Query即可:

#定义查询的方法
type Query {}

       这时候在运行应该是可以正常运行的,在右侧Query进入可以看到两个Query:

findAuthorById(id: Int!): Author
findBookById(id: Int!): Book

 

二、如何加注释?

       我们在方法也没有注释说明,字段也没有注释说明,肯定不利于前端使用,那么怎么加注释呐,很简单,只要“#注释内容即可”,举例说明:

#作者
type Author {
	#作者的id
    id: Int!
    #作者名称
    name: String
    #作者照片
    photo: String
}

#查询方法
extend type Query{
	#通过作者id进行查询作者的信息
    findAuthorById(id: Int!):Author
}

       重启之后,在图形化界面可以看到我们刚添加的注释了:

(这里截图中的对应的是Int!,不是Long!,这是后期配置文件修改了)

三、使用curl如何进行查询呐?

3.1 说明

       我们已经知道使用图形化界面如何进行查询了,那么如果使用curl如何查询呐?

3.2 分析

       我们观察下浏览器是如何发起请求的:

从这里可以看到好像是发送了一个字符串到后端,然后就可以返回一个json的结果了。

 

3.3 使用curl进行查询

发起请求的指令(mac下):

curl -i -X POST -d  '{"query": "query {findAuthorById(id:1) {id,name}}"}' http://127.0.0.1:8080/graphql

说明:

(1)curl:cURL是一个利用URL语法在命令行下工作的文件传输工具。

(2)-i:显示 http response 的头信息,连同网页代码一起,-I 参数则只显示 http response 的头信息。

(3)-X:指定 HTTP 请求的方法(要大写,举例:POST/GET,错误示例:post/get)。

(4)-d:用于发送 POST 请求的数据体。

 

       执行我们看下帅帅的结果:

       结果是返回了,但是是不是觉得挨着某些不该挨着的信息,看起来很不舒服呀,偷偷告诉你个小技巧,只需要在上面的命令后面加上&& echo,就会换行了,具体命令如下:

curl -i -X POST -d  '{"query": "query {findAuthorById(id:1) {id,name}}"}' http://127.0.0.1:8080/graphql && echo

       这结果看起来是不是很酷,爽歪歪的….

 

四、合并查询

4.1 说明

       我们经常会查询多个接口,然后进行展示的需求。

一种方法就是后端写一个接口,进行查询返回,另外一种方法就是前端调用多个接口进行查询渲染。

 

4.2 GraphQL实现合并查询

当碰上GraphQL就显得很简单了,我们看看如何实现合并查询,只需要需改下GraphQL语句即可:

query{
   findAuthorById(id:1){
    id,
    name
  },
  findBookById(id:1){
    id,
    name,
    isbn
  }
}

       是不是很酷。这里想问下大家,对于前端发起的请求是一次,还是两次呐?(不确定留言区评论,我来告诉你

       另外findAuthorById和findBookById的顺序会影响后端的执行顺序吗(这个是会有影响的,谁在前面,谁先执行)

 

4.2 同名不同字段的时候,结果是什么?

       我们有这么一个指令:

query{
  findAuthorById(id:1){
    id,
    name
	},
  findBookById(id:1){
    id,
    name,
    isbn
  },
  findAuthorById(id:1){
    id,
    photo
  }
}

       大家可以猜想下,这个结果会返回什么,后端执行多少次?

       结果是:后端只会执行两次,结果返回是并集,如下截图:

 

五、复杂查询

5.1 说明

       一般我们的关系是这样子的,一本书会有一个或者n个作者,这里我们假设1个,那么对于我们想要返回author和book信息,怎么操作呢?

 

5.2 第一步:修改java代码建立关系

       对于Book.java中需要增加一个属性Author:

private Author author;

       在BookService中,设置author的值:

public class BookService {
	@Autowired
	private AuthorService authorService;
	
	public Book findById(int id) {
		Book book = new Book();
		book.setId(id);
		if(id==1) {
			book.setName("从零开始学SpringBoot");
			book.setIsbn("9881200");
			book.setAuthor(authorService.findById(1));
		}else if(id==2) {
			book.setName("JVM性能调优");
			book.setIsbn("9881201");
			book.setAuthor(authorService.findById(2));
		}
		return book;
	}
}

这里的demo没有使用数据源,都是直接本地构建的对象,实际中,换成数据库库的查询即可。

5.3 第二步:修改graphqls文件

       修改book.graphqls文件type Book添加author属性:

#书本信息
type Book {
	#书本id
    id: Int!
    #书本名称
    name: String
    #书本isbn编码
    isbn: String
    #作者
    author:Author
}

       如果是多个作者的话,java中使用List<Author>,配置文件使用[Author]定义即可。

5.4 第三步:GraphQL语句

       到这里就可以使用GraphQL语句查询下了:

要返回啥字段还是你说的算,如果不想要返回author,只要不配置就可以了。

悟纤小结

悟纤:探着,探着,就弹多了,今天就先到这里吧,还有一小部分内容:修改怎么玩以及GraphQL的配置文件、还有就是****。我们对本节做个总结吧:

(1)要知道多个.graphqls要怎么操作,核心就是extend type Query;

(2)注释可以使用“#注释信息“进行说明,这样在使用GraphiQL的时候,就可以看到字段的注释说明了,避免了和前端的沟通。接口注释 、属性注释,一个都不能少,妈妈再也不用担心我不能回家吃饭了。

(3)使用curl进行查询,发起一个POST的 带有一个GraphQL语句的字符串即可。另外分享了一个小技巧:在命令之后加上&&echo可以换行哦

(4)合并查询和复杂查询:这些本身就是GraphQL的特点,知道有这些特点即可。

 

 

悟纤 CSDN认证博客专家 Spring Spring Boot
「公众号SpringBoot」:
①阿里巴巴前高级研发工程师;②估值20亿美金的Blued架构师;③北京知远公司创始人;④浙江甄才公司架构师;⑤云课堂学员10000+;⑥博客访问量1000万+;⑦10年互联网行业从业;⑧340万的访问《从零开始学SprngBoot》作者;⑨技术加盟多个独立项目。
©️2020 CSDN 皮肤主题: 酷酷鲨 设计师:CSDN官方博客 返回首页
实付 19.89元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值