C# TaskCompletionSource在Unity中的使用

之前项目在设计框架的时候，同事负责的底层资源加载模块没有提供同步方法，所有的资源都是需要通过异步模式进行加载，而异步模式是会传染的，一旦其中一步采用了异步，所有的上层调用链都需要改成异步以作兼容。而异步代码写起来代码容易分散不紧凑，甚至是大量的嵌套，很不优雅。

先举个例子吧，假设UI管理在打开界面时需要加载界面的预置本身，异步代码大概就要这么写：

public void TestOperation()
{
    UIManagerOpen("登录");
}

public void UIManagerOpen(string uiName)
{
    LoadAsset(uiName, uiObject =>
    {
        //资源加载完成
        Log.Debug($"{uiName}资源加载完成");
    });
}

//资源加载异步方法
private void LoadAsset(string assetName, Action<Object> onAssetLoaded)
{
    StartCoroutine(LoadAssetSimulate(onAssetLoaded));
}

    
private IEnumerator LoadAssetSimulate(Action<Object> callback)
{
    float time = 0;
    while (time < 2f)
    {
        time += Time.deltaTime;
        yield return 0;
    }
    //此处模拟加载完成
    callback.Invoke(null);
}

假如你的UI框架设计里需要在打开主界面以后，再打开所配置的子界面，那你可能需要这么写

public void UIManagerOpen(string uiName)
{
    LoadAsset(uiName, uiObject =>
    {
        //资源加载完成
        Log.Debug($"{uiName}资源加载完成");
        LoadAsset(childUiName, childUiObject =>
        {
            Log.Debug($"{childUiName}子界面资源加载完成");
        });
    });
}

这还是只有一个子界面的情况，假如有N个子界面呢？原来我是这么写的

public void UIManagerOpen(string uiName)
{
    LoadAsset(uiName, uiObject =>
    {
        int childCount = parentUi.ChildList.Count;
        Action<Object> loadAction = (childObj) =>
        {
            childCount--;
            if (childCount == 0)
            {
                Log.Debug("资源加载完成");
                //后续代码
            }
        };
        
        for (int i = 0; i < parentUi.ChildList.Count; ++i)
        {
            LoadAsset(parentUi.ChildList[i], loadAction);
        }
    });
}

用lambda表达式可以让代码更紧凑，但代价就是嵌套层级会显得过深，影响代码阅读，如果不用lambda表达式，而改用定义不同的方法会使嵌套扁平化，但是又会增加很多方法，让原本紧密相连的逻辑结构分散了，也影响思维。

后来看到公司有用Task来做框架代码，await和sync等语法糖对异步代码的组织提供了很大的便利性。但是这都是基于Task的异步，传统的EAP（基于事件的EAP模式）如果想要和Task相关特性结合，就需要用到TaskCompletionSource了。

通过创建TaskCompletionSource对象比如命名为tcs，可以通过tcs.Task获取一个包装Task对象，这个任务初始化是未完成的，可以通过tcs.SetResult来使Task完成，从而继续await tcs.Task后边的代码，这样就完成了包装。

根据这个原理，其实Task可包装的不只有回调，还可以是动画，计时等一系列异步并有时长的行为了。

private TaskCompletionSource<bool> _testTcs;

public void TestOperation()
{
    AsyncOperation();
}

private async void AsyncOperation()
{
    _testTcs = new TaskCompletionSource<bool>();
    LoadAsset("UiMain", uiObject => _testTcs.SetResult(true));
    await _testTcs.Task;
    Log.Error("After Operation");
}

注意，上边的代码只是举例，其中TestOperation如果在调用AsyncOperation()后还有代码的话，会在AsyncOperation中的await时开始执行。打印两个函数的线程是同一个的。实际在应用中，不能直接定义局部变量——testTcs，而是应该定义一个类，里边封装tcs的一系列行为。