查询HotChocolate - 编程之家

如何解决查询HotChocolate

试图制作自己的项目，以ChilliCream/graphql-workshop为例。

有一部分，其中查询的id参数标记为IDAttribute。

ID类型说明如下：

ID标量类型表示唯一标识符，通常用于重新获取对象或作为缓存的键。 ID类型显示在JSON中作为字符串响应；但是，它并非旨在人类可读的。当期望作为输入类型时，任何字符串（例如输入值“ 4”或整数（例如4）作为ID。

我的C＃查询源看起来像

[ExtendobjectType(Name = GraphqlQueryNames.Query)]
public class EmployeeQuery
{
    public async Task<Employee> GetEmployeeByIdAsync(
        [ID] int id,[Service] IEmployeeRepository employeeRepository,CancellationToken token)
    {
        return await employeeRepository.GetEmployeeByIdAsync(id,token);
    }
}

在操场上

# 1 passed as value of $id

query getEmployeeById($id: ID!) {
  employeeById(id: $id) {
    familyName
  }
}

无论值是字符串还是数字，服务器都会引发相同的错误“ ID'1'的格式无效”。

如果我们从C＃中删除[ID]属性，并将其用作“ Int！”在GraphQL查询中，效果很好。

ID有什么问题，为什么在示例（AttendeeQueries.cs）中存在ID？ HotChocolate 10.5.3

解决方法

发现IDAttribute用于中继（因为它位于HotChocolate.Types.Relay命名空间中）。因此需要启用和配置中继支持（source）：

ISchema schema = SchemaBuilder.New()
    .EnableRelaySupport()
    ...
    .Create();

在ObjectType中：

public class MyObjectType
    : ObjectType<MyObject>
{
    protected override void Configure(IObjectTypeDescriptor<MyObject> descriptor)
    {
        descriptor.AsNode()
            .IdField(t => t.Id)
            .NodeResolver((ctx,id) =>
                ctx.Service<IMyRepository>().GetMyObjectAsync(id));
        ...
    }
}

似乎示例项目graphql-workshop需要就这些目的进行更多的就地解释。可以找到here。

首先，ID scalar type 是 GraphQL 标准的一部分，定义为：

在 GraphQL 中，ID 标量类型表示唯一标识符，通常是用于重新获取对象或作为缓存的键。身份证类型是以与字符串相同的方式序列化；但是，将其定义为 ID 表示它不是人类可读的。

Relay 是一个用于 React 应用程序的 GraphQL 客户端 JavaScript 框架。 Apollo GraphQL 是另一种选择。

HotChocolate 有一些帮助器可以启用“Relay-style GraphQL API”。这些助手会将 id 字段转换为 base64 编码的哈希，序列化为字符串。这是一件好事，因为：

它有助于缓存，所有实体都有一个唯一的 id
对用户隐藏实际 ID (?)

即使您在 HotChocolate 中启用了“中继支持”，您也不必使用中继，您仍然可以使用任何 GraphQL 客户端（我最喜欢 Apollo 客户端）

现在，如果您只想使用 GraphQL ID 标量类型，您可以按照我的建议尝试：

首先从查询中删除 ID 属性：

[ExtendObjectType(Name = GraphqlQueryNames.Query)]
public class EmployeeQuery
{
    public async Task<Employee> GetEmployeeByIdAsync(
        int id,[Service] IEmployeeRepository employeeRepository,CancellationToken token)
    {
        return await employeeRepository.GetEmployeeByIdAsync(id,token);
    }
}

然后像这样指定 ID 标量类型：

public class EmployeeType : ObjectType<Employee>
{
    protected override void Configure(IObjectTypeDescriptor<Employee> descriptor)
    {
        descriptor.Field(r => r.Id).Type<IdType>;
    }
}

但是，如果您想在 HotChocolate 中启用“中继支持”，请遵循 Arsync 的回答（我将其更改为 HotChocolate v11，其语法略有不同）：

public class Startup
{
  public void ConfigureServices(IServiceCollection services) 
  {
    services.AddGraphQLServer().EnableRelaySupport();
  }
}

然后在您的类型定义中：

public class EmployeeType : ObjectType<Employee>
{
    protected override void Configure(IObjectTypeDescriptor<Employee> descriptor)
    {
        // Relay ID support. Retailer.Id will be a hash. the real id / int is available below when passed to DataLoader
        descriptor
            .ImplementsNode()
            .IdField(c => c.Id)
            .ResolveNode(((context,id) => context.DataLoader<EmployeeByIdDataLoader>().LoadAsync(id,context.RequestAborted)));
    }
}

如果您现在尝试查询员工，您会看到 id 不是整数，而是一个哈希值。类似于“TGFuZ3VhZ2UKaTE=”。该散列由 HotChocolate 生成，请参阅 IdSerializer source。如果您尝试对这个字符串进行 base64 解码：

$ echo "TGFuZ3VhZ2UKaTE=" | base64 -d
Employee
i1

您收到的错误消息“ID 1 的格式无效”，是因为它现在需要散列字符串，而不是整数。

这个查询应该可以工作：

query getEmployeeById {
  employeeById(id: "TGFuZ3VhZ2UKaTE=") {
    familyName
  }
}