.NET Core中Serializer未返回预期输出问题排查

一、Member2返回空列表而非null的原因及解决办法 #

你的代码中CustomObjectA标记了[DataContract]和[DataMember]，结合OData的使用场景，即便配置了AddNewtonsoftJson，OData仍可能默认使用DataContractSerializer，或者NewtonsoftJson的默认配置结合DataContract特性，导致null集合被自动序列化为空列表。而你用JsonConvert.SerializeObject直接序列化时，是独立于控制器序列化流程的，所以能正确输出null。

解决步骤： #

1. 强制OData使用NewtonsoftJson序列化并保留null值
   在Startup.cs中配置时，明确指定NewtonsoftJson的序列化规则，同时确保OData遵循该配置：

   services.AddControllers()
       .AddNewtonsoftJson(options =>
       {
           // 保留null值，不将null集合转为空列表
           options.SerializerSettings.NullValueHandling = NullValueHandling.Include;
           options.SerializerSettings.DefaultValueHandling = DefaultValueHandling.Include;
       })
       .AddOData(opt =>
       {
           opt.Select().Filter().OrderBy().Expand().Count().Skip().Top();
           // 补充你的OData路由配置
       });
   

2. 调整DataMember特性配置
   给Member2的[DataMember]添加EmitDefaultValue = false，确保null值被正确序列化输出（而非替换为默认空集合）：

   [DataMember(EmitDefaultValue = false)]
   public List<CustomObjectC> Member2 { get; set; } = null;
   

3. 排查OData查询的自动初始化行为
   OData在处理ODataQueryOptions时，可能会自动初始化集合类型属性为空列表。可以在_service.Get(options)返回结果后，手动校验Member2的实际值，确认是否在查询过程中被修改。

二、如何确定控制器使用的序列化方式 #

可以通过以下几种方式验证：

• 调试查看格式化器类型
  在控制器方法中添加调试代码，获取当前响应使用的格式化器：

  var formatterSelector = HttpContext.RequestServices.GetService<IOutputFormatterSelector>();
  var selectedFormatter = formatterSelector.SelectFormatter(
      HttpContext, 
      ControllerContext.OutputFormatters, 
      typeof(List<CustomObjectA>)
  );
  // 查看selectedFormatter的类型，如NewtonsoftJsonOutputFormatter或ODataOutputFormatter
  

• 添加自定义序列化日志
  在NewtonsoftJson配置中加入自定义转换器，通过日志确认序列化行为：

  services.AddControllers()
      .AddNewtonsoftJson(options =>
      {
          options.SerializerSettings.Converters.Add(new CollectionLoggingConverter());
      });
  
  // 自定义转换器示例
  public class CollectionLoggingConverter : JsonConverter
  {
      public override bool CanConvert(Type objectType) 
          => objectType == typeof(List<CustomObjectC>);
  
      public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
      {
          return serializer.Deserialize(reader, objectType);
      }
  
      public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
      {
          Logger.Log($"序列化List<CustomObjectC>，当前值：{value ?? "null"}");
          serializer.Serialize(writer, value);
      }
  }
  

• 检查响应头Content-Type
  如果响应头为application/json; odata.metadata=minimal，说明使用OData专属格式化器；如果是application/json，则大概率使用NewtonsoftJson格式化器。

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