使用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": "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 的空項目。項目結構如圖： 

創建Model

而後創建一個Person 的Model： 

創建Repository

下面創建用於查詢Person的Repository，首先是接口： 

而後是具體的Repository，裏面帶有一些寫死的數據： 

添加GraphQL庫

經過dotnet cli添加GraphQL這個庫：

dotnet add package GraphQL

安裝成功後，在項目文件裏會有顯示： 

創建GraphQL中間件

首先我須要一個GraphQL特定的Person類型類，它要包含映射到Person類的字段： 

該類須要繼承於ObjectGraphType< Person>。

而後我還須要一個查詢類，它裏面包含對GraphQL實現的細節： 

該類須要繼承於 ObjectGraphType。在這裏，我把全部請求查詢的字段映射到了PersonRepository的調用上。

最後是中間件： 


該類的意思就是，當請求地址是"/graphql"開頭時，就會嘗試讀取請求的body。而後創建一個Schema對象，它的query字段的值就是PersonQuery的實例，而PersonQuery的實例又須要PersonRepository做爲參數。 
最後創建一個DocumentExecuter來對這個schema進行查詢，結果以JSON格式返回。

註冊Repository，使用中間件

別忘了在Startup.cs裏註冊Repository和在管道里調用咱們的中間件： 

測試

運行ASP.NET Core項目：

dotnet watch run

打開POSTMAN，首先按id查詢一個Person： 

Cool，沒問題。

再來一個帶Parents的查詢： 

最後再查詢全部的Person吧： 

注意這裏的查詢寫的是persons而不是person，這個要和PersonQuery類裏面的定義一致。

結語

這只不過是使用ASP.NET Core支持GraphQL的一個原始手動實現而已。 具體請看graphql-dotnet：https://github.com/graphql-dotnet/graphql-dotnet。