.NET中如何将含不同派生类的JSON列表正确映射为DTO?
抽象基类集合的多态JSON反序列化配置方案
ASP.NET Core 默认的JSON序列化机制(无论是内置的System.Text.Json,还是旧版常用的Newtonsoft.Json),遇到抽象基类类型时无法自动完成具体派生类的映射,因为序列化器无法凭空推断出应该实例化哪个子类——尤其是需要根据JSON元素上的属性特征(是否存在propA/propB)判断子类类型的场景,没有开箱即用的配置项可以直接生效,需要通过自定义序列化转换器实现判断逻辑。
适配System.Text.Json(.NET 5+/ASP.NET Core默认内置序列化器)
两类可选实现路径
如果可以调整前端请求的JSON结构,给每个集合元素增加显式的类型标识字段(比如新增
"type": "ClassA"字段),可以直接用.NET 7版本之后新增的原生多态特性,不需要写自定义逻辑:// 在抽象基类上声明多态映射规则 [JsonPolymorphic(TypeDiscriminatorPropertyName = "type")] [JsonDerivedType(typeof(ClassA), typeDiscriminator: "ClassA")] [JsonDerivedType(typeof(ClassB), typeDiscriminator: "ClassB")] public abstract class BaseClass { }这种方式序列化器会根据JSON上的type字段值,自动匹配对应的派生类完成实例化。
如果必须兼容现有没有类型标识的JSON结构,靠元素上的propA/propB属性判断类型,就需要自定义JSON转换器,把判断逻辑显式写入:
首先实现针对BaseClass的自定义转换器:public class BaseClassJsonConverter : JsonConverter<BaseClass> { public override BaseClass? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { // 读取当前JSON节点为文档对象,方便做属性存在性判断 using var jsonDoc = JsonDocument.ParseValue(ref reader); var rootElement = jsonDoc.RootElement; // 按业务规则判别目标类型 if (rootElement.TryGetProperty("propA", out _)) { return JsonSerializer.Deserialize<ClassA>(rootElement.GetRawText(), options); } if (rootElement.TryGetProperty("propB", out _)) { return JsonSerializer.Deserialize<ClassB>(rootElement.GetRawText(), options); } throw new JsonException("集合元素无法匹配到对应的BaseClass派生类型"); } public override void Write(Utf8JsonWriter writer, BaseClass value, JsonSerializerOptions options) { // 序列化输出时按实际类型做分发处理 switch (value) { case ClassA classA: JsonSerializer.Serialize(writer, classA, options); break; case ClassB classB: JsonSerializer.Serialize(writer, classB, options); break; } } }接着把这个转换器注册到ASP.NET Core的全局序列化配置中,在Program.cs的服务配置段添加:
builder.Services.AddControllers() .AddJsonOptions(opt => { // 注入自定义转换器 opt.JsonSerializerOptions.Converters.Add(new BaseClassJsonConverter()); // 开启属性名大小写不敏感匹配,兼容JSON的小驼峰命名 opt.JsonSerializerOptions.PropertyNameCaseInsensitive = true; });
适配Newtonsoft.Json(旧项目常用序列化栈)
如果项目配置的是Newtonsoft.Json作为默认序列化器,可以用更简洁的自定义创建式转换器实现同样逻辑:
/// <summary> /// 通用的可识别类型的基类转换器 /// </summary> public abstract class CreationJsonConverter<T> : JsonConverter { protected abstract T CreateInstance(JObject jObject); public override bool CanConvert(Type objectType) { return typeof(T).IsAssignableFrom(objectType); } public override object? ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer) { var jObject = JObject.Load(reader); var targetInstance = CreateInstance(jObject); // 把识别到的实例交给序列化器完成属性填充 serializer.Populate(jObject.CreateReader(), targetInstance); return targetInstance; } public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer) { serializer.Serialize(writer, value); } } /// <summary> /// 针对BaseClass的具体类型判别逻辑 /// </summary> public class BaseClassNewtonsoftConverter : CreationJsonConverter<BaseClass> { protected override BaseClass CreateInstance(JObject jObject) { if (jObject["propA"] != null) { return new ClassA(); } if (jObject["propB"] != null) { return new ClassB(); } throw new JsonException("集合元素无法匹配到对应的BaseClass派生类型"); } }
对应的注册配置:
builder.Services.AddControllers() .AddNewtonsoftJson(opt => { opt.SerializerSettings.Converters.Add(new BaseClassNewtonsoftConverter()); });
注意事项
- 这类基于属性特征判断类型的映射逻辑,没有内置的配置可以通用实现,必须通过自定义转换器把业务判别规则显式落地。
- 后续如果新增BaseClass的派生类,只需要在自定义转换器的类型判断逻辑里,补充对应的属性匹配规则即可,不需要调整DTO的结构定义。
内容的提问来源于stack exchange,提问作者KDani
相关产品推荐
相关产品推荐

