Unity 协程原理探究与实现

一、介绍

协程Coroutine在Unity中一直扮演者重要的角色。可以实现简单的计时器、将耗时的操作拆分成几个步骤分散在每一帧去运行等等，用起来很是方便。
但是，在使用的过程中有没有思考过协程是怎么实现的？为什么可以将一段代码分成几段在不同帧执行？
本篇文章将从实现原理上更深入的理解协程，最后肯定也要实现我们自己的协程。
关于协程的用法网上有很多介绍，不清楚的话可以看下官方文档，这里不做赘述。

二、迭代器

在使用协程的时候，我们总是要声明一个返回值为IEnumerator的函数，并且函数中会包含yield return xxx或者yield break之类的语句。就像文档里写的这样

private IEnumerator WaitAndPrint(float waitTime)
{
   
        yield return new WaitForSeconds(waitTime);
        print("Coroutine ended: " + Time.time + " seconds");
}

想要理解IEnumerator和yield就不得不说一下迭代器。迭代器是C#中一个十分强大的功能，只要类继承了IEnumerable接口或者实现了GetEnumerator()方法就可以使用foreach去遍历类，遍历输出的结果是根据GetEnumerator()的返回值IEnumerator确定的，为了实现IEnumerator接口就不得不写一堆繁琐的代码，而yield关键字就是用来简化这一过程的。是不是很绕，理解这些内容需要花些时间。
不理解也没关系，目前只需要明白一件事，当在IEnumerator函数中使用yield return语句时，每使用一次，迭代器中的元素内容就会增加一个。就向往列表中添加元素一样，每Add一次元素内容就会多一个。
先来看看下面这段简单的代码

IEnumerator TestCoroutine()
{
   
    yield return null;              //返回内容为null

    yield return 1;                 //返回内容为1

    yield return "sss";             //返回内容为"sss"

    yield break;                    //跳出，类似普通函数中的return语句

    yield return 999;               //由于break语句，该内容无法返回
}

void Start()
{
   
    IEnumerator e = TestCoroutine();
    while (e.MoveNext())
    {
   
        Debug.Log(e.Current);       //依次输出枚举接口返回的值
    }
}
/* 枚举接口的定义
public interface IEnumerator
{
    object Current
    {
        get;
    }

    bool MoveNext();

    void Reset();
}*/

/*运行结果：
Null
1
sss
*/

首先注意注释部分枚举接口的定义
Current属性为只读属性，返回枚举序列中的当前位的内容
MoveNext()把枚举器的位置前进到下一项，返回布尔值，新的位置若是有效的，返回true；否则返回false
Reset()将位置重置为原始状态

再看下Start函数中的代码，就是将yield return 语句中返回的值依次输出。
第一次MoveNext()后，Current位置指向了yield return 返回的null，该位置是有效的（这里注意区分位置有效和结果有效，位置有效是指当前位置是否有返回值，即使返回值是null；而结果有效是指返回值的结果是否为null，显然此处返回结果是无意义的）所以MoveNext()返回值是true；
第二次MoveNext()后，Current新位置指向了yield return 返回的1，该位置是有效的，MoveNext()返回true
第三次MoveNext()后，Current新位置指向了yield return 返回的"sss"，该位置也是有效的，MoveNext()返回true
第四次MoveNext()后，Current新位置指向了yield break，无返回值，即位置无效，MoveNext()返回false，至此循环结束

最后输出的运行结果跟我们分析是一致的。关于C#是如何实现迭代器的功能，有兴趣的可以看下容器类源码中关于迭代器部分的实现就明白了，MSDN上也有关于迭代器的详细讲解。

三、原理

先来回顾下Unity的协程具体有些功能：

1. 将协程代码中由yield return语句分割的部分分配到每一帧去执行。
2. yield return 后的值是等待类(WaitForSeconds、WaitForFixedUpdate)时需要等待相应时间。
3. yield return 后的值还是协程(Coroutine)时需要等待嵌套部分协程执行完毕才能执行接下来内容。

// case 1
IEnumerator Coroutine1()
{
   
    //do something xxx		//假如是第N帧执行该语句
    yield return 1;         //等一帧
    //do something xxx  	//则第N+1帧执行该语句
}

// case 2
IEnumerator Coroutine2()
{
   
    //do something xxx		//假如是第N秒执行该语句
    yield return new WaitForSeconds(