ASP.net Core MVC 没有在抽象结果上调用 System.Text.Json 的自定义多态 JsonConverter

Question

我有一个从 Microsoft.AspNetCore.Mvc.ControllerBase 派生的 .NET Core 3.1 控制器，结果输出时不会调用自定义 json 转换器。

产品

public interface IProduct { ... }

控制器：

[HttpGet("{id}")]
public IProduct Get(string id)
{
   IProduct product = _data.GetProduct(id);
   return product;
}

[HttpPut]
public Task Save(IProduct product)
{
    return _data.Save(product);
}

JsonConverter：

public class ProductConverter : System.Text.Json.Serialization.JsonConverter<IProduct> 
{
    public override IProduct Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
         // this code works from unit tests, trust me :)
    }

    public override void Write(Utf8JsonWriter writer, IProduct value, JsonSerializerOptions options) 
    {
        // this code works from unit tests, trust me :)
    }
}

启动：

services
  .AddControllers()
  .AddJsonOptions(options => {
      options.JsonSerializerOptions.Converters.Add(new ProductConverter());
  });

症状

• 当控制器的动作方法Save被调用时，ProductConverter.Read被调用
• 当控制器的动作方法Get被调用时，ProductConverter.Write方法不被调用
• 我得到了IProduct实际执行的json结果

我是否遗漏了什么或做错了什么？

Answer 1

Damien_The_Unbeliever 到 Why when return interface in a web api method, I get the values of inherited class with interface values? 的 answer 已经过时，但显然仍适用于 ASP.NET Core 3.1：

当它到达 Json 序列化器时，它并不关心方法的返回类型是什么。它只知道“我有这个对象，让我们看看我能用它做什么”。

因此不会调用您的转换器，因为返回的实际具体类型不是IProduct，因此基类实现JsonConverter<IProduct>.CanConvert(objectType) 返回false：

public override bool CanConvert(Type typeToConvert)
{
    return typeToConvert == typeof(T);
}

要使您的ProductConverter 也适用于IProduct 的具体实现，请按如下方式覆盖CanConvert：

public override bool CanConvert(Type typeToConvert) => 
    typeof(IProduct).IsAssignableFrom(typeToConvert);

请注意，如果Read() 和Write() 的实现尝试通过使用具体类型递归调用序列化程序来生成传入具体产品的“默认”序列化，则可能会出现堆栈溢出。要解决这个问题，您可以：

• 克隆选项并从转换器列表中删除ProductConverter，如How to use default serialization in a custom System.Text.Json JsonConverter?所示。

• 传入默认选项而不是传入选项，如 this answer 中所示 Demetrius Axenowski 到 Is polymorphic deserialization possible in System.Text.Json?。

• 将您的IProduct 包装在某个容器中，并将转换器应用于属性，例如

  public class ProductContainer 
  { 
      [JsonConverter(typeof(ProductConverter))] 
      public IProduct Product { get; set; } 
  }