使用Hot Chocolate和.NET 6構建GraphQL應用(4) —— 實現Query映射功能

2022 年 1 月 29 日
筆記
.NET 6, .NET基礎系列, graphql

系列導航

需求

在上一篇文章使用Hot Chocolate和.NET 6構建GraphQL應用(3) —— 實現Query基礎功能中，我們留了兩個問題，一是通過GraphQL介面返回的Posts結果並沒有獲取到關聯的Comment和Tag內容，二是返回結果沒有進行排序。在這篇文章中，我們先來解決第一個問題。

思路

要獲取關聯實體，使用EF Core自然會想到在進行Query的時候添加一下Include語句就可以了，這種方式雖然可以實現，但是這其實並不太符合GraphQL介面的風格。GraphQL本身就是將數據對象作為圖中的頂點以及其鄰接點來看待的。所以我們不會修改介面本身的邏輯，通過Hot Chocolate為我們提供的映射（Projection）屬性來完成需求。

實現

要使用Projection屬性，需要先在添加服務依賴注入的時候指定：

ProgramExtension.cs

builder.Services
    .AddGraphQLServer()
    .AddProjections()
    .AddQueryType<Query>()
    .AddType<PostType>();

然後在介面上方添加UseProjection即可：

Query.cs

[UseProjection]
public IQueryable<Post> GetPosts([Service] IRepository<Post> repository) => repository.GetAsQueryable();

這樣就實現了關聯實體的獲取，非常簡單，下面我們來驗證一下。

驗證

啟動Api項目，調用介面：

可以看到Comment和Tag資訊已經出現在返回體中了，我們再來看一下控制台輸出的EF Core日誌：

[09:48:40 INF] Executing endpoint 'Hot Chocolate GraphQL Pipeline'
[09:48:40 WRN] Compiling a query which loads related collections for more than one collection navigation, either via 'Include' or through projection, but no 'QuerySplittingBehavior' has been configured. By default, Entity Framework will use 'QuerySplittingBehavior.SingleQuery', which can potentially result in slow query performance. See //go.microsoft.com/fwlink/?linkid=2134277 for more information. To identify the query that's triggering this warning call 'ConfigureWarnings(w => w.Throw(RelationalEventId.MultipleCollectionIncludeWarning))'.
[09:48:40 INF] Executed DbCommand (2ms) [Parameters=[], CommandType='Text', CommandTimeout='30']
SELECT "p"."Id", "p"."Title", "p"."Author", "c"."Content", "c"."Id", "t0"."Name", "t0"."PostsId", "t0"."TagsId", "t0"."Id"
FROM "Posts" AS "p"
LEFT JOIN "Comments" AS "c" ON "p"."Id" = "c"."PostId"
LEFT JOIN (
    SELECT "t"."Name", "p0"."PostsId", "p0"."TagsId", "t"."Id"
    FROM "PostTag" AS "p0"
    INNER JOIN "Tags" AS "t" ON "p0"."TagsId" = "t"."Id"
) AS "t0" ON "p"."Id" = "t0"."PostsId"
ORDER BY "p"."Id", "c"."Id", "t0"."PostsId", "t0"."TagsId"
[09:48:40 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'

從日誌中可以看到Hot Chocolate告訴我們載入多個關聯實體集合的時候要麼通過Include方式，要麼使用Projection，但是在沒有應用任何QuerySplittingBehavior的情況下，會默認使用QuerySplittingBehavior.SingleQuery方式，可能會導致慢查詢，具體的說明也給出了鏈接，有興趣的小夥伴可以看一下。

然後就是實際執行的SQL語句了，可以看到這次的SQL語句明顯進行了關聯對象之間的Join操作，所以能得到我們希望的結果。

總結

在本文中我們實現了關聯對象的獲取，下一篇文章將會介紹如何進行查詢數據的過濾。

Tags: .NET 6 .NET基礎系列 graphql