Unity協程（Coroutine）原理深入剖析

 By D.S.Qiu

尊重他人的勞動，支持原創，轉載請註明出處：http.dsqiu.iteye.com

        

        記得去年6月份剛開始實習的時候，當時要我寫網絡層的結構，用到了協程，當時有點懵，完全不知道Unity協程的執行機制是怎麼樣的，只是知道函數的返回值是IEnumerator類型，函數中使用yield return ，就可以通過StartCoroutine調用了。後來也是一直稀裏糊塗地用，上網google些基本都是例子，很少能幫助深入理解Unity協程的原理的。

        本文只是從Unity的角度去分析理解協程的內部運行原理，而不是從C#底層的語法實現來介紹（後續有需要再進行介紹），一共分爲三部分：

                  線程（Thread）和協程（Coroutine） 

                  Unity中協程的執行原理

                        IEnumerator & Coroutine

        之前寫過一篇《Unity協程(Coroutine)管理類——TaskManager工具分享》主要是介紹TaskManager實現對協程的狀態控制，沒有Unity後臺實現的協程的原理進行深究。雖然之前自己對協程還算有點了解了，但是對Unity如何執行協程的還是一片空白，在UnityGems.com上看到兩篇講解Coroutine，如數家珍，當我看到Advanced Coroutine後面的Hijack類時，頓時覺得十分精巧，眼前一亮，遂動了寫文分享之。

 

線程（Thread）和協程（Coroutine）      

        D.S.Qiu覺得使用協程的作用一共有兩點：1）延時（等待）一段時間執行代碼；2）等某個操作完成之後再執行後面的代碼。總結起來就是一句話：控制代碼在特定的時機執行。

        很多初學者，都會下意識地覺得協程是異步執行的，都會覺得協程是C# 線程的替代品，是Unity不使用線程的解決方案。

        所以首先，請你牢記：協程不是線程，也不是異步執行的。協程和 MonoBehaviour 的 Update函數一樣也是在MainThread中執行的。使用協程你不用考慮同步和鎖的問題。

 

Unity中協程的執行原理

        UnityGems.com給出了協程的定義：

               A coroutine is a function that is executed partially and, presuming suitable conditions are met, will be resumed at some point in the future until its work is done.

        即協程是一個分部執行，遇到條件（yield return 語句）會掛起，直到條件滿足纔會被喚醒繼續執行後面的代碼。

        Unity在每一幀（Frame）都會去處理對象上的協程。Unity主要是在Update後去處理協程（檢查協程的條件是否滿足），但也有寫特例：

        從上圖的剖析就明白，協程跟Update()其實一樣的，都是Unity每幀對會去處理的函數（如果有的話）。如果MonoBehaviour 是處於激活（active）狀態的而且yield的條件滿足，就會協程方法的後面代碼。還可以發現：如果在一個對象的前期調用協程，協程會立即運行到第一個 yield return 語句處，如果是 yield return null ，就會在同一幀再次被喚醒。如果沒有考慮這個細節就會出現一些奇怪的問題『1』。

        『1』注 圖和結論都是從UnityGems.com 上得來的，經過下面的驗證發現與實際不符，D.S.Qiu用的是Unity 4.3.4f1 進行測試的。經過測試驗證，協程至少是每幀的LateUpdate()後去運行。

        下面使用 yield return new WaitForSeconds(1f); 在Start,Update 和 LateUpdate 中分別進行測試：

using UnityEngine;
using System.Collections;

public class TestCoroutine : MonoBehaviour {

    private bool isStartCall = false;  //Makesure Update() and LateUpdate() Log only once
    private bool isUpdateCall = false;
    private bool isLateUpdateCall = false;
    // Use this for initialization
    void Start () {
        if (!isStartCall)
        {
            Debug.Log("Start Call Begin");
            StartCoroutine(StartCoutine());
            Debug.Log("Start Call End");
            isStartCall = true;
        }

    }
    IEnumerator StartCoutine()
    {

        Debug.Log("This is Start Coroutine Call Before");
        yield return new WaitForSeconds(1f);
        Debug.Log("This is Start Coroutine Call After");

    }
    // Update is called once per frame
    void Update () {
        if (!isUpdateCall)
        {
            Debug.Log("Update Call Begin");
            StartCoroutine(UpdateCoutine());
            Debug.Log("Update Call End");
            isUpdateCall = true;
        }
    }
    IEnumerator UpdateCoutine()
    {
        Debug.Log("This is Update Coroutine Call Before");
        yield return new WaitForSeconds(1f);
        Debug.Log("This is Update Coroutine Call After");
    }
    void LateUpdate()
    {
        if (!isLateUpdateCall)
        {
            Debug.Log("LateUpdate Call Begin");
            StartCoroutine(LateCoutine());
            Debug.Log("LateUpdate Call End");
            isLateUpdateCall = true;
        }
    }
    IEnumerator LateCoutine()
    {
        Debug.Log("This is Late Coroutine Call Before");
        yield return new WaitForSeconds(1f);
        Debug.Log("This is Late Coroutine Call After");
    }
}

 得到日誌輸入結果如下：

 

        然後將yield return new WaitForSeconds(1f);改爲 yield return null; 發現日誌輸入結果和上面是一樣的，沒有出現上面說的情況：

using UnityEngine;
using System.Collections;

public class TestCoroutine : MonoBehaviour {

    private bool isStartCall = false;  //Makesure Update() and LateUpdate() Log only once
    private bool isUpdateCall = false;
    private bool isLateUpdateCall = false;
    // Use this for initialization
    void Start () {
        if (!isStartCall)
        {
            Debug.Log("Start Call Begin");
            StartCoroutine(StartCoutine());
            Debug.Log("Start Call End");
            isStartCall = true;
        }

    }
    IEnumerator StartCoutine()
    {

        Debug.Log("This is Start Coroutine Call Before");
        yield return null;
        Debug.Log("This is Start Coroutine Call After");

    }
    // Update is called once per frame
    void Update () {
        if (!isUpdateCall)
        {
            Debug.Log("Update Call Begin");
            StartCoroutine(UpdateCoutine());
            Debug.Log("Update Call End");
            isUpdateCall = true;
        }
    }
    IEnumerator UpdateCoutine()
    {
        Debug.Log("This is Update Coroutine Call Before");
        yield return null;
        Debug.Log("This is Update Coroutine Call After");
    }
    void LateUpdate()
    {
        if (!isLateUpdateCall)
        {
            Debug.Log("LateUpdate Call Begin");
            StartCoroutine(LateCoutine());
            Debug.Log("LateUpdate Call End");
            isLateUpdateCall = true;
        }
    }
    IEnumerator LateCoutine()
    {
        Debug.Log("This is Late Coroutine Call Before");
        yield return null;
        Debug.Log("This is Late Coroutine Call After");
    }
}

        『今天意外發現Monobehaviour的函數執行順序圖，發現協程的運行確實是在LateUpdate之後，下面附上：』
                                                                       增補於：03/12/2014 22:14
 

        前面在介紹TaskManager工具時，說到MonoBehaviour 沒有針對特定的協程提供Stop方法，其實不然，可以通過MonoBehaviour enabled = false 或者 gameObject.active = false 就可以停止協程的執行『2』。

        經過驗證，『2』的結論也是錯誤的，正確的結論是，MonoBehaviour.enabled = false 協程會照常運行，但 gameObject.SetActive(false) 後協程卻全部停止，即使在Inspector把  gameObject 激活還是沒有繼續執行：

using UnityEngine;
using System.Collections;

public class TestCoroutine : MonoBehaviour {

    private bool isStartCall = false;  //Makesure Update() and LateUpdate() Log only once
    private bool isUpdateCall = false;
    private bool isLateUpdateCall = false;
    // Use this for initialization
    void Start () {
        if (!isStartCall)
        {
            Debug.Log("Start Call Begin");
            StartCoroutine(StartCoutine());
            Debug.Log("Start Call End");
            isStartCall = true;
        }

    }
    IEnumerator StartCoutine()
    {

        Debug.Log("This is Start Coroutine Call Before");
        yield return new WaitForSeconds(1f);
        Debug.Log("This is Start Coroutine Call After");

    }
    // Update is called once per frame
    void Update () {
        if (!isUpdateCall)
        {
            Debug.Log("Update Call Begin");
            StartCoroutine(UpdateCoutine());
            Debug.Log("Update Call End");
            isUpdateCall = true;
            this.enabled = false;
            //this.gameObject.SetActive(false);
        }
    }
    IEnumerator UpdateCoutine()
    {
        Debug.Log("This is Update Coroutine Call Before");
        yield return new WaitForSeconds(1f);
        Debug.Log("This is Update Coroutine Call After");
        yield return new WaitForSeconds(1f);
        Debug.Log("This is Update Coroutine Call Second");
    }
    void LateUpdate()
    {
        if (!isLateUpdateCall)
        {
            Debug.Log("LateUpdate Call Begin");
            StartCoroutine(LateCoutine());
            Debug.Log("LateUpdate Call End");
            isLateUpdateCall = true;

        }
    }
    IEnumerator LateCoutine()
    {
        Debug.Log("This is Late Coroutine Call Before");
        yield return null;
        Debug.Log("This is Late Coroutine Call After");
    }
}

 先在Update中調用 this.enabled = false; 得到的結果：

然後把 this.enabled = false; 註釋掉，換成 this.gameObject.SetActive(false); 得到的結果如下：

       整理得到：通過設置MonoBehaviour腳本的enabled對協程是沒有影響的，但如果 gameObject.SetActive(false) 則已經啓動的協程則完全停止了，即使在Inspector把gameObject 激活還是沒有繼續執行。也就說協程雖然是在MonoBehvaviour啓動的（StartCoroutine）但是協程函數的地位完全是跟MonoBehaviour是一個層次的，不受MonoBehaviour的狀態影響，但跟MonoBehaviour腳本一樣受gameObject 控制，也應該是和MonoBehaviour腳本一樣每幀“輪詢” yield 的條件是否滿足。

       

