Unity|Unity Coroutine

IEnumerator

  • 迭代器
  • System.Collections.IEnumerator
    即System.Collections.Generic.IEnumerator传入T为Object)。
  • 用于普通循环(for、while),代码要写多很多
IEnumerator i = oneEnumerable.GetEnumerator(); bool isIterating = true; for(i; isIterating; isIterating = i.MoveNext()) { Object oneObject = i.Current; oneObject.XXX(); }

IEnumerable
  • 可迭代的东西,有一个迭代器
  • IEnumerable关键是这个接口函数: GetEnumerator()
  • System.Collections.IEnumerable
    即System.Collections.Generic.IEnumerable传入T为Object
  • 【Unity|Unity Coroutine】只有IEnumerable才可以用foreach,所以可以认为是专门为foreach语法糖来搭配使用的,代码显得简洁很多
foreach(Object oneObject in oneEnumerable) { oneObject.XXX(); }

迭代器函数(iterator method)和yield
  • “yield”是一个语句
  • 如果不用yield,你需要写自己的一个迭代器类来实现IEnumerator
public class OneEnumerator : IEnumerator { public bool MoveNext() {... } public object Current { ... }public void Reset() { ... } }

  • 从上面的代码可以看出,迭代器类的功能无非只有
    • 记录当前状态
    • 获取当前状态的值
    • 移到下一状态
  • 写一个迭代器类太麻烦了。写一个迭代器函数(iterator method)就简单很多。最简单的迭代器函数示例:
//用于普通循环 public IEnumerator SomeNumbers() { yield return 3; yield return 5; yield return 8; }public void Test() { IEnumerator i = SomeNumbers(); bool isIterating = true; for(i; isIterating; isIterating = i.MoveNext()) { Console.Write(i.Current.ToString() + " "); } // Output: 3 5 8 }

//用于foreach public IEnumerable SomeNumbers() { yield return 3; yield return 5; yield return 8; }public void Test() { foreach (int number in SomeNumbers()) { Console.Write(number.ToString() + " "); } // Output: 3 5 8 }

  • 迭代器函数被调用时,系统生成并立刻返回一个IEnumerator或者IEnumerable,以供调用者进行循环迭代
  • 迭代器函数是一个特殊的函数,不能使用return,只能使用yield语句
//yield return并非return。 //return用于返回函数第一次调用的返回值 //yield return用于返回每次IEnumerator.Current的返回值 //可以是任意类型, //和迭代器函数声明的返回值(IEnumerator/IEnumerable)没半毛钱关系。 yield return ; //yield break用来中断迭代。 yield break;

  • 迭代器函数既然可以代替迭代器类,当然也有上面3个功能。
    • 记录当前状态
      • 迭代器函数每次yield了之后会暂时退出。并且记录当前执行行数。
    • 获取当前状态的值。
      • 每次yield return 可以返回的值供IEnumerator.Current使用。
    • 移到下一状态
      • 迭代器函数再次被执行时,依据先前记录的行数,直接从下一行开始执行。
  • 注意协程函数被直接调用后,并非立刻执行里面的语句,必须调用IEnuermator.MoveNext()后,才会执行,直到下一个yield语句。
Unity的协程机制
  • Unity利用了C#的这个迭代器函数语言特性,加上自己的机制,用同步的方式将符合条件的迭代器函数模拟成一个并行在跑的、可内部暂停、可在特定时机接着再执行的“协程”。
  • 先给出代码示例如下:
public class TestCoroutine : MonoBehaviour { IEnumerator Awake() { Debug.Log("1"); yield return new WaitForSeconds(1); StartCoroutine(Do()); Debug.Log("4"); } IEnumerable Start() { Debug.Log("这行代码压根不会被执行。因为错误地声明为了IEnumerable了。"); } IEnumerator Do() { Debug.Log("2"); Debug.Log("2.1"); yield return StartCoroutine(NewDo()); Debug.Log("6"); } IEnumerator NewDo() { Debug.Log("3"); yield return new WaitForSeconds(2); Debug.Log("5"); }/* //被Unity频繁调度的消息函数(Update、FixedUpdate和LateUpdate)不能声明为迭代器函数 //否则Unity编译会报错。(虽然Mono/VS等外部编译器不报错) IEnumerator Update() { yield return new WaitForSeconds(1); } */ }//Output: 1 “等了1秒后” 2 2.1 3 4 “等了2秒后” 5 6

  • 迭代器函数要成为Unity的协程必须符合下面几个条件:
    • 被StartCoroutine()调用,以把迭代器返回的IEnumerator注册到Unity内部的协程管理器,才能得到合理的MoveNext(),从而才能被执行。
      • 自定义的迭代器函数必须被用户显式调用StartCoroutine()。如上面的StartCoroutine(Do())。
      • Unity保留的消息函数如声明为迭代器函数,会被Unity引擎隐式调用StartCoroutine()。如上面的Awake消息函数。
      • 被Unity频繁调度的消息函数(Update、FixedUpdate和LateUpdate)不能声明为迭代器函数。
    • 迭代器函数内yield return合适的YieldInstrunction子类,以告之Unity本迭代器函数要在什么时机被MoveNext()即再次被执行。列出所有的时机如下,具体可参考Unity的执行流程图
      • WaitForFixedUpdate
      • null
      • WaitForSeconds
      • WWW
      • Coroutine
      • WaitForEndFrame

    推荐阅读