前言
以前需要提供Web服務介面的時候，除了標準的WEBAPI形式，還考慮了OData、GraphQL等形式，雖然實作思路上有很大的區別，但對使用方來說，都是將查詢的主動權讓渡給了前端，讓呼叫方能夠更加自由地發揮或者符合自己要求的資料，其中，OData作為傳統REST WEBAPI的拓展，對外還是WEBAPI的形式，為了照顧到和第三方對接的兼容性，我最終使用了OData作為首選技術，
OData在使用上方便性不言而喻，簡直愛不釋手，不過逐漸也發現一個問題：Mock不方便！前端常用的比如json-schema-faker無法識別OData的標記，回傳的內容依舊是傳統API回傳的內容（無法輸出@odata之類的內容），
P.S. 最近還非常煩惱和OData一起使用EF Core時，由于有導航屬性（Navigation Property），mock框架會回圈參考導致Maximum call stack size exceeded的問題，一直沒有找好辦法，如果有朋友知道，還請不吝賜教，
于是和呼叫方的扯皮一直延續，最后還是先上線了后臺暫時處理了這個問題，最近有一個想法浮到水面：反正mock是不可能mock了，呼叫方已經要恨死我了，就干脆點直接WebAPI形式也不要了，攤牌了，
GraphQL
GraphQL是Facebook推出的一項提供資料API的語言，和WEBAPI相比較，它有一些自己的特點，詳細介紹可以看這里，最吸引我的地方，就是請求API可以一步到位，處理一些邏輯的時候，簡單的一個API請求就可以得到所有的資料（當然使用OData的expand等查詢也可以達到類似的效果），而且描述語言也比較簡潔，這樣呼叫方可以精確描述自己需要什么，介面回傳不多不少剛剛好的資料，優雅！
關于GraphQL的介紹，可以查看其他文章，不是本文的重點，
體驗
使用GraphQL，.NET支持的有很多庫，比較流行的，有GraphQL.NET和HotChocolate，作為一個肥宅，我就選HotChocolate作為主要使用的庫，直接使用nuget安裝即可，
install-package HotChocolate.AspNetCore
新建一個新的ASP.NET CORE空專案，添加HotChocolate.AspNetCore的nuget包，然后定義以下資料結構
public class Class
{
public string Name { get; set; }
public Teacher Teacher{get;set;}
}
public class Student
{
public string Realname { get; set; }
public Class Class{get;set;}
}
public class Teacher
{
public string Realname { get; set; }
public bool IsSupervisor{get;set;}
}
描述一個班級，教師和學生的關系，如果是REST API的話，一般需要三個介面表述三種不同的資源，GraphQL只有一個Endpoint，這個就比較簡單了，
接下來定義暴露的介面：
using System.Collections.Generic;
using System.Linq;
namespace Demo
{
public class Query
{
private List<Student> GetStudents()
{
List<Student> students = new List<Student>();
students.Add(new Student
{
Realname = "ZHANGSAN",
Class = new Class
{
Name = "GAOSAN",
Teacher = new Teacher { Realname = "LISI", IsSupervisor = false }
}
});
students.Add(new Student
{
Realname = "ZHANGSAN2",
Class = new Class
{
Name = "GAOSAN1",
Teacher = new Teacher { Realname = "LISI", IsSupervisor = true }
}
});
return students;
}
public IEnumerable<Student> StudentInfo(string name)
{
if(string.IsNullOrWhiteSpace(name)) return GetStudents();
return GetStudents().Where(w=>w.Realname == name);
}
}
}
提供了一個StudentInfo可以對外介面，
public void ConfigureServices(IServiceCollection services)
{
services.AddGraphQLServer().AddQueryType<Query>();
}
//在configure中
app.UseEndpoints(endpoints =>
{
endpoints.MapGraphQL();
})；
然后然后直接F5運行，訪問HotChocolate自帶的分析器地址：http://localhost:5000/graphql/
直接查詢即可得到結果，換一種查詢條件：
可以發現，GraphQL回傳的內容是可以由呼叫方進行定義的，你要啥它給啥，不用的欄位你不寫就不回傳，很多時候，只要一次查詢就能完成多次普通WebAPI請求才能達到的目標，（這個例子還不能表現出這個特點，有機會以后補充），
補充
如果呼叫方不會GraphQL的話，不建議輕易上這個技術，因為他們來一句“這不是標準WEBAPI或者Webservice，我們調不了，”就把你噎死了，好多歹說就算終于上了，你還需要告訴清楚他們每一個介面的請求內容，這就純粹給自己找事，體驗太不好了，
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/258301.html
標籤：.NET技术