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

GraphQL简介

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

GraphQL由Facebook开发,始于2012年,2015年公开。github

GraphQL牛逼之处是它可让客户端精确的查询它们想要的,不附加额外的东西,这样的话就很容易让客户端随着API的演进去使用。web

例子

下面是一个简单的例子,这是一个GraphQL的查询:工具

{ person { name email } }

而这个查询的响应结果是:测试

{ "data": { "person": { "name": "Dave", "email": "331335713@qq.com" } } }

能够看到响应结果和查询请求的内容结构几乎是彻底同样的。若是你须要person其它的信息,例如parents,那么在查询中加上这个属性便可:spa

{ person { name email parents { name } } }

它的响应会像这样:命令行

{ "data": { "person": { "name": "Dave", "email": "331335713@qq.com", "parents": [ { "name": "Nick" }, { "name": "AJ" }, { "name": "Brian" } ] } } }

在ASP.NET Core中支持GraphQL

GraphQL的查询一般会被发送到一个特定的GraphQL端点。在这个端点,会处理请求查询并返回GraphQL对象结果。3d

创建项目

下面咱们就在ASP.NET Core中实现这个功能,首先创建项目: 
使用dotnet cli 在命令行输入:code

dotnet new web --name graph

这样会创建一个ASP.NET Core 的空项目。项目结构如图: 
图片描述中间件

创建Model

而后创建一个Person 的Model: 
图片描述

创建Repository

下面创建用于查询Person的Repository,首先是接口: 
图片描述

而后是具体的Repository,里面带有一些写死的数据: 
图片描述

添加GraphQL库

经过dotnet cli添加GraphQL这个库:

dotnet add package GraphQL

安装成功后,在项目文件里会有显示: 
图片描述

创建GraphQL中间件

首先我须要一个GraphQL特定的Person类型类,它要包含映射到Person类的字段: 
图片描述
该类须要继承于ObjectGraphType< Person>。

而后我还须要一个查询类,它里面包含对GraphQL实现的细节: 
图片描述
该类须要继承于 ObjectGraphType。在这里,我把全部请求查询的字段映射到了PersonRepository的调用上。

最后是中间件: 
图片描述
图片描述
该类的意思就是,当请求地址是"/graphql"开头时,就会尝试读取请求的body。而后创建一个Schema对象,它的query字段的值就是PersonQuery的实例,而PersonQuery的实例又须要PersonRepository做为参数。 
最后创建一个DocumentExecuter来对这个schema进行查询,结果以JSON格式返回。

注册Repository,使用中间件

别忘了在Startup.cs里注册Repository和在管道里调用咱们的中间件: 
图片描述

测试

运行ASP.NET Core项目:

dotnet watch run

图片描述

打开POSTMAN,首先按id查询一个Person: 
图片描述
Cool,没问题。

再来一个带Parents的查询: 
图片描述

最后再查询全部的Person吧: 
图片描述

注意这里的查询写的是persons而不是person,这个要和PersonQuery类里面的定义一致。

结语

这只不过是使用ASP.NET Core支持GraphQL的一个原始手动实现而已。 具体请看graphql-dotnet:https://github.com/graphql-dotnet/graphql-dotnet。 

相关文章
相关标签/搜索