从Cosmos DB读取含接口成员的对象时序列化异常解决方案咨询

当Cosmos DB存储包含接口类型成员的对象时，Newtonsoft.Json默认无法自动识别接口的具体实现类，导致反序列化失败。以下是几种可行的解决方法：

方法1：保留类型元信息 #

通过配置Newtonsoft.Json在序列化时写入类型信息，反序列化时就能根据这些信息实例化对应的实现类。

• 局部配置（推荐）：在Group类的IResult成员上添加特性，仅对该字段启用类型信息：

  public class Group
  {
      [JsonProperty(TypeNameHandling = TypeNameHandling.Auto)]
      public IResult Result { get; set; }
      // 其他成员...
  }
  

  TypeNameHandling.Auto会在必要时（比如字段类型是接口/抽象类）写入类型信息，避免冗余。

• 全局配置：如果多个类型都有类似需求，可以在Cosmos Client的序列化配置中全局设置：

  var clientOptions = new CosmosClientOptions
  {
      SerializerOptions = new CosmosSerializationOptions
      {
          JsonSerializerSettings = new Newtonsoft.Json.JsonSerializerSettings
          {
              TypeNameHandling = TypeNameHandling.Auto
          }
      }
  };
  var cosmosClient = new CosmosClient("connection-string", clientOptions);
  

  注意：全局启用TypeNameHandling存在一定安全风险，避免使用TypeNameHandling.All，防止恶意类型注入。

方法2：自定义Json转换器 #

如果需要更精细的控制（比如根据自定义标识字段选择实现类），可以编写自定义JsonConverter。

1. 首先给IResult的所有实现类添加一个标识字段，比如：

   public interface IResult
   {
       string ResultType { get; }
       // 其他接口成员...
   }
   
   public class FooResult : IResult
   {
       public string ResultType => nameof(FooResult);
       // 实现成员...
   }
   
   public class BarResult : IResult
   {
       public string ResultType => nameof(BarResult);
       // 实现成员...
   }
   

2. 编写自定义转换器：

   public class IResultConverter : JsonConverter<IResult>
   {
       public override IResult ReadJson(JsonReader reader, Type objectType, IResult existingValue, bool hasExistingValue, JsonSerializer serializer)
       {
           var jObject = JObject.Load(reader);
           var resultType = jObject["resultType"]?.Value<string>();
           return resultType switch
           {
               nameof(FooResult) => jObject.ToObject<FooResult>(serializer),
               nameof(BarResult) => jObject.ToObject<BarResult>(serializer),
               _ => throw new NotSupportedException($"Unsupported ResultType: {resultType}")
           };
       }
   
       public override void WriteJson(JsonWriter writer, IResult value, JsonSerializer serializer)
       {
           serializer.Serialize(writer, value);
       }
   }
   

3. 在Group类的IResult成员上应用转换器：

   public class Group
   {
       [JsonConverter(typeof(IResultConverter))]
       public IResult Result { get; set; }
       // 其他成员...
   }
   

方法3：改用具体类型（适合简单场景） #

如果业务场景允许，直接将Group类中的IResult成员改为具体实现类的父类或使用泛型，但这种方式灵活性较差，仅适用于实现类固定的情况。

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