日期：2025年 12月 20日

標籤： Asp.NET Core Asp.NET Core Web MVC C# SignalR dotnet runtime

摘要：C# 學習筆記

第一部分：問題描述

Step 1：問題描述 - 生產環境出現重複Log

在生產環境中的 GrayLog 中經常可以觀察到 Error Level 的信，並且都是 A task was canceled.
而且都是在工作時間出現 08:00 - 24:00 間，半夜都不會出現，但有關鍵字 /ClientHub 因此定位出 SignalR 不斷報此錯誤
問題是：為何會造成 & 最優解決方案為何 ??

Step 2：造成原因說明

在代碼中，我們追蹤到此錯誤是 .NET 原生的錯誤 ，在補捉 SignalR 的例外錯誤時，直接將 ex.Message 紀錄的關係

public class CustomerFilter : IHubFilter
{
    public async ValueTask<object> InvokeMethodAsync(HubInvocationContext invocationContext, Func<HubInvocationContext, ValueTask<object>> next)
    {
        var result = new object();            
        try
        {
            result = await next(invocationContext);
        }
        catch (Exception ex)
        {
            // 問題在此捕捉到 A Task was Canceled.
            Console.WriteLine(ex.Message);                
        }
        return result;
    }
}

會拋出此錯誤通常為以下狀況：

但上述 3 種都有一個共通點， 找不到客戶端訪問 ，導致伺服器端無法正常響應，如下圖解：

第二部分：如何重現此問題

Step 1：範例代碼架構

網路上很容易可以找出相關資源，但大多是說明的文字，我們可以進行重現驗證，保證是此問題造成
打開本篇範例代碼後，架構基本分成以下：

Step 2：範例代碼說明

我們添加以下 1. 2. 段代碼，代碼重現的準備就完成了，接著需要實際操作

/// <summary>
/// 接收前端傳送訊息
/// </summary>                
public async Task SendMessage(string user, string message)
{
    // 1. 重現步驟 - 使用 HubContext 內建的 CT
    var ct = Context.ConnectionAborted;
    await Task.Delay(10000, ct); // 2. 重現步驟 - 帶入 ct，客戶端中斷就會丟 TaskCanceledException
    var dataEntity = new SignalRMessagesEntity()
    {
        Message = message,
        SiteValues = _siteNumber,
        UserName = user,
        CreateTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
    };
    var jsonData = JsonConvert.SerializeObject(dataEntity);
    await _redisService.GetDb(0).SortedSetAddAsync(_RedisKey, jsonData, dataEntity.CreateTime);            
    await Clients.All.SendAsync("ReceiveMessage", jsonData.ToString(), ct);
}

Step 3：DEMO 操作流程 & 重現結果

接著我們要進行以下操作，執行 DEBUG 模式

如下圖，為整個重現的操作流程 Console Log 就出現 A task was canceled.

第三部分：解決方案

Step 1：處理方案 - 直接忽略

在實務中，遇到此問題，實務上最佳解法都是直接忽略，在代碼中應增加 TaskCanceledException , OperationCanceledException

public async ValueTask<object> InvokeMethodAsync(
  HubInvocationContext invocationContext, 
  Func<HubInvocationContext, ValueTask<object>> next)
{
    var result = new object();            
    try
    {
        result = await next(invocationContext);
    }
    catch (TaskCanceledException)
    {
        // 1. 正常中斷，不記 Error，不回前端，這行甚至可以註解
        Log.Debug($"[{ctx.HubMethod.Name}] client disconnected");        
    }
    catch (OperationCanceledException)
    {
        // 2. 正常中斷，這行甚至可以註解
        Log.Debug($"[{ctx.HubMethod.Name}] client connection aborted");
    }
    catch (Exception ex)
    {
        // 3. 真正的錯誤才記錄
        Log.Error(ex, $"[{ctx.HubMethod.Name}] error occurred");
    }
    return result;
}

Step 2：為何可以直接忽略 - 參考微軟文獻

Microsoft 微軟的 Working with Groups in SignalR說明
其中關鍵字段：

In general, you should not include await when calling the Groups.Remove method because the connection id that you are trying to remove might no longer be available. 
In that case, TaskCanceledException is thrown after the request times out. 
If your application must ensure that the user has been removed from the group before sending a message to the group, 
you can add await before Groups.Remove, and then catch the TaskCanceledException exception that might be thrown.

微軟已知道會有逾時的狀況，一般情況下，建議自行將 TaskCanceledException 捕捉到時排除

Step 3：比較其他處理方式

以下幾種處理是比較常見的作法，但也不能避免紀錄無謂的 A task was canceled.，只能減少 Log 紀錄量
因此最佳解 ： Microsoft 提供的作法 - 直接忽略 (亦是實務上大家公認的作法)

第四部分：結論

Step 1：總結 & 效益

正確處理 TaskCanceledException 與 OperationCanceledException，不是為了避免錯誤，而是為了讓系統能分辨「正常中斷」與「異常失敗」。
這是所有 SignalR 服務在走向穩定、高併發、可維護架構時的必要步驟。
效益總表列表：