Unity协程和C#迭代器的关系

2022-11-09 08:03:52

从本质上来说Unity中的协程就是利用了C#中迭代器的特性

IEnumerator

IEnumerator定义了一个适用于任何集合的迭代方式。也就是说只要一个集合实现了IEnumerator，那么就可以通过IEnumerator迭代其中的元素。

IEnumerator的定义如下：

public interface IEnumerator
{
    object Current { get; }

    bool MoveNext();
    void Reset();
}

IEnumerator接口中包含一个元素，两个方法

Current表示正在迭代的元素
MoveNext方法是迭代到下一个元素，如果下一个元素存在，那么返回true否则返回false
Reset方法是将当前迭代位置设置为初始元素的位置。初始元素的位置在第一个元素位置以前，所以在执行Reset方法之后会Current表示的是当前迭代集合中的第一个元素
在我们遍历一个集合的时候通常会使用foreach方法对集合进行，foreach其实就是C#提供给我们的语法糖，并且在使用foreach遍历集合的时候我们只能获取到当前的值并不能改变当前元素的值，这是因为在IEnumerator接口中迭代元素的值Current只有get，没有set。所以你没有办法通过foreach遍历改变值。

再来说说yield

yield是C#的关键字，其实就是快速定义迭代器的语法糖。只要是yield出现在其中的方法就会被编译器自动编译成一个迭代器，对于这样的函数可以称之为迭代器函数。迭代器函数的返回值就是自动生成的迭代器类的一个对象

试试想象如果没有yield关键字，我们每定义一个迭代器，就要创建一个类，实现IEnumerator接口，接口包含的属性与方法都要正确的实现，是不是很麻烦？而利用yield关键字，只需要下面简单的几行代码，就可以快速定义一个迭代器。诸如迭代器类的创建，IEnumerator接口的实现工作编译器通通帮你做了

我们在C#中定义一个迭代器函数，如下

namespace ConsoleApp5
{
    class Program
    {
        static void Main(string[] args)
        {
            IEnumerator Test()
            {
                yield return "第一次输出";
                yield return "第二次输出";
                yield return "第三次输出";
                yield return "第四次输出";
            }
            IEnumerator enumerator = Test();
            bool ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// True 第一次输出
            ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// True 第二次输出
            ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// True 第三次输出
            ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// True 第四次输出
        }
    }
}

从上面的输出可以看出每次执行MoveNext方法就会停在yield return在的地方。

但是当我们的迭代器函数中只有一个yield return，但是我们执行了超过一次的MovNext方法会输出什么呢？结果如下:

namespace ConsoleApp5
{
    class Program
    {
        static void Main(string[] args)
        {
            IEnumerator Test()
            {
                yield return "第一次输出";
            }
            IEnumerator enumerator = Test();
            bool ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// True 第一次输出
            ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// false 第一次输出
            ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// false 第一次输出
            ret = enumerator.MoveNext();
            Console.WriteLine(ret + " " + enumerator.Current);// false 第一次输出
        }
    }
}

在unity中我们定义一个协程输出0-19，如下

IEnumerator TestCor()
{
    for (int i = 0; i < 20; i++)
    {
        Debug.Log(i);
        yield return new WaitForSeconds(1);
    }
}

当我们开启协程的时候每隔一秒就会输出一个数字，这是因为yield return后面的new WaitForSeconds(1)。可以简单理解成当满足yield return 之后的条件时Unity会自动执行MoveNext方法，当你写成yield return null的时候表示游戏的下一帧开始调用了MoveNext()，当你填new WaitForSeconds(1)的时候表示游戏的下一秒之后调用了enumerator.MoveNext(),也可以理解成我们在使用foreach循环，只不过每次遍历元素的时候加了一个条件，只有在满足这个条件之后才会继续遍历下一个元素。

准确的解释是：
在启动一个协程时，Unity会先调用得到的IEnumerator的MoveNext一次，以拿到IEnumerator的Current值。所以每启动一个协程，协程函数会立即执行到第一个yield return处然后“停住”。

对于不同的Current类型（一般是YieldInstruction的子类），Unity已做好了一些默认处理，比如：

如果Current是null，就相当于什么也不做。在下一次游戏循环中，就会调用MoveNext。所以yield return null就起到了等待一帧的作用

如果Current是WaitForSeconds类型，Unity会获取它的等待时间，每次游戏循环中都会判断时间是否到了，只有时间到了才会调用MoveNext。所以yield return WaitForSeconds就起到了等待指定时间的作用

码农公寓

IEnumerator

再来说说yield

相关文章