[游戏开发]Unity协程的实现原理

协程的本质是什么？

其本质其实是通过IEnumerator迭代器实现的一种状态机。故其本质还是单线程的，一旦协程卡住整个线程也会卡住。

首先先简单介绍下IEnumerator，其命名空间为System.Collections

具体内部接口函数签名为：

//  枚举器接口 IEnumerator
public interface IEnumerator
{
    //迭代器返回值
    object Current { get; }
    // 如果是返回 false，就是结束迭代器块
    bool MoveNext();
    void Reset();
}

其通常配合yield关键字一起使用可以使我们省去手动实现迭代器的重复且繁杂的代码，使语法更优雅，但yield做了些什么呢？

class B 
{
        public IEnumerator enumerableFuc()
        {
            int i = 0;
            Console.WriteLine("Enumerator " + i);
            yield return i;
            i++;
            Console.WriteLine("Enumerator " + i);
            yield return i;
            i++;
            Console.WriteLine("Enumerator " + i);
            yield break;
        }
}

class Program
{

        static void Main(string[] args)
        {
            B b = new();

            IEnumerator enumerator = b.enumerableFuc();

            while (enumerator.MoveNext())
            {
                Console.WriteLine("main " + enumerator.Current);
                Console.WriteLine("Enumerator Run");
            }

        }
}

?以上的例子可以看出enumerableFuc方法被截成了3个部分，通过MoveNext()返回的bool来判断迭代器是否走完，而yield return的值则通过Current属性返回。整个过程可以理解为当我们调用

IEnumerator enumerator = b.enumerableFuc();

?这段代码时，enumerableFuc方法会根据yield关键字将整个方法拆分成各个代码块，而yield关键字是一个语法糖，背后其实生成了一个新的枚举器类。枚举器的?MoveNext?方法中就有各个代码块的实现，Current 则存有yield return的对象，然后再封装成IEnumerator返回给enumerator 。yield break语法块会直接返回一个MoveNext?返回值为false的枚举器类，从而终止迭代器运行。

这时我们思考下Unity中协程的实现会是什么样子的

class B 
{
        public IEnumerator enumerableFuc1()
        {
            int i = 0;
            Console.WriteLine("Enumerator1 " + i);
            yield return i;
            i++;
            Console.WriteLine("Enumerator1 " + i);
            yield return i;
            i++;
            Console.WriteLine("Enumerator1 " + i);
            yield break;
        }

        public IEnumerator enumerableFuc2()
        {
            int i = 100;
            Console.WriteLine("Enumerator2 " + i);
            yield return i;
            i++;
            Console.WriteLine("Enumerator2 " + i);
            yield return i;
            i++;
            Console.WriteLine("Enumerator2 " + i);
            yield break;
        }
}

class CoroutinesManager
{
        public List<IEnumerator> coroutines = new List<IEnumerator>();
        //模仿协程开始，将协程加入到协程的执行列表中
        public void StartCoroutine(IEnumerator coroutine)
        {
            coroutines.Add(coroutine);
        }
}

class Program
{

        static void Main(string[] args)
        {
            int i = 0;
            CoroutinesManager coroutinesManager = new CoroutinesManager();
            B b = new();
            coroutinesManager.StartCoroutine(b.enumerableFuc1());
            coroutinesManager.StartCoroutine(b.enumerableFuc2());
            
            //模仿Unity生命周期循环
            while (true)
            {
                Console.WriteLine("frame: " + ++i);
                if (coroutinesManager.coroutines.Count <= 0)
                {
                    return;
                }
                List<IEnumerator> delete = new List<IEnumerator>();
                foreach (var item in coroutinesManager.coroutines)
                {
                    if (!item.MoveNext())
                    {
                        delete.Add(item);
                    }
                }

                foreach (var item in delete)
                {
                    coroutinesManager.coroutines.Remove(item);
                }
            }

        }
}

?

?这样我们就模拟出一个丐中丐版的协程系统，但实际上unity对协程的处理更加复杂，包括协程的嵌套，计时器实现等等。

Unity协程中yield return支持的协程响应类有以下这些

yield return null;//下一帧执行后续代码
yield return 数字;//下一帧执行后续代码
yield break;//结束迭代器

yield return new AsyncOperation();//Unity用于进行基于协程的异步操作的基类
yield return IEnumerator;//协程的嵌套
yield return new Coroutine();//用于协程的嵌套和监听Coroutine类是StartCoroutine返回的协程句柄
yield return new WWW();//WWW继承CustomYieldInstruction，CustomYieldInstruction可以用于实现自定义协程响应类
yield return new WaitForEndOfFrame();//在这帧结束，在 Unity 渲染每一个摄像机和 GUI 之后，在屏幕上显示下一帧之前执行后续代码。
yield return new WaitForFixedUpdate();//下一帧FixedUpdate开始时执行后续代码
yield return new WaitForSeconds(等待时间/秒);//延时设置的等待时间之后一帧的Update执行完成后运行，收Time.timeScale影响
yield return new WaitForSecondsRealtime(等待时间/秒);//延时设置的等待时间之后一帧的Update执行完成后运行