使用Hot Chocolate和.NET 6构建GraphQL应用(8) —— 实现Mutate添加数据

系列导航

使用Hot Chocolate和.NET 6构建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对已有数据进行更新。