【Unity】協程Coroutine及Yield常見用法

最近學習協程Coroutine，參考了別人的文章和視頻教程，感覺協程用法還是相當靈活巧妙的，在此簡單總結，方便自己以后回顧。Yield關鍵字的語意可以理解為“暫停”。

首先是yield return的常見返回值及其作用：

• yield return new WaitForSeconds(3.0f); // 等待3秒，然后繼續從此處開始，常用於做定時器。
• yield return null; // 這一幀到此暫停，下一幀再從暫停處繼續，常用於循環中。
• yield return 1; // 這一幀到此暫停，下一幀再從暫停處繼續。這里return什么都是等一幀，后面的返回值沒有特殊意義。所以返回0或1或100都是一樣的。參考：http://blog.csdn.net/nanggong/article/details/48421053
• yield return new WaitForEndOfFrame(); // 等到這一幀的cameras和GUI渲染結束后再從此處繼續，即等到這幀的末尾再往下運行。這行之后的代碼還是在當前幀運行，是在下一幀開始前執行，跟return null很相似。
• yield return new WaitForFixedUpdate(); // 在下一次執行FixedUpdate的時候繼續執行這段代碼，即等一次物理引擎的更新。
• yield return www; // 等待直至異步下載完成。
• yield break; // 直接跳出協程，對某些判定失敗必須跳出的時候，比如加載AssetBundle的時候，WWW失敗了，后邊加載bundle沒有必要了，這時候可以yield break跳出。
• yield return StartCoroutine(methodName); // 等待另一個協程執行完。這是把協程串聯起來的關鍵，常用於讓多個協程按順序逐個運行。

更多關於Yield的研究與實驗：http://blog.csdn.net/huang9012/article/details/29595747

---

然后是協程Coroutine的常見用法：

① 將復雜操作分幀計算。

public class TestStepToCalculate : MonoBehaviour {

    void Start () {
        StartCoroutine(Calculate(1000));
    }

    IEnumerator Calculate(int times)
    {
        int num = 0; // 用於控制每幀的計算次數
        for (int i = 0; i < times; i++)
        {
            Debug.Log(Mathf.Pow(i, 10)); // 計算i的10次方
            if (++num >= 10)
            {
                num = 0;
                yield return null; // 每幀只計算10次
            }
        }
    }
}

② 異步下載。

public class TestAsynDownload : MonoBehaviour {
    void Start () {
        StartCoroutine(Work());
    }

    IEnumerator Work()
    {
        WWW www = WWW("http://www.baidu.com");
        yield return www; // 等待直至異步下載完成，才繼續往下執行
        Debug.Log(www.text);
    }
}

③ 使用yield return coroutine等待協程，將多個異步邏輯串聯。如先進行異步下載，完成下載任務后再接着運算。

public class TestMultipleCoroutine : MonoBehaviour {

    void Start () {
        Debug.Log("111");
        StartCoroutine(Work()); // 文檔描述：StartCoroutine function always returns immediately
        Debug.Log("222"); // 即開啟協程之后的代碼會立刻執行，不會等待協程操作結束后才執行！
    }

    IEnumerator Work()
    {
        yield return StartCoroutine(Download());
        yield return StartCoroutine(Calculate(10));
        Debug.Log("Finish");
    }

    IEnumerator Download()
    {
        WWW www = new WWW("http://www.baidu.com");
        yield return www; // 等待直至下載完成
        Debug.Log(www.text);
        yield return new WaitForSeconds(3.0f); // 下載完成后再等3秒
    }

    IEnumerator Calculate(int times)
    {
        for (int i = 0; i < times; i++)
        {
            Debug.Log(Mathf.Pow(i, 10)); // 計算i的10次方
            yield return null; // 每幀只計算一次
        }
    }
}

④ 創建互斥區。如某個下載函數同一時刻只能有一個協程進入。

public class TestCriticalSection : MonoBehaviour {

    private bool isDownloading = false; // 是否有某個協程正在下載中

    void Start () {
        StartCoroutine(Download("a"));
        StartCoroutine(Download("b"));
    }

    IEnumerator Download(string path)
    {
        while(isDownloading){
            yield return null; // 下一幀繼續檢測是否還有其他協程正在下載中
        }
        isDownloading = true; // 可以開始下載，先修改標記

        WWW www = new WWW("http://www.baidu.com");
        yield return www; // 等待直至異步下載完成，才繼續往下執行
        Debug.Log(path);

        isDownloading = false; // 完成下載后，修改標記
    }
}