Unity协程(Coroutine)原理深入剖析再续

Unity协程(Coroutine)原理深入剖析再续  By D.S.Qiu                前面已经介绍过对协程(Coroutine)的认识和理解,主要讲到了Unity引擎在执行协程(Coroutine)的原理(Unity协程(Coroutine)原理深入剖析)和对协程(Coroutine)状态的控制(Unity协程(Coroutine)管理类——TaskManager工具分享),到这使用Coroutine的疑问就没有了,但是D.S.Qiu还是有点没嚼烂,所以觉得很有必要再续。               1)yield return, IEnumerator  和 Unity StartCoroutine 的关系和理解               2)Cortoutine 扩展——Extending Coroutines: Return Values and Error Handling               3)Cortountine Locking          总之,引用③的一句话:Coroutines – More than you want to know.         1)yield return, IEnumerator  和 Unity StartCoroutine 的关系和理解          yield 和 IEnumerator都是C#的东西,前者是一个关键字,后者是枚举类的接口。对于IEnumerator 只引用②对 IEnumerable与IEnumerator区别 的论述:先贴出 IEnumerable 和 IEnumerator的定义:
C#代码  收藏代码
  1. public interface IEnumerable  
  2.     IEnumerator GetEnumerator();  
  3.    
  4. public interface IEnumerator  
  5.     bool MoveNext();  
  6. void Reset();  
  7.     Object Current { get; }  
  8. }  
 IEnumerable和IEnumerator有什么区别?这是一个很让人困惑的问题(在很多forum里都看到有人在问这个问题)。研究了半天,得到以下几点认识:         1、一个Collection要支持foreach方式的遍历,必须实现IEnumerable接口(亦即,必须以某种方式返回IEnumerator object)。         2、IEnumerator object具体实现了iterator(通过MoveNext(),Reset(),Current)。         3、从这两个接口的用词选择上,也可以看出其不同:IEnumerable是一个声明式的接口,声明实现该接口的class是“可枚举(enumerable)”的,但并没有说明如何实现枚举器(iterator);IEnumerator是一个实现式的接口,IEnumerator object就是一个iterator。         4、IEnumerable和IEnumerator通过IEnumerable的GetEnumerator()方法建立了连接,client可以通过IEnumerable的GetEnumerator()得到IEnumerator object,在这个意义上,将GetEnumerator()看作IEnumerator object的factory method也未尝不可。 IEnumerator  是所有枚举数的基接口。            枚举数只允许读取集合中的数据。枚举数无法用于修改基础集合。            最初,枚举数被定位于集合中第一个元素的前面。Reset   也将枚举数返回到此位置。在此位置,调用   Current   会引发异常。因此,在读取   Current   的值之前,必须调用   MoveNext   将枚举数提前到集合的第一个元素。            在调用   MoveNext   或   Reset   之前,Current   返回同一对象。MoveNext   将   Current   设置为下一个元素。            在传递到集合的末尾之后,枚举数放在集合中最后一个元素后面,且调用   MoveNext   会返回   false。如果最后一次调用   MoveNext   返回   false,则调用   Current   会引发异常。若要再次将   Current   设置为集合的第一个元素,可以调用   Reset,然后再调用   MoveNext。            只要集合保持不变,枚举数就将保持有效。如果对集合进行了更改(例如添加、修改或删除元素),则该枚举数将失效且不可恢复,并且下一次对   MoveNext   或   Reset   的调用将引发   InvalidOperationException。如果在   MoveNext   和   Current   之间修改集合,那么即使枚举数已经无效,Current   也将返回它所设置成的元素。            枚举数没有对集合的独占访问权;因此,枚举一个集合在本质上不是一个线程安全的过程。甚至在对集合进行同步处理时,其他线程仍可以修改该集合,这会导致枚举数引发异常。若要在枚举过程中保证线程安全,可以在整个枚举过程中锁定集合,或者捕捉由于其他线程进行的更改而引发的异常。 Yield关键字在迭代器块中用于向枚举数对象提供值或发出迭代结束信号。它的形式为下列之一⑥:  yield return ;  yield break;备注 :  计算表达式并以枚举数对象值的形式返回;expression_r 必须可以隐式转换为迭代器的 yield 类型。  yield 语句只能出现在 iterator 块中,该块可用作方法、运算符或访问器的体。这类方法、运算符或访问器的体受以下约束的控制:  不允许不安全块。  方法、运算符或访问器的参数不能是 ref 或 out。  yield 语句不能出现在匿名方法中。  当和 expression_r 一起使用时,yield return 语句不能出现在 catch 块中或含有一个或多个 catch 子句的 try 块中。   yield return 提供了迭代器一个比较重要的功能,即取到一个数据后马上返回该数据,不需要全部数据装入数列完毕,这样有效提高了遍历效率。 Unity StartCoroutine      Unity使用 StartCoroutine(routine: IEnumerator): Coroutine 启动协程,参数必须是 IEnumerator 对象。那么Unity在背后做什么神奇的处理呢?      StartCoroutine函数的参数我一般都是通过传入一个返回值为 IEnumerator的函数得到的:
