使用Hot Chocolate和.NET 6構建GraphQL應用(8) —— 實現Mutate添加數據

2022 年 2 月 11 日
筆記
.NET 6, .NET基礎系列, graphql

系列導航

需求

在討論完GraphQL中的查詢需求後，這篇文章我們將演示如何實現GraphQL中的數據添加任務。

思路

在GraphQL中，對數據進行查詢使用query，而對於修改數據則需要使用mutation，包括新增和修改數據。Hot Chocolate在使用Mutation的邏輯上和使用Query的基本一致，但是需要根據需要定義用於創建或者更新的數據對象，所以我們直接進行實現。

實現

為了保持簡單，我們先定義以下兩個類型：

// 定義新增Post的參數
public record AddPostInput(string Title, string Author);

// 定義新增Post的返回對象
public record AddPostPayload(Post Post);

新建Mutation.cs用來定義相關介面：

Mutation.cs

namespace PostGraphi.Api.GraphQL;

public class Mutation
{
    public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)
    {
        return new AddPostPayload(await repository.AddAsync(new Post
        {
            Title = input.Title,
            Author = input.Author
        }));
    }
}

最後在注入服務的地方進行配置：

ProgramExtensions.cs

builder.Services
    .AddGraphQLServer()
    .SetPagingOptions(new PagingOptions
    {
        MaxPageSize = 50,
        IncludeTotalCount = true
    })
    .AddFiltering()
    .AddProjections()
    .AddSorting()
    .AddQueryType<Query>()
    .AddMutationType<Mutation>()
    .AddMutationConventions(new MutationConventionOptions
    {
        ApplyToAllMutations = true,
        InputArgumentName = "input",
        InputTypeNamePattern = "{MutationName}Input",
        PayloadTypeNamePattern = "{MutationName}Payload",
        PayloadErrorTypeNamePattern = "{MutationName}Error",
        PayloadErrorsFieldName = "errors"
    })
    .AddType<PostType>();

這樣就實現了新增Post的需求，下面我們來驗證一下。

驗證

啟動Api項目，調用介面：

終端的日誌輸出如下：

[10:45:15 INF] Executed DbCommand (1ms) [Parameters=[@p0='?' (DbType = Guid), @p1='?', @p2='?' (Size = 13), @p3='?', @p4='?' (DbType = DateTime), @p5='?', @p6='?' (DbType = DateTime), @p7='?', @p8='?', @p9='?' (DbType = DateTime), @p10='?' (Size = 30)], CommandType='Text', CommandTimeout='30']
INSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title")
VALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);
[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'

可以看到新建的Post已經存儲到資料庫中了，我們可以通過查詢介面來獲取詳情：

總結

在本文中我們實現了簡單的新增Post操作，這裡還有一些涉及到錯誤處理的內容，我沒有在文章中演示，可以參考官方文檔 Errors，在自定義異常對象後，有三種方式可以進行錯誤處理：直接返回異常；使用異常工廠方法；使用構造函數。甚至可以在AggregateExceptions中一次性返回多個異常。基本思路都是通過添加屬性[Error(typeof(SomeUserDefinedException))]來實現的。

在下一篇文章中，我們通過Mutation對已有數據進行更新。

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