在.NET中體驗GraphQL

2021 年 2 月 10 日
筆記
.NET Core, Asp.Net Core, graphql, WebApi

前言

以前需要提供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自帶的分析器地址：//localhost:5000/graphql/

直接查詢即可得到結果，換一種查詢條件：

可以發現，GraphQL返回的內容是可以由調用方進行定義的，你要啥它給啥，不用的字段你不寫就不返回。很多時候，只要一次查詢就能完成多次普通WebAPI請求才能達到的目標。（這個例子還不能表現出這個特點，有機會以後補充）。

補充

如果調用方不會GraphQL的話，不建議輕易上這個技術，因為他們來一句「這不是標準WEBAPI或者Webservice，我們調不了。」就把你噎死了。好多歹說就算終於上了，你還需要告訴清楚他們每一個接口的請求內容，這就純粹給自己找事，體驗太不好了。

Tags: .NET Core Asp.Net Core graphql WebApi