C#代码  收藏代码
  1. float waitTime) {  
  2. return new WaitForSeconds(waitTime);  
  3. "WaitAndPrint " + Time.time);  
  4. }  
       在函数内使用前面介绍 yield 关键字返回 IEnumerator 对象,Unity 中实现了 YieldInstruction 作为 yield 返回的基类,有 Cortoutine, WaitForSecondes, WaitForEndOfFrame, WaitForFixedUpdate, WWW 几个子类实现。StartCoroutine 将 传入的 IEnumerator 封装为 Coroutine 返回,引擎会对 Corountines 存储和检查 IEnumerator 的 Current值。         WWW - after Updates happen for all game objects; check the isDone flag. If true, call the IEnumerator's MoveNext() function;       WaitForSeconds - after Updates happen for all game objects; check if the time has elapsed, if it has, call MoveNext();       null or some unknown value - after Updates happen for all game objects; Call MoveNext();       WaitForEndOfFrame - after Render happens for all cameras; Call MoveNext(). 如果最后一个 yield return 的 IEnumerator 已经迭代到最后一个是,MoveNext 就会 返回 false 。这时,Unity就会将这个 IEnumerator 从 cortoutines list 中移除。        所以很容易一个出现的误解:协程 Coroutines 并不是并行的,它和你的其他代码都运行在同一个线程中,所以才会在Update 和 Coroutine中使用 同一个值时才会变得线程安全。这就是Unity对线程安全的解决策略——直接不使用线程,最近Unity 5 将要发布说的很热,看到就有完全多线程的支持,不知道是怎么实现的,从技术的角度,还是很期待的哈。        总结下: 在协程方法中使用 yield return 其实就是为了返回 IEnumerator对象,只有当这个对象的 MoveNext() 返回 false 时,即该 IEnumertator 的 Current 已经迭代到最后一个元素了,才会执行 yield return 后面的语句。也就是说, yield return 被会“翻译”为一个 IEnmerator 对象,要想深入了解这方面的更多细节,可以猛击⑤查看。       根据⑤ C# in depth 的理解——C# 编译器会生成一个 IEnumerator 对象,这个对象实现的 MoveNext() 包含函数内所有 yield return 的处理,这里仅附上一个例子:
C#代码  收藏代码
  1. using System;  
  2. using System.Collections;  
  3. class Test  
  4.     static IEnumerator GetCounter()  
  5.         for (int count = 0; count < 10; count++)  
  6.             yield return count;  
  7.     }  
  8. }  
 C#编译器对应生成:
