C#中使用Newtonsoft.Json解析非完整键值对的JSON

嘿，这个场景我做平板和PC端的C/S通信时刚好遇到过，Newtonsoft.Json确实很灵活，针对你说的“不确定消息里实际发送了哪些键”的问题，给你几个实用的解决方案：

1. 直接用JObject解析（最灵活） #

JObject是Newtonsoft.Json里的动态JSON对象，可以直接获取所有存在的键，还能快速判断某个键是否存在：

// 假设收到的JSON字符串
string receivedJson = "{\"Cmd\":\"Sync\",\"DeviceId\":\"Tab-001\",\"BatteryLevel\":85}";

// 解析成JObject
JObject jsonObj = JObject.Parse(receivedJson);

// 检查某个特定键是否存在
if (jsonObj.ContainsKey("BatteryLevel"))
{
    int battery = jsonObj["BatteryLevel"].Value<int>();
    Console.WriteLine($"平板电量: {battery}%");
}

// 遍历所有实际存在的键值对
foreach (var property in jsonObj.Properties())
{
    Console.WriteLine($"键名: {property.Name}, 值: {property.Value}");
}

这个方法完全不依赖预定义的DTO类，适合消息结构多变的场景，调试也很方便。

2. 结合DTO类+可空类型（类型安全） #

如果你的消息有固定的基础结构，但部分字段可选，可以把可选字段定义为可空类型，反序列化后通过HasValue判断是否存在：

// 定义基础消息类
public class DeviceMessage
{
    // 假设Cmd是必填项
    [JsonProperty("Cmd")]
    public string Command { get; set; }

    [JsonProperty("DeviceId")]
    public string DeviceId { get; set; }

    // 可选字段用可空类型
    [JsonProperty("BatteryLevel")]
    public int? BatteryLevel { get; set; }

    [JsonProperty("SyncData")]
    public string SyncData { get; set; } // 引用类型默认null，也能判断是否未传
}

// 反序列化
DeviceMessage msg = JsonConvert.DeserializeObject<DeviceMessage>(receivedJson);

// 判断可选字段是否存在
if (msg.BatteryLevel.HasValue)
{
    // 处理电量数据
}

if (!string.IsNullOrEmpty(msg.SyncData))
{
    // 处理同步数据
}

这种方式兼顾了类型安全和灵活性，适合大部分结构化的通信场景。

3. 动态类型（慎用） #

你也可以用dynamic来解析，但要注意运行时绑定的风险——如果键不存在会抛出RuntimeBinderException，所以需要加异常处理：

dynamic dynamicMsg = JObject.Parse(receivedJson);
try
{
    int battery = dynamicMsg.BatteryLevel;
    // 存在该键时执行逻辑
}
catch (RuntimeBinderException)
{
    // 键不存在时的处理
}

这个方法代码简洁，但调试和维护起来比较麻烦，不推荐在复杂场景下使用。

进阶：根据消息类型动态反序列化 #

如果你的通信有多种消息类型（比如Ping、Sync、Data等），可以先解析出消息类型，再反序列化成对应的子类，既规范又灵活：

// 抽象基类
public abstract class BaseMessage
{
    public string MsgType { get; set; }
}

// 具体消息类
public class PingMessage : BaseMessage
{
    public long Timestamp { get; set; }
}

public class SyncMessage : BaseMessage
{
    public string DeviceId { get; set; }
    public int BatteryLevel { get; set; }
}

// 解析流程
JObject jsonObj = JObject.Parse(receivedJson);
string msgType = jsonObj["MsgType"].Value<string>();
BaseMessage message = null;

switch (msgType)
{
    case "Ping":
        message = jsonObj.ToObject<PingMessage>();
        break;
    case "Sync":
        message = jsonObj.ToObject<SyncMessage>();
        break;
}

// 类型判断处理
if (message is PingMessage ping)
{
    Console.WriteLine($"Ping请求，时间戳: {ping.Timestamp}");
}
else if (message is SyncMessage sync)
{
    Console.WriteLine($"同步请求，设备ID: {sync.DeviceId}");
}

这种方式非常适合客户端服务器的通信场景，能清晰区分不同的消息逻辑。

总的来说，优先推荐JObject或者DTO+可空类型的组合，既能满足灵活性，又能保证代码的可维护性。

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