天天看點

【轉】使用ASP.NET Core支援GraphQL -- 較為原始的方法

GraphQL簡介

下面是GraphQL的定義:

GraphQL 既是一種用于 API 的查詢語言也是一個滿足你資料查詢的運作時。 GraphQL 對你的 API 中的資料提供了一套易于了解的完整描述,使得用戶端能夠準确地獲得它需要的資料,而且沒有任何備援,也讓 API 更容易地随着時間推移而演進,還能用于建構強大的開發者工具。

GraphQL由Facebook開發,始于2012年,2015年公開。

GraphQL牛逼之處是它可以讓用戶端精确的查詢它們想要的,不附加額外的東西,這樣的話就很容易讓用戶端随着API的演進去使用。

例子

下面是一個簡單的例子,這是一個GraphQL的查詢:

{
  person  {
    name
    email
  }
}
           

而這個查詢的響應結果是:

{
  "data": {
    "person": {
      "name": "Dave",
      "email": "[email protected]"
    }
  }
}
           

可以看到響應結果和查詢請求的内容結構幾乎是完全一樣的。如果你需要person其它的資訊,例如parents,那麼在查詢中加上這個屬性即可:

{
  person  {
    name
    email
    parents {
      name
    }
  }
}
           

它的響應會像這樣:

{
  "data": {
    "person": {
      "name": "Dave",
      "email": "[email protected]",
      "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:https://github.com/graphql-dotnet/graphql-dotnet。

繼續閱讀