为了介绍使用ASP.NET Core构建GraphQL服务器,本文需要介绍一下GraphQL,其实看官网的文档就行。

什么是GraphQL?

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

官网地址:https://graphql.org/

中文网址(感觉不是官方的,连HTTPS都不是):http://graphql.cn/

GraphQL来自Facebook,它于2012年开始开发,2015年开源。

GraphQL与编程语言无关,可以使用很多种语言/框架来构建Graph 服务器,包括.NET Core。

像Github,Pinterest,Coursera等公司都在使用GraphQL。

Github的API到目前有4个版本,第三个版本都是用的是REST,而第四个版本使用的是GraphQL。

GraphQL到底是什么?

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

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

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

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

例如这个User对象:

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

GraphQL的设计原则

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

为什么使用GraphQL?

谈起GraphQL,总是离不开REST。

如果您想了解REST in ASP.NET Core,请看我写的这个系列文章:https://www.cnblogs.com/cgzl/p/9178672.html#rest

REST有几个问题:

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

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

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

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

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

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

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

综上,使用GraphQL的好处是:

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

GraphQL查询

我通过Github的GraphQL Explorer来进行演示,网址是:https://developer.github.com/v4/explorer/

登录之后,其效果如下:

Github使用了graphiql,graphiql是一个浏览器内的IDE,它可以用来浏览和查询GraphQL。

graphiql的网址是:https://github.com/graphql/graphiql

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

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

第一个查询

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

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

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

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

GraphQL的查询也可以有注释:

GraphiQL的智能提示

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

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

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

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)的更多相关文章

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

    上一篇文章:https://www.cnblogs.com/cgzl/p/9734083.html 处理数据 嵌套字段 看例子: 我想查看viewer下的repositories.注意里面的edges ...

  2. 【视频】使用ASP.NET Core开发GraphQL服务

    GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时. GraphQL来自Facebook,它于2012年开始开发,2015年开源. GraphQL与编程语言无关,可以使用很 ...

  3. 记:ASP.NET Core开发时部署到IIS上出现HTTP Error 502.5 - Process Failure的解决方案

    HTTP Error 502.5 - Process Failure Common causes of this issue: The application process failed to st ...

  4. ASP.NET Core 开发-中间件(StaticFiles)使用

    ASP.NET Core 开发,中间件(StaticFiles)的使用,我们开发一款简易的静态文件服务器. 告别需要使用文件,又需要安装一个web服务器.现在随时随地打开程序即可使用,跨平台,方便快捷 ...

  5. 使用ASP.NET Core支持GraphQL -- 较为原始的方法

    GraphQL简介 下面是GraphQL的定义: GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时. GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述 ...

  6. ASP.Net Core开发(踩坑)指南

    ASP.NET与ASP.NET Core很类似,但它们之间存在一些细微区别以及ASP.NET Core中新增特性的使用方法,在此之前也写过一篇简单的对比文章ASP.NET MVC应用迁移到ASP.NE ...

  7. C# -- HttpWebRequest 和 HttpWebResponse 的使用 C#编写扫雷游戏 使用IIS调试ASP.NET网站程序 WCF入门教程 ASP.Net Core开发(踩坑)指南 ASP.Net Core Razor+AdminLTE 小试牛刀 webservice创建、部署和调用 .net接收post请求并把数据转为字典格式

    C# -- HttpWebRequest 和 HttpWebResponse 的使用 C# -- HttpWebRequest 和 HttpWebResponse 的使用 结合使用HttpWebReq ...

  8. windows/Linux下设置ASP.Net Core开发环境并部署应用

    10分钟学会在windows/Linux下设置ASP.Net Core开发环境并部署应用 创建和开发ASP.NET Core应用可以有二种方式:最简单的方式是通过Visual Studio 2017 ...

  9. 使用ASP.NET Core支持GraphQL( restful 配套)

    https://github.com/graphql-dotnet https://github.com/graphql GraphQL简介 官网:https://graphql.cn/code/ 下 ...

随机推荐

  1. Eureka-服务注册与发现组件

    一.Eureka是Netflix开发的服务组件 本身是一个基于REST的服务,Spring Cloud将它集成在其子项目spring-cloud-netflix中,以实现Spring cloud的服务 ...

  2. 实现自动SSH连接

    #!/usr/bin/expect set timeout 10 set username [lindex $argv 0] set password [lindex $argv 1] set hos ...

  3. 大数据小视角2:ORCFile与Parquet,开源圈背后的生意

    上一篇文章聊了聊基于PAX的混合存储结构的RCFile,其实这里笔者还了解一些八卦,RCfile的主力团队都是来自中科院的童鞋在Facebook完成的,算是一个由华人主导的编码项目.但是RCfile仍 ...

  4. Git----GitHub Desktop的入门及使用

    1.git和GitHub的区别: 简单回答:球和球场的关系(知乎答案,觉得简单易懂) 详细介绍:git是一个版本控制工具 github是一个用git做版本控制的项目托管平台. 2.安装本地github ...

  5. Spring 系列之Spring常用注解总结

    传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.实物,这么做有两个缺点: 1.如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml文 ...

  6. 从YOLOv1到v3的进化之路

    引言:如今基于深度学习的目标检测已经逐渐成为自动驾驶,视频监控,机械加工,智能机器人等领域的核心技术,而现存的大多数精度高的目标检测算法,速度较慢,无法适应工业界对于目标检测实时性的需求,这时YOLO ...

  7. Android缓存机制——LruCache

    概述 LruCache的核心原理就是对LinkedHashMap的有效利用,它的内部存在一个LinkedHashMap成员变量,值得注意的4个方法:构造方法.get.put.trimToSize LR ...

  8. sum() 函数性能堪忧,列表降维有何良方?

    本文原创并首发于公众号[Python猫],未经授权,请勿转载. 原文地址:https://mp.weixin.qq.com/s/mK1nav2vKykZaKw_TY-rtw Python 的内置函数 ...

  9. 零基础怎么学java

    首先告诉你的是,作为一个初学者想转行学习Java并不是很容易,Java本身是具有一定难度的,虽然说兴趣这东西可以让我们学习不累,但是有多少人学习是因为兴趣,或者有多少人知道自己的兴趣在哪?所以我很明确 ...

  10. mysql报错mmap(137428992 bytes) failed; errno 12,Cannot allocate memory for the buffer pool

    mysql以`systemctl start mysqld.service`的方式启动一段时间后发现突然无法启动,尝试重新启动也不能解决问题,排查问题时,先后通过`systemctl status m ...