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

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

程序员文章站 2024-01-04 16:37:10
GraphQL简介 下面是GraphQL的定义: GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。 GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述,使得客户端能够准确地获得它需要的数据,而且没有任何冗余,也让 API 更容易地随着时间推移而演进, ......

graphql简介

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

graphql由facebook开发,始于2012年,2015年公开。

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

例子

下面是一个简单的例子,这是一个graphql的查询:

{
  person  {
    name
    email
  }
}

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

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

可以看到响应结果和查询请求的内容结构几乎是完全一样的。如果你需要person其它的信息,例如parents,那么在查询中加上这个属性即可:

{
  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对象结果。

建立项目

下面我们就在asp.net core中实现这个功能,首先建立项目: 
使用dotnet cli 在命令行输入:

dotnet new web --name graph

这样会建立一个asp.net core 的空项目。项目结构如图: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

建立model

然后建立一个person 的model: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

建立repository

下面建立用于查询person的repository,首先是接口: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

然后是具体的repository,里面带有一些写死的数据: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

添加graphql库

通过dotnet cli添加graphql这个库:

dotnet add package graphql

安装成功后,在项目文件里会有显示: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

建立graphql中间件

首先我需要一个graphql特定的person类型类,它要包含映射到person类的字段: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法
该类需要继承于objectgraphtype< person>。

然后我还需要一个查询类,它里面包含对graphql实现的细节: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法
该类需要继承于 objectgraphtype。在这里,我把所有请求查询的字段映射到了personrepository的调用上。

最后是中间件: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法
使用ASP.NET Core支持GraphQL -- 较为原始的方法
该类的意思就是,当请求地址是"/graphql"开头时,就会尝试读取请求的body。然后建立一个schema对象,它的query字段的值就是personquery的实例,而personquery的实例又需要personrepository作为参数。 
最后建立一个documentexecuter来对这个schema进行查询,结果以json格式返回。

注册repository,使用中间件

别忘了在startup.cs里注册repository和在管道里调用我们的中间件: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

测试

运行asp.net core项目:

dotnet watch run

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

打开postman,首先按id查询一个person: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法
cool,没问题。

再来一个带parents的查询: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

最后再查询所有的person吧: 
使用ASP.NET Core支持GraphQL -- 较为原始的方法

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

结语

这只不过是使用asp.net core支持graphql的一个原始手动实现而已。 具体请看graphql-dotnet:。 

 

上一篇:

下一篇: