.NET Core SignalR で別スレッドから Progress 表示したい

Question

実現したいこと

VS2022 .Net Core 8.0 ASP.NET Core Webアプリ(Razor Pages)で
公式チュートリアルのチャットを少し改造してサーバタスクの進捗表示を行おうとしています。
サーバ側処理を別スレッドとして行おうとすると Hub の Clients.Client 参照で例外が発生してしまいます。
参照：
https://learn.microsoft.com/ja-jp/aspnet/core/tutorials/signalr?view=aspnetcore-3.1&tabs=visual-studio

発生している問題・分からないこと

ボタン押下１回目の処理はＯＫですが２回目で以下 Clients が Disposed されているというエラーになってしまします。
何か解決策お分かりの方いらっしゃいますでしょうか？

エラーメッセージ

Clients = 'Clients' は型 'System.ObjectDisposedException' の例外をスローしました
例外がスローされました: 'System.ObjectDisposedException' (System.Private.CoreLib.dll の中)
型 'System.ObjectDisposedException' の例外が System.Private.CoreLib.dll で発生しましたが、ユーザー コード内ではハンドルされませんでした
Cannot access a disposed object.

該当のソースコード

public class ProgressHub : Hub
{
    static void ThreadMethod(IClientProxy cl, int delay) // ★これは追加
    {
        for (int i = 0; i < 5; i++)
        {
            Thread.Sleep(delay);
            cl.SendAsync("ReceiveMessage", "notify", $"msg-{i}");
        }
    }
    public async Task SendMessage(string user, string message)
    {
        // ★ここを変更
        //await Clients.Client(user).SendAsync("ReceiveMessage", user, message);
        Thread thread1 = new Thread(() => ThreadMethod(Clients.Client(user), 500)); //ここで例外
        thread1.Start();
        // これは何回やっても問題なし
        // ThreadMethod(Clients.Client(user), 500);
        
        await Task.Delay(0);
    }
}

//.NET8.0 では Setup.cs が無くなってますが Program.cs に同じ内容を書けば良い様です。
// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddSignalR();      // ★ここを変更
  ・・・
app.MapRazorPages();
app.MapHub<ProgressHub>("/progressHub");  // ★ここを変更
  ・・・

document.getElementById("sendButton").addEventListener("click", function (event) {
    //var user = document.getElementById("userInput").value;
    var user = connection.connection.connectionId; // ★ここを変更
    var message = document.getElementById("messageInput").value;
    connection.invoke("SendMessage", user, message).catch(function (err) {
        return console.error(err.toString());
    });
    event.preventDefault();
});

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

別スレッドにしなければOKなのですが、リクエストが戻ってくるまでクライアントから別のリクエストをすることができないので困っています。

補足

特になし

Answer 1

原因はHubインスタンス破棄後に、そのメンバーを別スレッドで参照している、ただ破棄タイミングによっては、時折成功するのではと思います。

対策案として、ThreadMethod()にuser名（文字列）を渡して、普通にSignalRとして送信するメソッドを作ります。また現代のC#では new Thread()はしないのでそれも修正します。

1.ThreadMethod()をクラス に切り出し

別のクラス HeavyWork を作り重たい処理を移動。SignalR送信用にIHubContextを注入。

public class HeavyWork(IHubContext<ProgressHub> hub)
{
    public async Task ThreadMethod(string user, int delay)
    {
        //ProgressHubからクライアントを取得
        var client = hub.Clients.Client(user);
        for (int i = 0; i < 5; i++)
        {
            await Task.Delay(delay);
            await client.SendAsync("ReceiveMessage", "notify", $"msg-{i}");
        }
    }
}

2.HeavyWork クラスをサービス登録

作ったクラスをサービス登録。Program.cs の var app = builder.Build();より前に1行追記

builder.Services.AddSingleton<HeavyWork>();

3.ProgressHub クラス修正

ThreadPoolを使って実行。

public class ProgressHub(HeavyWork heavy) : Hub
{
    public void SendMessage(string user, string message)
    {
        //別スレッドで実行
        _ = Task.Run(() => heavy.ThreadMethod(user, 500));
    }
}

重たい処理の内容が分からないのでそのままThreadPoolで実行する例にしましたが、
処理内容によっては重たい処理はBackgourndServiceとして登録、待機し、それをSignalR契機で起動させるような形のほうが適しているかもしれません。

追記

別案も書いておきます。 こちらのほうがProgressHub.csの変更のみで、別スレッド内でどうすべきかも理解しやすいかも。

public class ProgressHub(IServiceScopeFactory factory) : Hub 
{
    public void SendMessage(string user, string message) {
        _ = Task.Run(() => {
            using var scoped = factory.CreateScope();
            var hub = scoped.ServiceProvider.GetRequiredService<IHubContext<ProgressHub>>();
            var client = hub.Clients.Client(user);
            ThreadMethod(client, 500);
        });
    }
    static void ThreadMethod(IClientProxy cl, int delay) {
        //変更なし
    }

Comments

[menshan]

回答ありがとうございます。
素晴らしいです。

何回ボタンを押してもエラーが出なくなりました。
サービス登録という事をしないといけないのですね。
もっとC#勉強しなくては!

重たい処理はBackgourndServiceにするほどでもないので提示頂いたThreadPoolにしたいと思います。
ベストアンサーに選ばせていただきました。

[hqf00342]

動いたようで良かったです。
少し気になったのでサービス登録部分を修正しました。

説明をだいぶ端折ってしまいましたが、元コードのスレッドはスレッド内からスレッドの外のClientsを利用しようとした＝スレッドセーフではない、ということです。
別のクラスに切り出してもスレッドの外のオブジェクトたちにアクセスすると同じような事になる可能性があるので、スレッドセーフになるよう気をつけましょう。

[menshan]

別案の提示ありがとうございます。
こちらの方が Program.cs も修正不要でいいですね。

重たい処理の方は別のクラスに切り出してClientにはアクセスさせない方がいいかなと思いましたので以下の様にしました。

class HeavyWork
{
public delegate void CallBackNotify(string msg);
public void SomeJob(int delay, CallBackNotify callBackNotify)
{
for (int i = 0; i < 5; i++)
{
Thread.Sleep(delay);
callBackNotify($"msg-{i}");
}
}
}

static void ThreadMethod(IClientProxy cl, int delay) // ★これは追加
{
HeavyWork hw = new HeavyWork();
hw.SomeJob(delay,(msg)=> {
cl.SendAsync("ReceiveMessage", "notify", msg);
});
}