yield 後面可以有的表達式：

 

       a) null - the coroutine executes the next time that it is eligible

       b) WaitForEndOfFrame - the coroutine executes on the frame, after all of the rendering and GUI is complete

       c) WaitForFixedUpdate - causes this coroutine to execute at the next physics step, after all physics is calculated

       d) WaitForSeconds - causes the coroutine not to execute for a given game time period

       e) WWW - waits for a web request to complete (resumes as if WaitForSeconds or null)

       f) Another coroutine - in which case the new coroutine will run to completion before the yielder is resumed

值得注意的是 WaitForSeconds()受Time.timeScale影響，當Time.timeScale = 0f 時，yield return new WaitForSecond(x) 將不會滿足。

 

IEnumerator & Coroutine

        協程其實就是一個IEnumerator（迭代器），IEnumerator 接口有兩個方法 Current 和 MoveNext() ，前面介紹的 TaskManager 就是利用者兩個方法對協程進行了管理，只有當MoveNext()返回 true時纔可以訪問 Current，否則會報錯。迭代器方法運行到 yield return 語句時，會返回一個expression表達式並保留當前在代碼中的位置。 當下次調用迭代器函數時執行從該位置重新啓動。

        Unity在每幀做的工作就是：調用 協程（迭代器）MoveNext() 方法，如果返回 true ，就從當前位置繼續往下執行。

 

Hijack

         這裏在介紹一個協程的交叉調用類 Hijack（參見附件）：

using System;
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
using System.Collections;

[RequireComponent(typeof(GUIText))]
public class Hijack : MonoBehaviour {

    //This will hold the counting up coroutine
    IEnumerator _countUp;
    //This will hold the counting down coroutine
    IEnumerator _countDown;
    //This is the coroutine we are currently
    //hijacking
    IEnumerator _current;

    //A value that will be updated by the coroutine
    //that is currently running
    int value = 0;

    void Start()
    {
        //Create our count up coroutine
        _countUp = CountUp();
        //Create our count down coroutine
        _countDown = CountDown();
        //Start our own coroutine for the hijack
        StartCoroutine(DoHijack());
    }

    void Update()
    {
        //Show the current value on the screen
        guiText.text = value.ToString();
    }

    void OnGUI()
    {
        //Switch between the different functions
        if(GUILayout.Button("Switch functions"))
        {
            if(_current == _countUp)
                _current = _countDown;
            else
                _current = _countUp;
        }
    }

    IEnumerator DoHijack()
    {
        while(true)
        {
            //Check if we have a current coroutine and MoveNext on it if we do
            if(_current != null && _current.MoveNext())
            {
                //Return whatever the coroutine yielded, so we will yield the
                //same thing
                yield return _current.Current;
            }
            else
                //Otherwise wait for the next frame
                yield return null;
        }
    }

    IEnumerator CountUp()
    {
        //We have a local increment so the routines
        //get independently faster depending on how
        //long they have been active
        float increment = 0;
        while(true)
        {
            //Exit if the Q button is pressed
            if(Input.GetKey(KeyCode.Q))
                break;
            increment+=Time.deltaTime;
            value += Mathf.RoundToInt(increment);
            yield return null;
        }
    }

    IEnumerator CountDown()
    {
        float increment = 0f;
        while(true)
        {
            if(Input.GetKey(KeyCode.Q))
                break;
            increment+=Time.deltaTime;
            value -= Mathf.RoundToInt(increment);
            //This coroutine returns a yield instruction
            yield return new WaitForSeconds(0.1f);
        }
    }

}

 上面的代碼實現是兩個協程交替調用，對有這種需求來說實在太精妙了。

 

 

小結：

        今天仔細看了下UnityGems.com 有關Coroutine的兩篇文章，雖然第一篇（參考①）現在驗證的結果有很多錯誤，但對於理解協程還是不錯的，尤其是當我發現Hijack這個腳本時，就迫不及待分享給大家。

   

        本來沒覺得會有UnityGems.com上的文章會有錯誤的，無意測試了發現還是有很大的出入，當然這也不是說原來作者沒有經過驗證就妄加揣測，D.S.Qiu覺得很有可能是Unity內部的實現機制改變了，這種東西完全可以改動，Unity雖然開發了很多年了，但是其實在實際開發中還是有很多坑，越發覺得Unity的無力，雖說容易上手，但是填坑的功夫也是必不可少的。      

       

        看來很多結論還是要通過自己的驗證才行，貿然複製粘貼很難出真知，切記！

 

        如果您對D.S.Qiu有任何建議或意見可以在文章後面評論，或者發郵件（[email protected])交流，您的鼓勵和支持是我前進的動力，希望能有更多更好的分享。

        轉載請在文首註明出處：http://dsqiu.iteye.com/blog/2029701

更多精彩請關注D.S.Qiu的博客和微博（ID：靜水逐風）    

 

參考：

①UnityGems.com: http://unitygems.com/coroutines/

②UnityGems.com: http://unitygems.com/advanced-coroutines/

③蔥燒烙餅： http://blog.sina.com.cn/s/blog_5b6cb9500100xgmp.html