C# 實現你自己的非同步方法

背景

最近在重構自己曾經的代碼， 具體需求是在Unity等待如一個模型動畫， 一段ui動畫 如下：

Await的目標

await的目標是一個可等待對象， 而擁有GetAwaiter方法並且該方法擁有合適返回值的目標即可稱為可等待對象（暫時你還不需要知道返回值需要符合什麼規則，待會兒Studio會告訴你）

首先，我們通過一些簡單的代碼來模擬Unity的Slider， 並且實現一個方法來模擬ui動畫， 然後在實例化它來看看效果

public class Slider
{
    public void ValueTo(int value)
    {
        Task.Run(async () => 
        {
            Console.Write("HP: ");
            for (int i = 0; i < value; i++)
            {
                await Task.Delay(350);
                Console.Write("■");
            }
            Console.Write("\n");
        });
    }
}

效果不錯， 現在你希望可以await slider.ValueTo 方法， 而不是再通過使用回調函數傳來傳去來監聽如動畫是否結束

首先我們知道await的目標是一個擁有GetAwaiter方法的對象

簡單點， 我們令Slider本身是可等待的， 也即我們需要在Slider上實現一個GetAwaiter方法， 已知且其返回值有一定的限制， 我們假設其返回值為SliderAwaiter

public class SliderAwaiter
{

}
public class Slider
{
    public SliderAwaiter GetAwaiter()
    {
        SliderAwaiter awaiter = new SliderAwaiter();
        return awaiter;
    }
    public Slider ValueToAsync(int value)
    {
        /*
         * Task是可等待的， 這裡直接返回Task即可在這裡達成我們的目標
         * 但本文的主要討論的是實現 自己 的非同步方法
         * 並且UI動畫你可以以此法逃課， 但播放動畫就不好逃了
         */
        Task.Run(async () => 
        {
            Console.Write("HP: ");
            for (int i = 0; i < value; i++)
            {
                await Task.Delay(350);
                Console.Write("■");
            }
            Console.Write("\n");
        });
        return this;
    }
}

當我們嘗試在Main中直接await ValueToAsync方法時， 編譯器報錯（“Program.SliderAwaiter”未包含“IsCompleted”的定義）， 我們進行修補。又報錯（“Program.SliderAwaiter”不實現“INotifyCompletion”）， 繼續修， 最後一個報錯（“Program.SliderAwaiter”未包含“GetResult”的定義）， 補上

經過修補， 我們得到這樣的SliderAwaiter

public class SliderAwaiter : INotifyCompletion
{
    public bool IsCompleted => false;

    public void OnCompleted(Action continuation)
    {

    }
    public void GetResult() { }
}

直接await ValueToAsync測試，發現Slider表現正常， 但await並沒有觸發

這裡暫時先直接告訴你答案， 你需要手動觸發OnCompleted傳入的continuation來觸發await後的代碼

簡單改造一下SliderAwaiter和Slider得到下麵的代碼

public class SliderAwaiter : INotifyCompletion
{
    public bool IsCompleted => false;
    public Action onFinish;
    public void OnCompleted(Action continuation)
    {
        if (IsCompleted)
        {
            continuation?.Invoke();
            onFinish?.Invoke();
        }
        else
        {
            onFinish += continuation;
        }
    }
    /// <summary>
    /// 手動觸發 continuation
    /// </summary>
    public void ReportResult()
    {
        onFinish?.Invoke();
    }
    public void GetResult() { }
}
public class Slider
{
    SliderAwaiter awaiter;
    public SliderAwaiter GetAwaiter()
    {
        SliderAwaiter awaiter = new SliderAwaiter();
        this.awaiter = awaiter;
        return awaiter;
    }
    public Slider ValueToAsync(int value)
    {
        Task.Run(async () => 
        {
            Console.Write("HP: ");
            for (int i = 0; i < value; i++)
            {
                await Task.Delay(350);
                Console.Write("■");
            }
            Console.Write("\n");
            awaiter?.ReportResult();
        });
        return this;
    }
}

在Main函數中測試一下， 神奇的事情發生了， await後的代碼成功且正確地執行了

你可能覺得有些奇妙， 你只是手動觸發了OnCompleted傳入的後續操作（類似Task.ContinueWith）就成功觸發了結束等待， 你可能也會嘗試在ReportResult中多次執行continuation， 但await的後續代碼依舊只執行一次

OnCompleted中的continuation是什麼， 它做了什麼

瞭解他之前， 你可能需要先瞭解await是如何運行的， 首先你需要知道await的實現是基於狀態機

簡單點， 我們把測試代碼改的簡單點

static async Task Main(string[] args)
{
    Console.WriteLine("before await");
    await Task.Delay(500);
    Console.WriteLine("after  await");
    Console.Read();
}

然後通過dnSpy看看生成的中間語言是什麼樣的， 從下圖和標註你應該可以清晰地看出程式的整體走向

通過簡單測試代碼的中間語言我們瞭解了await的大致走向， 那麼回到最初的問題，continuation究竟做了什麼

還原我們剛剛模擬Unity Slider的代碼， 繼續藉助dnSpy， 二話不說找到ReportResult方法並且打上斷點， 看看他做了什麼

是的！一進來就發現一個驚喜， 第一步就跳轉到一個叫做MoveNext的方法， 最終經過一番閃轉騰挪我們又回到了的狀態機里！

我們可以通過手動執行continuation來手動觸發我們自己的awaiter！

至此， 你應該瞭解瞭如何實現自己的非同步方法， 並且它不用依賴Task， TaskCompletionSource

最後附上完整的測試代碼， 希望本片文章對你的非同步之旅有所幫助

internal class Program
{
    public class SliderAwaiter : INotifyCompletion
    {
        public bool IsCompleted => false;
        public Action onFinish;
        public void OnCompleted(Action continuation)
        {
            if (IsCompleted)
            {
                continuation?.Invoke();
                onFinish?.Invoke();
            }
            else
            {
                onFinish += continuation;
            }
        }
        /// <summary>
        /// 手動觸發 continuation
        /// </summary>
        public void ReportResult()
        {
            onFinish?.Invoke();
        }
        public void GetResult() { }
    }
    public class Slider
    {
        SliderAwaiter awaiter;
        public SliderAwaiter GetAwaiter()
        {
            SliderAwaiter awaiter = new SliderAwaiter();
            this.awaiter = awaiter;
            return awaiter;
        }
        public Slider ValueToAsync(int value)
        {
            Task.Run(async () => 
            {
                Console.Write("HP: ");
                for (int i = 0; i < value; i++)
                {
                    await Task.Delay(350);
                    Console.Write("■");
                }
                Console.Write("\n");
                awaiter?.ReportResult();
            });
            return this;
        }
    }

    static async Task Main(string[] args)
    {
        Slider slider = new Slider();
        Console.WriteLine("[ START ] PLAY UI_ANIMATION");
        await slider.ValueToAsync(4);
        Console.WriteLine("[  END  ] PLAY UI_ANIMATION");
    }