.NET7下SignalR客户端启用Trimming裁剪的可行性与配置方法

关于.NET7 SignalR对裁剪的支持 #

.NET7的SignalR部分支持发布裁剪，但裁剪工具会移除未被静态分析识别到的类型成员（比如构造函数），而SignalR依赖System.Text.Json进行消息序列化，这就会触发你遇到的反序列化错误。

具体解决方法 #

1. 修复自定义类型的构造函数 #

SignalR使用的System.Text.Json在裁剪环境下，要求被序列化的类型满足以下条件之一：

• 包含无参构造函数
• 包含单个参数的构造函数
• 包含被[JsonConstructor]特性标记的多参数构造函数

示例代码：

// 方案1：添加无参构造函数
public class ChatMessage
{
    public ChatMessage() { }
    public string Sender { get; set; }
    public string MessageContent { get; set; }
}

// 方案2：给多参构造函数标记JsonConstructor
public class ChatMessage
{
    [JsonConstructor]
    public ChatMessage(string sender, string messageContent)
    {
        Sender = sender;
        MessageContent = messageContent;
    }
    public string Sender { get; set; }
    public string MessageContent { get; set; }
}

2. 保留第三方/无法修改类型的元数据 #

如果需要序列化的类型来自第三方库，无法修改构造函数，可以通过[DynamicDependency]特性告诉裁剪工具保留该类型的构造函数信息：

// 在项目的Program.cs或其他被裁剪工具扫描到的类中添加
[DynamicDependency(DynamicallyAccessedMemberTypes.PublicConstructors, typeof(ThirdPartyMessageType))]
public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);
        builder.Services.AddSignalR();
        // 其他配置
        var app = builder.Build();
        app.MapHub<ChatHub>("/chatHub");
        app.Run();
    }
}

也可以在csproj文件中直接指定需要保留元数据的程序集：

<ItemGroup>
  <!-- 替换为你的程序集名称 -->
  <TrimmerRootAssembly Include="YourSignalRMessageAssembly" />
</ItemGroup>

3. 确认SignalR的序列化配置 #

确保SignalR使用的是System.Text.Json（.NET7默认配置），如果自定义了序列化选项，不要修改导致构造函数识别逻辑失效：

builder.Services.AddSignalR()
    .AddJsonProtocol(options =>
    {
        // 保持默认的构造函数识别逻辑
        options.PayloadSerializerOptions = new JsonSerializerOptions
        {
            PropertyNameCaseInsensitive = true,
            // 其他必要配置，不要禁用构造函数相关的序列化逻辑
        };
    });

额外说明 #

.NET7的SignalR对裁剪的支持属于早期阶段，不如.NET8及以后版本完善。如果上述方法仍无法解决问题，可以考虑：

• 暂时对SignalR相关的消息类型禁用裁剪
• 升级到.NET8版本，获得更成熟的AOT/裁剪支持

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