一次.net core非同步執行緒設定超時時間的實戰記錄

2022-02-11 19:11:51

前言:

刷貼文看到一篇 Go 記錄一次groutine通訊與context控制看了一下需求背景,挺有意思的,琢磨了下.net core下的實現

需求背景:

專案中需要定期執行任務A來做一些輔助的工作，A的執行需要在超時時間內完成，如果本次執行超時了，那就不對本次的執行結果進行處理（即放棄這次執行）。同時A又依賴B，C兩個子任務的執行結果。B, C之間相互獨立，可以並行的執行。但無論B,C哪一個執行失敗或超時都會導致本次任務執行失敗。

需求提煉:

A任務必須在指定時間內完成,否則任務失敗
A任務依賴B,C任務,B,C可以並行,任何一個失敗,則A任務失敗
A任務在超時時間內,是否需求記錄子任務執行詳情(根據業務需求來定)

.net裡設定超時的 Task

public static class TaskHelper
{

    // 有返回值
    public static async Task<TResult> TimeoutAfter<TResult>(this Task<TResult> task, TimeSpan timeout)
    {
        using (var timeoutCancellationTokenSource = new CancellationTokenSource())
        {
            var completedTask = await Task.WhenAny(task, Task.Delay(timeout, timeoutCancellationTokenSource.Token));
            if (completedTask == task)
            {
                timeoutCancellationTokenSource.Cancel();
                return await task;  // Very important in order to propagate exceptions
            }
            else
            {
                throw new TimeoutException("The operation has timed out.");
            }
        }
    }

    // 無返回值
    public static async Task TimeoutAfter(this Task task, TimeSpan timeout)
    {
        using (var timeoutCancellationTokenSource = new CancellationTokenSource())
        {
            var completedTask = await Task.WhenAny(task, Task.Delay(timeout, timeoutCancellationTokenSource.Token));
            if (completedTask == task)
            {
                timeoutCancellationTokenSource.Cancel();
                await task;  // Very important in order to propagate exceptions
            }
            else
            {
                throw new TimeoutException("The operation has timed out.");
            }
        }
    }
}

這裡參考資料,寫了個拓展方法,主要用到CancellationTokenSource 與 Task.WhenAny

可以參考 C#中CancellationToken和CancellationTokenSource用法

可以參考 Task.WhenAny 方法

這裡需要特別注意,在非同步操作裡,如果非同步已經執行了，再執行取消時無效的，這是就需要我們自己在非同步委託中檢測了

知道了這兩個函數的作用,這段程式碼就很好理解了,通過Task.WhenAny返回最先完成的任務,如果是業務任務先完成,則呼叫timeoutCancellationTokenSource.Cancel()終止超時任務,等待業務任務結果,反之則直接丟擲timeout異常

測試程式碼

    [TestMethod]
    public async Task TestMethod1()
    {
        //A 任務必須在指定時間內完成,否則任務失敗
        //A 任務依賴B,C任務,B,C可以並行,任何一個失敗,則A任務失敗
        //A任務
        try
        {
            //有效時間3s
            var timeOut = TimeSpan.FromSeconds(3);
            await Task.Run(async () =>
            {
                List<Task<(string, bool)>> tasks = new List<Task<(string, bool)>>();
                //B任務
                tasks.Add(Task.Run(async () =>
                {
                    return ("B", await TestTask("B"));
                }).TimeoutAfter(timeOut));

                //C任務
                tasks.Add(Task.Run(async () =>
                {
                    return ("C", await TestTask("C"));
                }).TimeoutAfter(timeOut));

                var res = await Task.WhenAll(tasks);

                //兩個任務,任何一個失敗,則A任務失敗
                foreach (var item in res)
                {
                    Console.WriteLine(item);
                }

            }).TimeoutAfter(timeOut);

        }
        catch (Exception ex)
        {
            Console.WriteLine("A任務執行超時了");
        }

        //await Task.Delay(3000);


    }

    public async Task<bool> TestTask(string name) 
    {
        var startTime = DateTime.Now;
        Console.WriteLine($"{startTime}---->{name}任務開始執行");
        //隨機堵塞1-5s
        var t = new Random().Next(1, 5);
        await Task.Delay(t * 1000);

        var endTime = DateTime.Now; ;
        var time = (endTime - startTime).TotalSeconds;

        //亂數,模擬業務是否成功
        var res = new Random().Next(1, 10);
        Console.WriteLine($"{endTime}---->{name}任務執行完畢,耗時{time} s");
        return res <= 7;
    }