GraphQL.NET 中列表类型解析为 null 的问题分析与解决方案

问题背景

在 GraphQL.NET 项目中，当用户从版本 7 升级到版本 8 后，遇到了一个奇怪的问题：所有使用 ListGraphType 的字段都开始返回 null 值，而不是预期的列表数据。即使是最简单的查询示例也出现了这个问题。

问题表现

用户提供了一个简单的查询示例：

Field<ListGraphType<StringGraphType>>("test")
    .Description("Just a test")
    .Resolve(_ => new List<string> { "test1", "test2", "test3" });

期望返回的结果应该是包含三个字符串的列表，但实际返回的却是 null 值。

问题根源

经过深入分析，发现这个问题源于 GraphQL.NET 8.0 版本引入的一项性能优化。在 v8 中，当返回标量列表时，系统会采用"快速序列化"机制来提高性能。这项优化改变了列表数据的处理方式，导致自定义序列化逻辑无法正确处理这些数据。

技术细节

在 GraphQL.NET v8 中，ArrayExecutionNode 类新增了两个重要属性：

1. Items - 包含子节点的集合
2. SerializedResult - 已序列化的结果数据

当列表中的项是标量类型时，系统会直接将整个列表序列化并存储在 SerializedResult 属性中，而 Items 属性则保持为 null。这种优化避免了逐个节点处理的开销。

解决方案

对于使用自定义序列化逻辑的项目，需要更新代码以正确处理这两种情况。以下是处理 ArrayExecutionNode 的正确方式：

if (node is ArrayExecutionNode arrayExecutionNode)
{
    var items = arrayExecutionNode.Items;
    if (items == null)
    {
        // 处理快速序列化的列表数据
        var result = arrayExecutionNode.SerializedResult;
        if (result == null)
        {
            writer.WriteNull();
        }
        else if (result.GetType() == typeof(byte[]))
        {
            // 特殊处理字节数组
            writer.WriteStartArray();
            foreach (var b in (byte[])result)
            {
                writer.WriteValue(b);
            }
            writer.WriteEndArray();
        }
        else
        {
            serializer.Serialize(writer, arrayExecutionNode.SerializedResult);
        }
    }
    else
    {
        // 处理普通列表数据
        writer.WriteStartArray();
        foreach (var childNode in items)
        {
            WriteExecutionNode(writer, childNode, serializer);
        }
        writer.WriteEndArray();
    }
}

最佳实践

1. 升级检查：在升级到 GraphQL.NET v8 时，应全面检查所有自定义序列化逻辑
2. 测试验证：特别关注列表类型字段的返回结果
3. 性能考量：理解并利用 v8 的性能优化特性
4. 代码复用：考虑直接使用 GraphQL.NET 提供的 GraphQLSerializer 类，避免重复造轮子

结论

GraphQL.NET v8 引入的列表处理优化虽然提高了性能，但也带来了兼容性挑战。通过理解新的数据结构和处理机制，开发者可以顺利解决列表返回 null 的问题，同时享受到新版本带来的性能提升。对于大多数项目来说，直接使用内置的序列化工具是最简单可靠的解决方案。