如何调试SignalR以排查类实例无法从服务器传输到WPF客户端的问题

问题背景 #

使用SignalR实现ASP.NET服务器与WPF客户端通信，共享类库中的LogItem类无法正常传输：服务器发送后，客户端HubConnection.On<LogItem>("NewLogItem", (logItem)=> OnNewLogItemFromServer(logItem))的回调从未触发，但用HubConnection.On<Object>能收到JsonElement类型数据。要求按SignalR设计方式使用，无需手动解析JSON，需要通用调试方法而非仅解决当前问题。

通用SignalR序列化调试步骤 #

1. 开启详细日志排查 #

• 服务器端：在appsettings.json中配置SignalR和System.Text.Json的日志级别至Debug或Trace：

{
  "Logging": {
    "LogLevel": {
      "Microsoft.AspNetCore.SignalR": "Debug",
      "Microsoft.AspNetCore.Http.Connections": "Debug",
      "System.Text.Json": "Trace"
    }
  }
}

启动服务器后，查看日志中是否存在序列化/反序列化失败的异常信息，比如类型不匹配、无法访问的成员、循环引用等。

• 客户端（WPF）：初始化HubConnection时添加日志监听：

var connection = new HubConnectionBuilder()
    .WithUrl("your_hub_url")
    .ConfigureLogging(logging =>
    {
        logging.SetMinimumLevel(LogLevel.Debug);
        logging.AddConsole(); // 可替换为WPF适配的日志提供器
    })
    .Build();

查看客户端日志中是否有反序列化失败的报错，SignalR会明确指出哪个属性或类型无法解析。

2. 手动验证序列化兼容性 #

用System.Text.Json直接测试类的序列化/反序列化，快速定位问题根源：

var logItem = new LogItem(1, LogCategory.Test, LogLevel.Information, "test message");
var json = JsonSerializer.Serialize(logItem);
try
{
    var deserialized = JsonSerializer.Deserialize<LogItem>(json);
}
catch (JsonException ex)
{
    Console.WriteLine(ex.Message); // 异常信息会直接指出问题点
}

若此步骤抛出异常，说明问题出在类本身的序列化兼容性，而非SignalR框架。

3. 逐步简化类结构排查 #

• 先创建极简版LogItem（仅保留Id、Message等基础属性），测试是否能正常传输。若可行，再逐个添加原类的属性，每添加一个就测试一次，直到找到导致失败的属性。
• 重点排查方向：
  • 未标记可序列化的属性（如DateTime未加[DataMember]，但类上有[DataContract]，会导致DataContract模式下该属性被忽略）
  • 复杂类型属性（如Exception，System.Text.Json默认无法正确序列化Exception对象）
  • 继承基类的影响（如ObservableObject的PropertyChanged事件可能被序列化尝试）
  • [JsonIgnore]/[XmlIgnore]标记是否干扰了其他属性的解析

4. 校验类型匹配与命名规则 #

• 确保服务器与客户端的共享类库版本完全一致，避免类结构差异导致反序列化失败。
• SignalR默认使用System.Text.Json的驼峰命名策略，若类属性为PascalCase而JSON为camelCase，需统一序列化配置：
  服务器端：

builder.Services.AddSignalR()
    .AddJsonProtocol(options =>
    {
        options.PayloadSerializerOptions.PropertyNamingPolicy = null; // 禁用驼峰命名，保持与类属性一致
    });

客户端：

var connection = new HubConnectionBuilder()
    .WithUrl("your_hub_url")
    .AddJsonProtocol(options =>
    {
        options.PayloadSerializerOptions.PropertyNamingPolicy = null;
    })
    .Build();

当前LogItem类的问题分析 #

结合提供的代码，几个高概率问题点：

1. DateTime属性序列化冲突：类上标记了[DataContract]，但DateTime属性未加[DataMember]，在DataContract模式下该属性会被忽略，与JSON序列化规则冲突。建议要么移除[DataContract]/[DataMember]标记，要么给所有需要传输的属性添加[DataMember]。
2. Exception属性序列化失败：Exception类包含大量无法被System.Text.Json正常序列化的内部属性（如StackTrace、TargetSite），直接传输会导致反序列化失败。建议仅传输Exception的关键信息（如Message、StackTrace）到MoreInfo属性，同时移除Exception属性的[DataMember]标记。
3. 基类ObservableObject的影响：ObservableObject实现的PropertyChanged事件可能被序列化尝试，导致失败。可在序列化选项中配置忽略只读属性/字段：

options.PayloadSerializerOptions.IgnoreReadOnlyProperties = true;
options.PayloadSerializerOptions.IgnoreReadOnlyFields = true;

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