Unity协程与迭代器

简介

Unity里的协程提供了一种异步处理的方式，可以用于实现延时或者分帧操作。
Unity协程的实现基本原理是利用了迭代器。 本文将利用迭代器的特性，实现Unity协程中分帧执行的功能。

迭代器

迭代器在诸如List, Map等容器类中经常使用，用于遍历容器中所有的元素。一个迭代器基本需要实现三个功能
HasNext：查询是否还有下一个元素；
MoveNext：将指针移动到下一个元素；
GetCurrent：获得当前迭代器指向的元素；
利用迭代器进行元素遍历的时候，就是在不断调用MoveNext和GetCurrent来获取所有元素，利用HasNext确定终止条件。
在Unity中的迭代器接口形式为

public interface IEnumerator
    {
        object Current { get; }

        bool MoveNext();
        void Reset();
    }

其中MoveNext()既作为移动指针的作用，又实现了判断是否存在下一个元素的作用。
Reset()方法给予了迭代器返回到初始态的能力。

现在实现一个自定义的迭代器，如下：

public class CustomEnumerator : IEnumerator
{
    private List<int> data;
    private int currentIndex;

    public CustomEnumerator()
    {
        data = new List<int>() { 0, 1, 2 };
        currentIndex = 0;
    }

    public object Current => data[currentIndex];

    public bool MoveNext()
    {
        if (currentIndex < data.Count - 1)
        {
            ++currentIndex;
            Debug.LogFormat("Ready to Get data from Index {0}", currentIndex);
            return true;
        }
        else
        {
            Debug.LogFormat("No next data");
            return false;
        }
    }

    public void Reset()
    {
        currentIndex = 0;
    }
}

测试代码如下：

public class CustomCoroutine : MonoBehaviour
{
    IEnumerator enumerator;

    void Start()
    {
        enumerator = new CustomEnumerator();

        while (enumerator.MoveNext())
        {
            Debug.Log(enumerator.Current.ToString());
        }
    }
}

最终得到的结果为：

每次调用MoveNext的时候把都会打印一条信息，并在确定成功移动指针的时候，打印当前值。在没有下一个元素的时候，MoveNext返回了false，循环终止。

更正：一般迭代器会先调用MoveNext方法，再取值，所以在初始话的时候要将这个过程考虑进去。这里的例子由于没考虑这种调用规则，所以打印的信息里面缺少了输入的数值0。

简单的分帧程序

上文中MoveNext的调用是作为while循环的条件语句，利用while循环实现迭代器的遍历。如果将MoveNext的调用改到Update函数中，那么迭代器的遍历就能够在多帧内完成，如下所示

public class EnumeratorTest : MonoBehaviour
{
    IEnumerator enumerator;

    void Start()
    {
        enumerator = new CustomEnumerator();
    }

    private void Update()
    {
        if (enumerator.MoveNext())
        {
            Debug.Log("Frame: " + Time.frameCount);
            object current = enumerator.Current;
            Debug.Log(current.ToString());
        }
    }
}

运行结果为：

元素1和2在不同的两帧内被打印出来，再遍历结束后，再调用MoveNext就只能得到"No next data"的日志了。

作为协程，更需要的是分帧执行代码，而非迭代迭代器中的元素，因此Current返回的值并不是很重要，重要的是MoveNext方法能够将指针移动到下一段需要执行的代码。现在将自定义迭代器中原先的List data字段改为List<System.Action> actions字段，并重新实现MoveNext和Current接口，如下所示：

public class CustomEnumerator : IEnumerator
{
    private List<System.Action> actions;
    private int currentIndex;

    public CustomEnumerator()
    {
        actions = new List<System.Action>();
        actions.Add(() =>
        {
            Debug.Log("Invoke at first frame.");
        });
        actions.Add(() =>
        {
            Debug.Log("Invoke at second frame.");
        });
        actions.Add(() =>
        {
            Debug.Log("Invoke at third frame.");
        });

        currentIndex = 0;
    }

    public object Current => null;

    public bool MoveNext()
    {
        if (currentIndex < actions.Count)
        {
            actions[currentIndex++].Invoke();
            return true;
        }
        else
        {
            Debug.LogFormat("finish");
            return false;
        }
    }

    public void Reset()
    {
        currentIndex = 0;
    }
}

public class EnumeratorTest : MonoBehaviour
{
    IEnumerator enumerator;

    void Start()
    {
        enumerator = new CustomEnumerator();
    }

    private void Update()
    {
        Debug.Log("Frame: " + Time.frameCount);
        enumerator.MoveNext();
    }
}

这样，自定义的迭代器就有了存储操作的能力了，显而易见，上面的代码运行后，会分帧执行actions列表中的内容，运行结果如下

正如预见的那样，在不同帧下执行了actions列表中的方法打印了相对应的日志。

Unity协程

Unity协程基本利用了迭代器的这种特性，在每一帧中调用迭代器的MoveNext方法，利用MoveNext执行相应代码并移动指针指向下一个需要执行的代码块。当返回值为false的时候，说明迭代器到了尽头，就可以结束调用。而C#提供了yield return关键字用于快速实现迭代器，而不需要前文那样自己实现一个包含IEnumerator接口的类，如下所示

private IEnumerator CoroutineFunction()
{
    Debug.Log("Start!");

    yield return 0;

    Debug.Log("Ready Count!");

    for(int i = 0; i < 2; ++i)
    {
        yield return i;
    }

    yield return "End Success";

    Debug.Log("The Last.");
}

两个yield return之间的代码就是MoveNext执行的内容，yield return后的值就是Current返回的内容在最后，MoveNext执行到Debug.Log(“The Last”);的代码段后没有了yield return语句了，则返回false代表迭代器到了终点。这就是经常会编写的协程函数。
当然这只是协程的一些基本原理，在使用协程的时候还会遇到协程嵌套，yield return 后返回一个类的实例，如WaitForSenconds和WaitForEndOfFrame等使得协程等待几秒钟或者等待到此帧末尾等情形。这些功能的实现可以在目前讨论的内容的基础上进一步扩展得到。