如何在HotChocolate.AspNetCore中处理GraphQL的Guid序列化？Id返回Base64而非Guid

HotChocolate 12.x默认会将Guid类型的ID字段序列化为Base64字符串，这是因为它默认把Guid映射到GraphQL的ID标量类型，而该标量通常采用Base64编码压缩长度。要让ID返回标准的Guid格式（如xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx），可以通过以下两种方式实现：

方案一：自定义Guid标量类型 #

创建一个自定义的Guid标量，覆盖默认的序列化和解析逻辑：

public class GuidScalar : ScalarType<Guid>
{
    public GuidScalar() : base("Guid") { }

    // 解析GraphQL查询中的字面量值
    public override IValueNode ParseLiteral(IValueNode valueSyntax)
    {
        if (valueSyntax is StringValueNode stringValue && 
            Guid.TryParse(stringValue.Value, out var guid))
        {
            return new StringValueNode(guid.ToString("D"));
        }
        throw new SerializationException("无法将输入解析为有效的Guid");
    }

    // 解析查询变量的值
    public override object ParseValue(object? value)
    {
        if (value is string str && Guid.TryParse(str, out var guid))
        {
            return guid;
        }
        throw new SerializationException("无法将输入解析为有效的Guid");
    }

    // 将Guid序列化为标准字符串格式
    public override object Serialize(object? value)
    {
        if (value is Guid guid)
        {
            return guid.ToString("D");
        }
        throw new SerializationException("无法将输入序列化为Guid格式");
    }
}

然后在GraphQL服务配置中注册这个标量：

services.AddGraphQLServer()
    .AddQueryType<Query>()
    // 注册自定义Guid标量
    .AddType<GuidScalar>();

最后，在实体类型定义中，将ID字段指定为这个自定义标量：

public class MyEntityType : ObjectType<MyEntity>
{
    protected override void Configure(IObjectTypeDescriptor<MyEntity> descriptor)
    {
        descriptor.Field(e => e.Id)
            .Type<GuidScalar>(); // 关联自定义标量
    }
}

方案二：全局配置Guid序列化器 #

如果希望所有Guid字段都采用标准格式返回，可以配置全局自定义序列化器：

// 自定义Guid序列化器
public class GuidStandardSerializer : ISerializer<Guid>
{
    public Guid Deserialize(object? value)
    {
        if (value is string str && Guid.TryParse(str, out var guid))
        {
            return guid;
        }
        throw new SerializationException("无效的Guid字符串");
    }

    public object Serialize(Guid value)
    {
        return value.ToString("D");
    }
}

在服务配置中添加这个序列化器：

services.AddGraphQLServer()
    .AddQueryType<Query>()
    .ConfigureSerializer(options =>
    {
        // 替换默认的Guid序列化器
        options.AddCustomSerializer<Guid>(new GuidStandardSerializer());
    });

这种方式不需要在每个实体字段中单独指定类型，所有Guid类型的字段都会自动序列化为标准格式。

注意事项 #

• 确保实体类中ID字段的类型确实是Guid，而非string或其他类型。
• 如果查询中使用了ID标量类型，需要替换为自定义的Guid标量，或者通过全局序列化覆盖默认行为。

内容的提问来源于stack exchange，提问作者Mohammad Al Mahamid