【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; // 完成下载后，修改标记
    }
}