ASP.NET Core中使用GraphQL - 第一章 Hello World

前言

你是否已經厭倦了REST風格的API? 讓我們來聊一下GraphQL。 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<StringGraphType>(
            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<StringGraphType>(
    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的一些皮毛，你可能會對GraphQL聲明式行為有很多問題，沒有關系，后續博客中，我們慢慢解開GraphQL的面紗。下一篇我們將介紹如何創建一個中間件(Middleware)

本篇源代碼：https://github.com/lamondlu/GraphQL_Blogs