升级GraphQL NuGet包至7.3.0后出现自引用循环序列化错误

问题根源 #

升级GraphQL从v3到v7.3.0后，执行节点（如RootExecutionNode）内部新增了parent属性的循环引用，直接序列化整个执行结果对象会触发Newtonsoft.Json的自引用检测异常；而关闭检测后，序列化会递归遍历所有内部元数据，导致耗时剧增、请求超时。

具体解决办法 #

• 只序列化业务数据，而非整个执行节点
  不要返回完整的GraphQL执行结果对象，仅返回其中的Data属性（如果需要错误信息，可单独提取Errors字段）。示例代码：

  // 错误写法：序列化整个执行结果对象
  // return Ok(executeResult);
  
  // 正确写法：只序列化业务数据和错误信息
  return Ok(new { Data = executeResult.Data, Errors = executeResult.Errors });
  

• 针对GraphQL类型配置序列化忽略规则
  如果必须序列化完整执行结果，可通过Newtonsoft.Json的契约解析器忽略ExecutionNode的parent属性，避免循环引用：

  services.AddControllers()
      .AddNewtonsoftJson(options =>
      {
          var contractResolver = new DefaultContractResolver();
          // 忽略所有ExecutionNode派生类型的parent属性
          var executionNodeContract = contractResolver.ResolveContract(typeof(GraphQL.Execution.ExecutionNode)) as JsonObjectContract;
          if (executionNodeContract != null)
          {
              var parentProperty = executionNodeContract.Properties.FirstOrDefault(p => p.PropertyName == "parent");
              if (parentProperty != null)
              {
                  parentProperty.Ignored = true;
              }
          }
          options.SerializerSettings.ContractResolver = contractResolver;
      });
  

• 使用GraphQL官方序列化器
  GraphQL.NET v7+推荐使用自带的DocumentWriter来序列化执行结果，它会自动处理内部引用和元数据，避免循环问题：

  using GraphQL;
  
  // 在控制器或服务中实例化DocumentWriter（建议注入单例）
  var documentWriter = new DocumentWriter(indent: false);
  var serializedResult = await documentWriter.WriteToStringAsync(executeResult);
  return Content(serializedResult, "application/json");
  

为什么关闭循环检测会超时 #

GraphQL v7的执行节点包含大量嵌套的内部元数据（如字段上下文、执行路径、父节点引用等），关闭自引用检测后，Newtonsoft.Json会递归遍历所有这些嵌套对象，生成异常庞大的JSON结构，导致序列化耗时急剧增加，最终触发请求超时。

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