.NET Core 2.0下SignalR发送模型静默失败，如何诊断及排查原因？

首先，这个静默失败的核心原因是循环引用导致的JSON序列化失败。你的User和Post模型是双向关联的：User包含Posts集合，每个Post又关联回对应的User。当调用SaveChanges()后，EF Core会自动跟踪这个模型对象，并且填充导航属性——也就是说，model.User.Posts里已经包含了你刚添加的这个Post，而这个Post又指向model.User，形成了User → Posts → Post → User → ...的无限循环。

SignalR在尝试将这个模型序列化为JSON发送给客户端时，序列化器无法处理这种循环引用，会抛出异常，但默认情况下SignalR不会暴露这个异常，就表现为“静默失败”，没有消息推送到客户端。而你把model.User.Posts = null后切断了循环，序列化就能正常完成，消息也就发出去了。

诊断步骤 #

你可以通过以下方式验证这个问题：

1. 手动序列化测试：在SendAsync之前，尝试手动将model序列化为JSON，查看是否抛出循环引用异常：

   using Newtonsoft.Json;
   try
   {
       var json = JsonConvert.SerializeObject(model);
       Console.WriteLine(json);
   }
   catch (Exception ex)
   {
       Console.WriteLine(ex.Message); // 这里会看到循环引用相关的错误提示
   }
   

2. 启用SignalR日志：配置SignalR的日志级别，查看序列化失败的日志信息。在Startup.cs中添加日志配置：

   public void ConfigureLogging(ILoggingBuilder logging)
   {
       logging.AddConsole();
       logging.SetMinimumLevel(LogLevel.Debug);
   }
   

   运行后查看控制台日志，能找到序列化失败的相关记录。

解决方案 #

针对这个问题，有几种常用的解决方式，按推荐程度排序：

1. 使用DTO（数据传输对象） #

这是最推荐的做法，能明确控制传递给客户端的数据，避免不必要的字段和循环引用。创建专门的PostDto类，只包含客户端需要的字段：

public class PostDto
{
    public Guid Id { get; set; }
    // 其他Post的必要字段...
    public UserDto User { get; set; }
}

public class UserDto
{
    public Guid Id { get; set; }
    // 其他User的必要字段...
    // 不要包含Posts集合！
}

发送时将model映射为PostDto：

var postDto = new PostDto
{
    Id = model.Id,
    // 映射其他字段...
    User = new UserDto { Id = model.User.Id /* 映射User的必要字段 */ }
};
_hub.Clients.All.SendAsync("AddAsync", postDto);

你也可以用AutoMapper这类工具简化对象映射。

2. 配置序列化器忽略循环引用 #

如果不想用DTO，可以修改JSON序列化器的配置，让它忽略循环引用：

若使用Newtonsoft.Json（.NET Core 2.0默认SignalR使用此序列化器）

在Startup.cs的ConfigureServices中配置：

services.AddSignalR()
    .AddJsonProtocol(options =>
    {
        options.PayloadSerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
    });

这样序列化器遇到循环引用时会自动忽略，不会抛出异常，消息就能正常发送。不过这种方式可能会忽略一些你不期望的字段，不如DTO可控。

3. 断开EF Core的跟踪 #

在SaveChanges()之后，将模型从EF上下文的跟踪中分离，避免导航属性被自动填充循环引用：

_context.Posts.Add(model);
_context.SaveChanges();
_context.Entry(model).State = EntityState.Detached; // 断开跟踪
_hub.Clients.All.SendAsync("AddAsync", model);

不过这种方式可靠性稍差，如果导航属性已经被EF填充，断开跟踪也无法移除已有的循环引用。

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