Cpp代码  收藏代码
  1. class Test  
  2.     // Note how this doesn't execute any of our original code  
  3. private static IEnumerator GetCounter()  
  4.         return new <GetCounter>d__0(0);  
  5.   
  6. // Nested type automatically created by the compiler to implement the iterator  
  7.     private sealed class <GetCounter>d__0 : IEnumerator<object>, IEnumerator, IDisposable  
  8.         // Fields: there'll always be a "state" and "current", but the "count"  
  9. // comes from the local variable in our iterator block.  
  10. private int <>1__state;  
  11. private object <>2__current;  
  12. public int <count>5__1;  
  13.         [DebuggerHidden]  
  14. public <GetCounter>d__0(int <>1__state)  
  15.             this.<>1__state = <>1__state;  
  16.   
  17. // Almost all of the real work happens here  
  18. private bool MoveNext()  
  19.             switch (this.<>1__state)  
  20.                 case 0:  
  21. this.<>1__state = -1;  
  22. this.<count>5__1 = 0;  
  23. while (this.<count>5__1 < 10)        //这里针对循环处理  
  24.                         this.<>2__current = this.<count>5__1;  
  25. this.<>1__state = 1;  
  26. return true;  
  27.                         this.<>1__state = -1;  
  28. this.<count>5__1++;  
  29.                     break;  
  30.                 case 1:  
  31. goto Label_004B;  
  32.             return false;  
  33.   
  34.         void IEnumerator.Reset()  
  35.             throw new NotSupportedException();  
  36.   
  37. void IDisposable.Dispose()  
  38.         }  
  39.         object IEnumerator<object>.Current  
  40.             [DebuggerHidden]  
  41.             {  
  42. return this.<>2__current;  
  43.         }  
  44.         object IEnumerator.Current  
  45.             [DebuggerHidden]  
  46.             {  
  47. return this.<>2__current;  
  48.         }  
  49. }  
       从上面的C#实现可以知道:函数内有多少个 yield return 在对应的 MoveNext() 就会返回多少次 true (不包含嵌套)。另外非常重要的一点的是:同一个函数内的其他代码(不是 yield return 语句)会被移到 MoveNext 中去,也就是说,每次 MoveNext 都会顺带执行同一个函数中 yield return 之前,之后 和两个 yield return 之间的代码。       对于Unity 引擎的 YieldInstruction 实现,其实就可以看着一个 函数体,这个函数体每帧会实现去 check MoveNext 是否返回 false 。 例如:
C#代码  收藏代码
  1. new WaitForSeconds(2f);  
       上面这行代码的伪代码实现:
C#代码  收藏代码
  1. private float elapsedTime;  
  2. private float time;  
  3. private void MoveNext()  
  4.         elapesedTime += Time.deltaTime;  
  5.         if(time <= elapsedTime)  
  6. return false;  
  7. else return true;  
  8. }  
                                                                                                                                                                       增补于: 2014年04月22日 8:00  2)Cortoutine 扩展——Extending Coroutines: Return Values and Error Handling        不知道你们调用 StartCortoutine 的时候有没有注意到 StartCortoutine 返回了 YieldInstruction 的子类 Cortoutine 对象,这个返回除了嵌套使用 StartCortoutine 在 yiled retrun StartCortoutine 有用到,其他情况机会就没有考虑它的存在,反正D.S.Qiu是这样的,一直认为物“极”所用,所以每次调用 StartCortoutine 都很纠结,好吧,有点强迫症。       Unity引擎讲 StartCoroutine 传入的参数 IEnumerator 封装为一个 Coroutine 对象中,而 Coroutine 对象其实也是 IEnumerator 枚举对象。yield return 的 IEnumerator 对象都存储在这个 Coroutine 中,只有当上一个yield return 的 IEnumerator 迭代完成,才会运行下一个。这个在猜测下Unity底层对Cortountine 的统一管理(也就是上面说的检查 Current 值):Unity底层应该有一个 正在运行的 Cortoutine 的 list 然后在每帧的不同时间去 Check。         还是回归到主题,上面介绍 yield 关键字有说不允许不安全块,也就是说不能出现在 try catch 块中,就不能在 yield return 执行是进行错误检查。③利用 StartCortoutine 返回值 Cortoutine 得到了当前的 Current 值和进行错误捕获处理。先定义封装包裹返回值和错误信息的类:
