HotChocolate GraphQL：如何为整个架构将类型设为可空

1. 定义你的Wrapper Struct #

先确保struct包含空状态判断属性和实例创建方法，同时通过接口实现全局适配：

public interface IWrapper
{
    bool IsEmpty { get; }
}

public readonly struct StringWrapper : IWrapper
{
    public bool IsEmpty { get; }
    public string Value { get; }

    private StringWrapper(string value, bool isEmpty)
    {
        Value = value;
        IsEmpty = isEmpty;
    }

    public static StringWrapper FromString(string value) => new(value, false);
    public static StringWrapper Empty() => new(null, true);
}

如果仅需处理单一种类的wrapper，可以跳过IWrapper接口，后续直接判断具体struct类型即可。

2. 实现自定义TypeInterceptor #

通过TypeInterceptor在架构发现阶段，自动修改所有wrapper类型字段的可空性：

public class WrapperTypeInterceptor : TypeInterceptor
{
    public override void OnBeforeCompleteType(
        ITypeCompletionContext context,
        DefinitionBase definition,
        IDictionary<string, object?> contextData)
    {
        // 处理输出对象类型的字段
        if (definition is ObjectTypeDefinition objectTypeDef)
        {
            foreach (var fieldDef in objectTypeDef.Fields)
            {
                UpdateWrapperFieldNullable(fieldDef);
            }
        }

        // 处理输入对象类型的字段
        if (definition is InputObjectTypeDefinition inputTypeDef)
        {
            foreach (var fieldDef in inputTypeDef.Fields)
            {
                UpdateWrapperFieldNullable(fieldDef);
            }
        }

        base.OnBeforeCompleteType(context, definition, contextData);
    }

    private static void UpdateWrapperFieldNullable(FieldDefinition fieldDef)
    {
        if (fieldDef.Type is ClrTypeReference clrTypeRef && 
            typeof(IWrapper).IsAssignableFrom(clrTypeRef.ClrType))
        {
            // 将原本不可空的struct字段标记为可空
            fieldDef.Type = new NullableTypeReference(fieldDef.Type);
        }
    }
}

3. 添加类型转换器处理序列化/反序列化 #

实现类型转换器，让HotChocolate能在wrapper struct与字符串（或null）之间正确转换：

// 序列化：Wrapper -> string?
public class WrapperToStringConverter : ITypeConverter<IWrapper, string?>
{
    public string? Convert(IWrapper source)
    {
        return source.IsEmpty ? null : (source as StringWrapper)?.Value;
    }
}

// 反序列化：string? -> Wrapper
public class StringToWrapperConverter : ITypeConverter<string?, StringWrapper>
{
    public StringWrapper Convert(string? source)
    {
        return source == null ? StringWrapper.Empty() : StringWrapper.FromString(source);
    }
}

若存在多种wrapper类型，可为每种类型单独实现转换器，或在通用转换器内做类型分支判断。

4. 注册Interceptor和转换器到GraphQL服务 #

在服务配置中注入自定义组件，让规则全局生效：

builder.Services
    .AddGraphQLServer()
    .AddTypeInterceptor<WrapperTypeInterceptor>()
    .AddTypeConverter<IWrapper, string?>(new WrapperToStringConverter())
    .AddTypeConverter<string?, StringWrapper>(new StringToWrapperConverter())
    // 注册你的查询/突变类型等业务组件
    .AddQueryType<Query>();

核心逻辑说明 #

• 无需在每个wrapper字段上添加注解，所有实现IWrapper的struct字段都会被自动标记为可空。
• 类型转换器确保空状态的wrapper被序列化为null，输入的null则转换为空状态的wrapper，彻底避免HotChocolate抛出值类型不可为空的异常。

内容的提问来源于stack exchange，提问作者fog