Rest API动态GUID字段JSON反序列化问题排查与解决

你的问题核心是：JSON里的动态GUID字段和meta_data是同级的顶级属性，但默认的JSON序列化器只会把名为Devices的嵌套对象解析到Dictionary<Guid, DeviceInfo>类型的属性里，不会自动把顶级的GUID键映射到这个字典。下面是几种直接可行的解决方法：

方案1：自定义JSON转换器（Newtonsoft.Json） #

写一个针对RootObject的自定义转换器，手动处理顶级属性的映射：

1. 继承JsonConverter<RootObject>类，实现读写逻辑
2. 读取JSON对象后，单独提取meta_data赋值给Metadata属性
3. 遍历剩余的顶级属性，把符合GUID格式的键解析成DeviceInfo，存入Devices字典

代码示例：

public class RootObjectConverter : JsonConverter<RootObject>
{
    public override RootObject ReadJson(JsonReader reader, Type objectType, RootObject existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        var jo = JObject.Load(reader);
        var root = new RootObject();
        
        // 解析meta_data
        root.Metadata = jo["meta_data"].ToObject<Metadata>(serializer);
        
        // 处理动态GUID设备字段
        root.Devices = new Dictionary<Guid, DeviceInfo>();
        foreach (var prop in jo.Properties())
        {
            if (prop.Name.Equals("meta_data", StringComparison.OrdinalIgnoreCase))
                continue;
            
            if (Guid.TryParse(prop.Name, out var deviceId))
            {
                var deviceInfo = prop.Value.ToObject<DeviceInfo>(serializer);
                root.Devices[deviceId] = deviceInfo;
            }
        }
        
        return root;
    }

    public override void WriteJson(JsonWriter writer, RootObject value, JsonSerializer serializer)
    {
        var jo = new JObject();
        jo.Add("meta_data", JToken.FromObject(value.Metadata, serializer));
        
        foreach (var kvp in value.Devices)
        {
            jo.Add(kvp.Key.ToString(), JToken.FromObject(kvp.Value, serializer));
        }
        
        jo.WriteTo(writer);
    }
}

使用时，直接在RootObject类上标记特性：[JsonConverter(typeof(RootObjectConverter))]，或者在序列化器配置里添加这个转换器。

方案2：先接收为JObject再手动映射 #

如果不想写转换器，可以直接把请求内容接收为JObject，再手动映射到RootObject：

[HttpPost]
public IActionResult Post([FromBody] JObject request)
{
    var root = new RootObject();
    root.Metadata = request["meta_data"].ToObject<Metadata>();
    root.Devices = new Dictionary<Guid, DeviceInfo>();
    
    foreach (var prop in request.Properties())
    {
        if (prop.Name == "meta_data") continue;
        if (Guid.TryParse(prop.Name, out var guid))
        {
            root.Devices[guid] = prop.Value.ToObject<DeviceInfo>();
        }
    }
    
    // 这里写后续业务逻辑
    return Ok();
}

方案3：System.Text.Json自定义转换器（.NET Core默认序列化器） #

如果用的是.NET Core自带的System.Text.Json，写对应的自定义转换器：

public class RootObjectConverter : JsonConverter<RootObject>
{
    public override RootObject Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        using var doc = JsonDocument.ParseValue(ref reader);
        var root = new RootObject();
        var rootElement = doc.RootElement;
        
        // 解析meta_data
        if (rootElement.TryGetProperty("meta_data", out var metaElement))
        {
            root.Metadata = JsonSerializer.Deserialize<Metadata>(metaElement.GetRawText(), options);
        }
        
        // 处理动态GUID设备
        root.Devices = new Dictionary<Guid, DeviceInfo>();
        foreach (var property in rootElement.EnumerateObject())
        {
            if (property.Name.Equals("meta_data", StringComparison.OrdinalIgnoreCase))
                continue;
            
            if (Guid.TryParse(property.Name, out var deviceId))
            {
                var deviceInfo = JsonSerializer.Deserialize<DeviceInfo>(property.Value.GetRawText(), options);
                root.Devices[deviceId] = deviceInfo;
            }
        }
        
        return root;
    }

    public override void Write(Utf8JsonWriter writer, RootObject value, JsonSerializerOptions options)
    {
        writer.WriteStartObject();
        writer.WritePropertyName("meta_data");
        JsonSerializer.Serialize(writer, value.Metadata, options);
        
        foreach (var kvp in value.Devices)
        {
            writer.WritePropertyName(kvp.Key.ToString());
            JsonSerializer.Serialize(writer, kvp.Value, options);
        }
        
        writer.WriteEndObject();
    }
}

然后在Program/Startup里注册转换器：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new RootObjectConverter());
    });

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