在上一篇文章《如何正確實現一個 BackgroundService》中有提到 LongRunning 來優化后臺任務始終保持在同一個線程上。

        protected override Task ExecuteAsync(CancellationToken stoppingToken)
        {
            return Task.Factory.StartNew(async () =>
            {
                while (!stoppingToken.IsCancellationRequested)
                {
                    // Simulate some work
                    Console.WriteLine("HostServiceTest_A is doing work.");
                    LongTermTask();
                    await Task.Delay(1000, stoppingToken); // Delay for 1 second
                }
                Console.WriteLine("HostServiceTest_A task done.");
            }, TaskCreationOptions.LongRunning);
        }
        private void LongTermTask()
        {
            // Simulate some work
            Console.WriteLine("LongTermTaskA is doing work.");
            Thread.Sleep(30000);
        }

但是被 大佬指出這個用法是錯誤的：以上用法并不能保證任務始終在同一個 Task(線程) 上執行。原因是當碰到第一個 await 之后運行時會從 ThreadPool 中調度一個新的線程來執行后面的代碼，而當前線程被釋放。這個時候就不符合我們使用 LongRunning 的期望了。

在 .NET 中，Task.Factory.StartNew 提供了 TaskCreationOptions.LongRunning 選項，很多開發者會用它來啟動長時間運行的任務，并且想當然的認為它會永遠執行在同一個線程上。但是事實上當遇到 async await 的時候并想象的那么簡單。

下面我們還是通過一個錯誤的示例開始講解如何正確的使用它。

錯誤用法

很多人會直接在 Task.Factory.StartNew 里傳入一個 async 方法：

// See https://aka.ms/new-console-template for more information
Console.WriteLine("Hello, World!");
var task = Task.Factory.StartNew(async () =>
{
    Console.WriteLine($"long running task starting. Thread id: {Thread.CurrentThread.ManagedThreadId}");
    var loopCount = 1;
    while (true)
    {
        Console.WriteLine($"\r\nStart: loop count: {loopCount}, Thread id: {Thread.CurrentThread.ManagedThreadId}");
        await LongRunningJob();
        Console.WriteLine($"End: loop count: {loopCount}, Thread id: {Thread.CurrentThread.ManagedThreadId} \r\n ");
        loopCount++;
    }
}, TaskCreationOptions.LongRunning);
static async Task LongRunningJob()
{
    Console.WriteLine($"task doing. Thread id: {Thread.CurrentThread.ManagedThreadId}");
    await Task.Delay(1000);
}
Console.ReadLine();

輸出：

Hello, World!
long running task starting. Thread id: 12
Start: loop count: 1, Thread id: 12
task doing. Thread id: 12
End: loop count: 1, Thread id: 11
Start: loop count: 2, Thread id: 11
task doing. Thread id: 11
End: loop count: 2, Thread id: 11

可以看到，第一次循環后，線程 id 發生了變化。很明顯 LongRunning 失效了。原因開篇已經講了，不在贅述。

正確用法 1：同步方法

將 LongRunningJob 改為同步方法，避免異步切換線程：

var task = Task.Factory.StartNew(() =>
{
    Console.WriteLine($"long running task starting. Thread id: {Thread.CurrentThread.ManagedThreadId}");
    var loopCount = 1;
    while (true)
    {
        Console.WriteLine($"\r\nStart: loop count: {loopCount}, Thread id: {Thread.CurrentThread.ManagedThreadId}");
        LongRunningJob();
        Console.WriteLine($"End: loop count: {loopCount}, Thread id: {Thread.CurrentThread.ManagedThreadId} \r\n ");
        loopCount++;
    }
}, TaskCreationOptions.LongRunning);
static void LongRunningJob()
{
    Console.WriteLine($"task doing. Thread id: {Thread.CurrentThread.ManagedThreadId}");
    Thread.Sleep(1000);
}

輸出：

Hello, World!
long running task starting. Thread id: 12
Start: loop count: 1, Thread id: 12
task doing. Thread id: 12
End: loop count: 1, Thread id: 12

線程 id 始終不變，說明始終運行在專用線程上。

正確用法 2：異步方法同步等待

如果必須用異步方法，可以用 .Wait() 讓調用變為同步：

var task = Task.Factory.StartNew(() =>
{
    Console.WriteLine($"long running task starting. Thread id: {Thread.CurrentThread.ManagedThreadId}");
    var loopCount = 1;
    while (true)
    {
        Console.WriteLine($"\r\nStart: loop count: {loopCount}, Thread id: {Thread.CurrentThread.ManagedThreadId}");
        LongRunningJob().Wait();
        Console.WriteLine($"End: loop count: {loopCount}, Thread id: {Thread.CurrentThread.ManagedThreadId} \r\n ");
        loopCount++;
    }
}, TaskCreationOptions.LongRunning);
static async Task LongRunningJob()
{
    Console.WriteLine($"task doing. Thread id: {Thread.CurrentThread.ManagedThreadId}");
    await Task.Delay(1000);
}

輸出：

Hello, World!
long running task starting. Thread id: 12
Start: loop count: 1, Thread id: 12
task doing. Thread id: 12
End: loop count: 1, Thread id: 12

總結

• TaskCreationOptions.LongRunning 適用于同步、阻塞型任務。
• 不要在 StartNew 里直接用 async 方法。
• 如果必須用異步方法，需同步等待（如 .Wait()）。

希望本文能幫你正確理解和使用 LongRunning 任務！

轉自https://www.cnblogs.com/kklldog/p/19022317