前言

你是否已經(jīng)厭倦了REST風(fēng)格的API? 讓我們來聊一下GraphQL。

 下面是GraphQL的定義：

GraphQL 既是一種用于 API 的查詢語言也是一個(gè)滿足你數(shù)據(jù)查詢的運(yùn)行時(shí)。 GraphQL 對(duì)你的 API 中的數(shù)據(jù)提供了一套易于理解的完整描述，使得客戶端能夠準(zhǔn)確地獲得它需要的數(shù)據(jù)，而且沒有任何冗余，也讓 API 更容易地隨著時(shí)間推移而演進(jìn)，還能用于構(gòu)建強(qiáng)大的開發(fā)者工具。

GraphQL由Facebook開發(fā)，始于2012年，2015年公開。

GraphQL牛之處是它可以讓客戶端精確的查詢它們想要的，不附加額外的東西，這樣的話就很容易讓客戶端隨著API的演進(jìn)去使用。

GraphQL提供了一種聲明式的方式從服務(wù)器拉取數(shù)據(jù)。你可以從GraphQL官網(wǎng)中了解到GraphQL的所有優(yōu)點(diǎn)。在這一系列博客中，我將展示如何在ASP.NET Core中集成GraphQL, 并使用GraphQL作為你的API查詢語言。

使用GraphQL的聲明式查詢，你可以自定義API返回的屬性列表。這與REST API中每個(gè)API只返回固定字段不同。

安裝GraphQL

為了在C#中使用GraphQL, GraphQL社區(qū)中提供了一個(gè)開源組件 graphql-dotnet 。本系列博客中我們都將使用這個(gè)組件。

首先我們創(chuàng)建一個(gè)空的ASP.NET Core App

dotnet new web --name chatper1

然后我們添加對(duì) graphql-dotnet 庫的引用

dotnet add package GraphQL

創(chuàng)建第一個(gè)Query

下面我們來創(chuàng)建一個(gè) query 類, 我們將它命名為 HelloWorldQuery 。 graphql-dotnet 中，查詢類都需要繼承 ObjectGraphType 類，所以 HelloWorldQuery 的代碼如下

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

這里你可能注意到我們使用了一個(gè)泛型方法 Field ，并傳遞了一個(gè)GraphQL的字符串類型 StringGraphType 來定義了一個(gè) hello 字段, resolve 參數(shù)是一個(gè)Func委托，在其中定義了如何返回當(dāng)前字段的值，這里我們是直接返回了一個(gè)字符串hello。

查詢類中的返回字段都是定義在查詢類的構(gòu)造函數(shù)中的

現(xiàn)在我們一個(gè)有了一個(gè)查詢類，下一步我們需要使用這個(gè)查詢類構(gòu)建一個(gè)結(jié)構(gòu)(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委托，并通過這個(gè)委托設(shè)置了一個(gè) ExecutionOptions 對(duì)象。這個(gè)對(duì)象初始化了我們定義的結(jié)構(gòu)(schema), 并執(zhí)行了我們定義的查詢字符串。
• doc.Query 定義了一個(gè)查詢字符串
• 最終查詢執(zhí)行的結(jié)果會(huì)通過 DocumentWriter 類實(shí)例的 Write 被轉(zhuǎn)換成一個(gè)JSON字符串

下面我們來運(yùn)行一下這個(gè)程序

dotnet run

你將在瀏覽器中看到以下結(jié)果

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

從以上的例子中，你會(huì)發(fā)現(xiàn)使用GraphQL并不像想象中那么難。下面我們可以在 HelloWorldQuery 類的構(gòu)造函數(shù)中再添加一個(gè)字段 howdy , 并指定這個(gè)字段會(huì)返回一個(gè)字符串 universe 。

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

然后我們繼續(xù)修改 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);
});

重新啟動(dòng)項(xiàng)目后，結(jié)果如下

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

總結(jié)

本篇我們只是接觸了GraphQL的一些皮毛，你可能會(huì)對(duì)GraphQL聲明式行為有很多問題，沒有關(guān)系，后續(xù)博客中，我們慢慢解開GraphQL的面紗。下一篇我們將介紹如何創(chuàng)建一個(gè)中間件(Middleware)

本篇源代碼：https://github.com/lamondlu/GraphQL_Blogs (本地下載)

好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論