C#代码  收藏代码
  1. public class Coroutine<T>{  
  2. public T Value {  
  3. get{  
  4. if(e != null){  
  5. throw e;  
  6.         return returnVal;  
  7. }  
  8. private T returnVal;  //当前迭代器的Current 值  
  9. private Exception e;    //抛出的错误信息  
  10. public Coroutine coroutine;  
  11. public IEnumerator InternalRoutine(IEnumerator coroutine){  
  12. //先省略这部分的处理  
  13. }  
 InteralRoutine是对返回 Current 值和抛出的异常信息(如果有的话):
C#代码  收藏代码
  1. public IEnumerator InternalRoutine(IEnumerator coroutine){  
  2. while(true){  
  3. try{  
  4. if(!coroutine.MoveNext()){  
  5. break;  
  6.         }  
  7. catch(Exception e){  
  8. this.e = e;  
  9. break;  
  10.         object yielded = coroutine.Current;  
  11. if(yielded != null && yielded.GetType() == typeof(T)){  
  12.             yield break;  
  13.         else{  
  14. return coroutine.Current;  
  15.     }  
 下面为这个类扩展MonoBehavior:
C#代码  收藏代码
  1. public static class MonoBehaviorExt{  
  2. public static Coroutine<T> StartCoroutine<T>(this MonoBehaviour obj, IEnumerator coroutine){  
  3. new Coroutine<T>();  
  4.         return coroutineObject;  
  5. }  
 最后给出一个 Example:
C#代码  收藏代码
  1.         var routine = StartCoroutine<int>(TestNewRoutine()); //Start our new routine  
  2. return routine.coroutine; // wait as we normally can  
  3. // print the result now that it is finished.  
  4.       
  5.         yield return null;  
  6. return new WaitForSeconds(2f);  
  7. return 10;  
  8. return 5;  
  9.     }  
 最后输出是10,因为Cortoutine 遇到满足条件的 T 类型就 执行 yield break;就不执行 yield return 5; 这条语句了。如果将中 yield break; 语句去掉的话,最后输出的是 5 而不是10。
C#代码  收藏代码
  1. if(yielded != null && yielded.GetType() == typeof(T)){  
  2.             yield break;  
  3.         }  

其实就是Unity引擎每帧去 check yield return 后面的表达式,如果满足就继续向下执行。   下面在测试一个例子:连续两次调用 yield return coroutine;
C#代码  收藏代码
  1. private Coroutine routine1;  
  2. void Start ()   
  3.     routine1 = StartCoroutine(TestCoroutineExtention1()); //Start our new routine    
  4.       
  5. IEnumerator TestCoroutineExtention1()  
  6.     yield return new WaitForSeconds(1);  
  7. return 10;  
  8. "Run 10!");  
  9. return new WaitForSeconds(5);  
  10. return 5;  
  11. "Run 5!");  
  12. IEnumerator TestCortoutine()  
  13.     //wwwState = true;  
  14. return routine1; // wait as we normally can    
  15. " routine1");  
  16. return routine1; // wait as we normally can   
  17. " routine2");  
  18. }  
 测试运行会发现只会输出:         Run 10!         Run 5!          routine1  总结下: yield return expression 只有表达式完全执行结束才会继续执行后面的代码,连续两次执行 yield return StartCortoutine() 的返回值是不会满足的,说明 yield return 有区分开始和结束的两种状态。    3)Cortoutine Locking           虽然Cortoutine不是多线程机制,但仍会“并发”问题——同时多次调用 StartCortoutine ,当然通过Unity提供的api也能得到解决方案,每次StartCoroutine 之前先调用 StopCortoutine 方法停止,但这利用的是反射,显然效率不好。④对③的方案进行了扩展提供了 Cortoutine Locking 的支持,使用字符串(方法名)来标记同一个 Coroutine 方法,对于同一个方法如果等待时间超过 timeout 就会终止前面一个 Coroutine 方法,下面直接贴出代码:
C#代码  收藏代码
  1. using UnityEngine;  
  2. using System;  
  3. using System.Collections;  
  4. using System.Collections.Generic;  
  5. /// <summary>  
  6. /// Extending MonoBehaviour to add some extra functionality  
  7. /// Exception handling from: http://twistedoakstudios.com/blog/Post83_coroutines-more-than-you-want-to-know  
  8. ///   
  9. /// 2013 Tim Tregubov  
  10. /// </summary>  
  11. public class TTMonoBehaviour : MonoBehaviour  
  12.     private LockQueue LockedCoroutineQueue { get; set; }  
  13.     /// <summary>  
  14. /// Coroutine with return value AND exception handling on the return value.   
  15. /// </summary>  
  16. public Coroutine<T> StartCoroutine<T>(IEnumerator coroutine)  
  17.         Coroutine<T> coroutineObj = new Coroutine<T>();  
  18. base.StartCoroutine(coroutineObj.InternalRoutine(coroutine));  
  19. return coroutineObj;  
  20.       
  21. /// <summary>  
  22. /// Lockable coroutine. Can either wait for a previous coroutine to finish or a timeout or just bail if previous one isn't done.  
  23. /// Caution: the default timeout is 10 seconds. Coroutines that timeout just drop so if its essential increase this timeout.  
  24. /// Set waitTime to 0 for no wait  
  25. /// </summary>  
  26. public Coroutine<T> StartCoroutine<T>(IEnumerator coroutine, string lockID, float waitTime = 10f)  
  27.         if (LockedCoroutineQueue == null) LockedCoroutineQueue = new LockQueue();  
  28. new Coroutine<T>(lockID, waitTime, LockedCoroutineQueue);  
  29. base.StartCoroutine(coroutineObj.InternalRoutine(coroutine));  
  30. return coroutineObj;  
  31.       
  32. /// <summary>  
  33. /// Coroutine with return value AND exception handling AND lockable  
  34. /// </summary>  
  35. public class Coroutine<T>  
  36.         private T returnVal;  
  37. private Exception e;  
  38. private string lockID;  
  39. private float waitTime;  
  40.         private LockQueue lockedCoroutines; //reference to objects lockdict  
  41. private bool lockable;  
  42.         public Coroutine coroutine;  
  43. public T Value  
  44.             get   
  45.                 if (e != null)  
  46.                     throw e;  
  47.                 return returnVal;  
  48.         }  
  49.         public Coroutine() { lockable = false; }  
  50. public Coroutine(string lockID, float waitTime, LockQueue lockedCoroutines)  
  51.             this.lockable = true;  
  52. this.lockID = lockID;  
  53. this.lockedCoroutines = lockedCoroutines;  
  54. this.waitTime = waitTime;  
  55.           
  56. public IEnumerator InternalRoutine(IEnumerator coroutine)  
  57.             if (lockable && lockedCoroutines != null)  
  58.                 if (lockedCoroutines.Contains(lockID))  
  59.                     if (waitTime == 0f)  
  60.                         //Debug.Log(this.GetType().Name + ": coroutine already running and wait not requested so exiting: " + lockID);  
  61. break;  
  62.                     else  
  63.                         //Debug.Log(this.GetType().Name + ": previous coroutine already running waiting max " + waitTime + " for my turn: " + lockID);  
  64. float starttime = Time.time;  
  65. float counter = 0f;  
  66.                         while (!lockedCoroutines.First(lockID, coroutine) && (Time.time - starttime) < waitTime)  
  67.                             yield return null;  
  68.                         }  
  69. if (counter >= waitTime)  
  70.                             string error = this.GetType().Name + ": coroutine " + lockID + " bailing! due to timeout: " + counter;  
  71.                             this.e = new Exception(error);  
  72.                             yield break;  
  73.                     }  
  74.                 else  
  75.                     lockedCoroutines.Add(lockID, coroutine);  
  76.             }  
  77.             while (true)  
  78.                 try   
  79.                     if (!coroutine.MoveNext())  
  80.                         if (lockable) lockedCoroutines.Remove(lockID, coroutine);  
  81. break;  
  82.                 }  
  83. catch (Exception e)  
  84.                     this.e = e;  
  85. this.GetType().Name + ": caught Coroutine exception! " + e.Message + "n" + e.StackTrace);   
  86. if (lockable) lockedCoroutines.Remove(lockID, coroutine);  
  87. break;  
  88.                   
  89. object yielded = coroutine.Current;  
  90. if (yielded != null && yielded.GetType() == typeof(T))  
  91.                     returnVal = (T)yielded;  
  92. if (lockable) lockedCoroutines.Remove(lockID, coroutine);  
  93. break;  
  94.                 else  
  95.                     yield return coroutine.Current;  
  96.             }  
  97.     }  
  98.       
  99. /// <summary>  
  100. /// coroutine lock and queue  
  101. /// </summary>  
  102. public class LockQueue  
  103.         private Dictionary<string, List<IEnumerator>> LockedCoroutines { get; set; }  
  104.         public LockQueue()  
  105.             LockedCoroutines = new Dictionary<string, List<IEnumerator>>();  
  106.           
  107. /// <summary>  
  108. /// check if LockID is locked  
  109. /// </summary>  
  110. public bool Contains(string lockID)  
  111.             return LockedCoroutines.ContainsKey(lockID);  
  112.           
  113. /// <summary>  
  114. /// check if given coroutine is first in the queue  
  115. /// </summary>  
  116. public bool First(string lockID, IEnumerator coroutine)  
  117.             bool ret = false;  
  118. if (Contains(lockID))  
  119.                 if (LockedCoroutines[lockID].Count > 0)  
  120.                     ret = LockedCoroutines[lockID][0] == coroutine;  
  121.             }  
  122. return ret;  
  123.           
  124. /// <summary>  
  125. /// Add the specified lockID and coroutine to the coroutine lockqueue  
  126. /// </summary>  
  127. public void Add(string lockID, IEnumerator coroutine)  
  128.             if (!LockedCoroutines.ContainsKey(lockID))  
  129.                 LockedCoroutines.Add(lockID, new List<IEnumerator>());  
  130.               
  131. if (!LockedCoroutines[lockID].Contains(coroutine))  
  132.                 LockedCoroutines[lockID].Add(coroutine);  
  133.         }  
  134.         /// <summary>  
  135. /// Remove the specified coroutine and queue if empty  
  136. /// </summary>  
  137. public bool Remove(string lockID, IEnumerator coroutine)  
  138.             bool ret = false;  
  139. if (LockedCoroutines.ContainsKey(lockID))  
  140.                 if (LockedCoroutines[lockID].Contains(coroutine))  
  141.                     ret = LockedCoroutines[lockID].Remove(coroutine);  
  142.                   
  143. if (LockedCoroutines[lockID].Count == 0)  
  144.                     ret = LockedCoroutines.Remove(lockID);  
  145.             }  
  146. return ret;  
  147.           
  148.   
  149. }  
  小结:        对于第三部分的代码感觉有不妥,没有进行测试,附件里有代码,有需求的话请自取           如果您对D.S.Qiu有任何建议或意见可以在文章后面评论,或者发邮件(gd.s.qiu@gmail.com)交流,您的鼓励和支持是我前进的动力,希望能有更多更好的分享。http://dsqiu.iteye.com/blog/2049743  博客和微博(ID:静水逐风)

相关内容推荐