GraphQL怎么在ASP.NETCore中使用-创新互联

这篇文章给大家介绍GraphQL怎么在ASP.NET Core中使用,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。

创新互联是一家集网站建设,平乐企业网站建设,平乐品牌网站建设,网站定制,平乐网站建设报价,网络营销,网络优化,平乐网站推广为一体的创新建站企业,帮助传统企业提升企业形象加强企业竞争力。可充分满足这一群体相比中小企业更为丰富、高端、多元的互联网需求。同时我们时刻保持专业、时尚、前沿,时刻以成就客户成长自我,坚持不断学习、思考、沉淀、净化自己,让我们为更多的企业打造出实用型网站。

GraphQL的定义:


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

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

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

GraphQL提供了一种声明式的方式从服务器拉取数据。你可以从GraphQL官网中了解到GraphQL的所有优点。在这一系列博客中,我将展示如何在ASP.NET Core中集成GraphQL, 并使用GraphQL作为你的API查询语言。

使用GraphQL的声明式查询,你可以自定义API返回的属性列表。这与REST API中每个API只返回固定字段不同。

安装GraphQL


为了在C#中使用GraphQL, GraphQL社区中提供了一个开源组件 graphql-dotnet 。本系列博客中我们都将使用这个组件。

首先我们创建一个空的ASP.NET Core App

dotnet new web --name chatper1

然后我们添加对 graphql-dotnet 库的引用

dotnet add package GraphQL

创建第一个Query


下面我们来创建一个 query 类, 我们将它命名为 HelloWorldQuery 。 graphql-dotnet 中,查询类都需要继承 ObjectGraphType 类,所以 HelloWorldQuery 的代码如下

using GraphQL.Types;
public class HelloWorldQuery : ObjectGraphType
{
  public HelloWorldQuery()
  {
    Field(
      name: "hello",
      resolve: context => "world"
    );
  }
}

这里你可能注意到我们使用了一个泛型方法 Field ,并传递了一个GraphQL的字符串类型 StringGraphType 来定义了一个 hello 字段, resolve 参数是一个Func委托,在其中定义了如何返回当前字段的值,这里我们是直接返回了一个字符串hello。

查询类中的返回字段都是定义在查询类的构造函数中的

现在我们一个有了一个查询类,下一步我们需要使用这个查询类构建一个结构(schema)。

在 Startup.cs 文件的 Configure 方法中,使用以下代码替换原有代码

var schema = new Schema {
  Query = new HelloWorldQuery() 
};

app.Run(async (context) =>
{
  var result = await new DocumentExecuter()
    .ExecuteAsync(doc =>
    {
      doc.Schema = schema;
      doc.Query = @"
        query {
          hello
        }
      ";
    }).ConfigureAwait(false);

  var json = new DocumentWriter(indent: true)
    .Write(result)
  await context.Response.WriteAsync(json);
});
  • DocumentExecuter 类的 ExecuteAsync 方法中我们定义Action委托,并通过这个委托设置了一个 ExecutionOptions 对象。这个对象初始化了我们定义的结构(schema), 并执行了我们定义的查询字符串。

  • doc.Query 定义了一个查询字符串

  • 最终查询执行的结果会通过 DocumentWriter 类实例的 Write 被转换成一个JSON字符串

下面我们来运行一下这个程序

dotnet run

你将在浏览器中看到以下结果

{
  "data": {
    "hello": "world"
  }
}


从以上的例子中,你会发现使用GraphQL并不像想象中那么难。下面我们可以在 HelloWorldQuery 类的构造函数中再添加一个字段 howdy , 并指定这个字段会返回一个字符串 universe 。

Field(
  name: "howdy",
  resolve: context => "universe"
);

然后我们继续修改 Startup 类中的 Configure 方法, 修改我们之前定义的query

var schema = new Schema { 
  Query = new HelloWorldQuery()
};

app.Run(async (context) =>
{
  var result = await new DocumentExecuter()
    .ExecuteAsync(doc =>
    {
      doc.Schema = schema;
      doc.Query = @"
        query {
          hello
          howdy
        }
      ";
    }).ConfigureAwait(false);

  var json = new DocumentWriter(indent: true)
    .Write(result)
  await context.Response.WriteAsync(json);
});

重新启动项目后,结果如下

{
  "data": {
    "hello": "world",
    "howdy": "universe"
  }
}


关于GraphQL怎么在ASP.NET Core中使用就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。


分享题目:GraphQL怎么在ASP.NETCore中使用-创新互联
分享路径:http://bzwzjz.com/article/cejooj.html

其他资讯

Copyright © 2007-2020 广东宝晨空调科技有限公司 All Rights Reserved 粤ICP备2022107769号
友情链接: 成都网站设计制作公司 品牌网站建设 高端网站建设 网站制作 外贸网站设计方案 成都网站建设公司 成都品牌网站设计 高端网站设计推广 网站建设公司 网站设计公司 定制网站设计 成都网站建设 古蔺网站建设 成都网站设计公司 成都做网站建设公司 企业网站设计 自适应网站建设 成都定制网站建设 成都网站建设流程 网站建设 四川成都网站设计 定制网站建设多少钱