欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

程序员文章站 2024-01-13 12:04:46
为了介绍使用ASP.NET Core构建GraphQL服务器,本文需要介绍一下GraphQL,其实看官网的文档就行。 什么是GraphQL? GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。 GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述,使得客 ......

为了介绍使用asp.net core构建graphql服务器,本文需要介绍一下graphql,其实看官网的文档就行。

 

什么是graphql?

graphql 既是一种用于 api 的查询语言也是一个满足你数据查询的运行时。 graphql 对你的 api 中的数据提供了一套易于理解的完整描述,使得客户端能够准确地获得它需要的数据,而且没有任何冗余,也让 api 更容易地随着时间推移而演进,还能用于构建强大的开发者工具。

 

官网地址:

中文网址(感觉不是官方的,连https都不是):

graphql来自facebook,它于2012年开始开发,2015年开源。

 

graphql与编程语言无关,可以使用很多种语言/框架来构建graph 服务器,包括.net core。

像github,pinterest,coursera等公司都在使用graphql。

 

github的api到目前有4个版本,第三个版本都是用的是rest,而第四个版本使用的是graphql。

 

graphql到底是什么?

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

这就是一个graphql查询的例子。左边是查询,右边是结果。

从这个例子可以看出,查询是可以嵌套的,所以使用graphql的客户端可以通过一次请求获得所有需要的数据

 

每当对graphql服务器进行查询的时候,这些查询首先都会依据一个类型系统对其进行验证。每个graphql服务都会在graphql schema里定义类型信息。

可以把这个类型系统看作是你的api数据的蓝本,它由你定义的一系列对象所支撑。

例如这个user对象:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

 

graphql经常被称作是一个:声明式数据获取语言。

 

graphql的设计原则

  • 分层结构:graphql的查询是有层次结构的,字段可以内嵌其它字段;查询和返回数据的结构是一致的。
  • 以产品中心:graphql是由客户端所需要的数据所驱动,语言和运行时也支持客户端。
  • 强类型:graphql服务器由graphql类型系统所支撑。在schema里,每个数据点都有一个特定的类型,针对这个类型还有验证。
  • 客户端定制查询:graphql服务器提供了可以让客户端进行定制查询的能力。
  • 内省(introspective):客户端可以查询graphql服务器的类型系(schema)。

 

为什么使用graphql?

谈起graphql,总是离不开rest。

如果您想了解rest in asp.net core,请看我写的这个系列文章:

rest有几个问题:

过度获取:rest里get请求的查询结果通常比较大,并且超过了客户端的需求:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

这里我只需要name,height,和mass,但是却返回了所有的字段。

 

而使用graphql,我只需要查询我需要的数据:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

 

获取不足:使用rest时,我想获取部门和部门的人员,通常我需要先请求查询部门列表;然后遍历返回的部门列表,再次发出请求查询每个部门下的人员,所以是n+1查询。

而使用graphql,我就可以通过一个查询请求(嵌套的)取得相应的结果。

 

不灵活:随着api的演进,rest需要随时创建新的端点,所以rest api的端点增长速度很快;此外有版本和兼容性需要谨慎考虑。

而graphql,典型的结构是只有一个端点。这个单端点就像api网关一样组织了多个数据源,这样就会更简单。

 

综上,使用graphql的好处是:

  • 避免多重rest请求
  • 向下兼容,无需考虑版本
  • 可以对现有的数据源(例如rest api)进行包装
  • 与开发语言无关

 

graphql查询

我通过github的graphql explorer来进行演示,网址是:

登录之后,其效果如下:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

github使用了graphiql,graphiql是一个浏览器内的ide,它可以用来浏览和查询graphql。

graphiql的网址是:。

下一篇文章,我也会在.net项目里安装这个graphiql。

graphiql只是用来浏览查询graphql的一个浏览工具而已,其它比较流行的工具还包括graphql playground 和 graphql voyager等。

 

第一个查询

打开github的graphiql以后,自动加载了一个查询语句,我们点击运行按钮,右侧就会返回查询的结果:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

 

在这里,我查询了浏览者 viewer这个字段,当前浏览该网页的就是我自己;在查询里我还包括了viewer下的login字段,也就是登录名。

结果以json形式返回,其数据包含在data属性下,结构和查询结构一致。

 

如果我还想在查询中包含浏览者的姓名,那就加一个字段即可:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

 

graphql的查询也可以有注释:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

 

graphiql的智能提示

graphiql是具有智能提示的功能的。当你输入一个字母之后,就是这种效果:

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

 

如果你什么都不输入,还想知道有哪些字段,那么就按alt+空格

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

但是在windows上多少还是有些问题的,因为alt+空格也会弹出浏览器的菜单