IEnumerator

• 迭代器
• System.Collections.IEnumerator
  即System.Collections.Generic.IEnumerator<T>傳入T為Object）。
• 用于普通循環(huán)（for酸休、while）建炫，代碼要寫(xiě)多很多

IEnumerator i = oneEnumerable.GetEnumerator();
bool isIterating = true;
for(i; isIterating; isIterating = i.MoveNext())
{
    Object oneObject = i.Current;
    oneObject.XXX();
}

IEnumerable

• 可迭代的東西汰瘫，有一個(gè)迭代器

• IEnumerable關(guān)鍵是這個(gè)接口函數(shù)： GetEnumerator()

• System.Collections.IEnumerable
  即System.Collections.Generic.IEnumerable<T>傳入T為Object

• 只有IEnumerable才可以用foreach，所以可以認(rèn)為是專門(mén)為foreach語(yǔ)法糖來(lái)搭配使用的海诲，代碼顯得簡(jiǎn)潔很多

foreach(Object oneObject in oneEnumerable)
{
    oneObject.XXX();
}

迭代器函數(shù)（iterator method）和yield

• “yield”是一個(gè)語(yǔ)句
• 如果不用yield璃氢，你需要寫(xiě)自己的一個(gè)迭代器類來(lái)實(shí)現(xiàn)IEnumerator

public class OneEnumerator : IEnumerator
{
    public bool MoveNext() {... }
    public object Current { ... }
    
    public void Reset() { ... }
}

• 從上面的代碼可以看出，迭代器類的功能無(wú)非只有
  • 記錄當(dāng)前狀態(tài)
  • 獲取當(dāng)前狀態(tài)的值
  • 移到下一狀態(tài)
• 寫(xiě)一個(gè)迭代器類太麻煩了希停。寫(xiě)一個(gè)迭代器函數(shù)（iterator method）就簡(jiǎn)單很多。最簡(jiǎn)單的迭代器函數(shù)示例：

//用于普通循環(huán)
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
}

• 迭代器函數(shù)被調(diào)用時(shí)鳖敷，系統(tǒng)生成并立刻返回一個(gè)IEnumerator或者IEnumerable脖苏，以供調(diào)用者進(jìn)行循環(huán)迭代
• 迭代器函數(shù)是一個(gè)特殊的函數(shù)，不能使用return定踱，只能使用yield語(yǔ)句

//yield return并非return棍潘。
//return用于返回函數(shù)第一次調(diào)用的返回值
//yield return用于返回每次IEnumerator.Current的返回值
//<expression>可以是任意類型，
//和迭代器函數(shù)聲明的返回值（IEnumerator/IEnumerable）沒(méi)半毛錢(qián)關(guān)系崖媚。
yield return <expression>;
//yield break用來(lái)中斷迭代亦歉。
yield break;

• 迭代器函數(shù)既然可以代替迭代器類，當(dāng)然也有上面3個(gè)功能畅哑。
  • 記錄當(dāng)前狀態(tài)
    • 迭代器函數(shù)每次yield了之后會(huì)暫時(shí)退出肴楷。并且記錄當(dāng)前執(zhí)行行數(shù)。
  • 獲取當(dāng)前狀態(tài)的值荠呐。
    • 每次yield return <expression>可以返回<expression>的值供IEnumerator.Current使用赛蔫。
  • 移到下一狀態(tài)
    • 迭代器函數(shù)再次被執(zhí)行時(shí)砂客，依據(jù)先前記錄的行數(shù)，直接從下一行開(kāi)始執(zhí)行呵恢。
• 注意協(xié)程函數(shù)被直接調(diào)用后鞠值，并非立刻執(zhí)行里面的語(yǔ)句，必須調(diào)用IEnuermator.MoveNext()后渗钉，才會(huì)執(zhí)行彤恶，直到下一個(gè)yield語(yǔ)句。

Unity的協(xié)程機(jī)制

• Unity利用了C#的這個(gè)迭代器函數(shù)語(yǔ)言特性鳄橘，加上自己的機(jī)制声离，用同步的方式將符合條件的迭代器函數(shù)模擬成一個(gè)并行在跑的、可內(nèi)部暫停瘫怜、可在特定時(shí)機(jī)接著再執(zhí)行的“協(xié)程”术徊。
• 先給出代碼示例如下：

public class TestCoroutine : MonoBehaviour
{
    IEnumerator Awake()
    {
        Debug.Log("1");
        yield return new WaitForSeconds(1);
        StartCoroutine(Do());
        Debug.Log("4");
    }
    IEnumerable Start()
    {
        Debug.Log("這行代碼壓根不會(huì)被執(zhí)行。因?yàn)殄e(cuò)誤地聲明為了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頻繁調(diào)度的消息函數(shù)（Update弧关、FixedUpdate和LateUpdate）不能聲明為迭代器函數(shù)
    //否則Unity編譯會(huì)報(bào)錯(cuò)。（雖然Mono/VS等外部編譯器不報(bào)錯(cuò)）
    IEnumerator Update()
    {
        yield return new WaitForSeconds(1);
    }
    */
}

//Output: 1 “等了1秒后” 2 2.1 3 4 “等了2秒后” 5 6

• 迭代器函數(shù)要成為Unity的協(xié)程必須符合下面幾個(gè)條件：
  • 被StartCoroutine()調(diào)用唤锉，以把迭代器返回的IEnumerator注冊(cè)到Unity內(nèi)部的協(xié)程管理器，才能得到合理的MoveNext()别瞭，從而才能被執(zhí)行窿祥。
    • 自定義的迭代器函數(shù)必須被用戶顯式調(diào)用StartCoroutine()。如上面的StartCoroutine(Do())蝙寨。
    • Unity保留的消息函數(shù)如聲明為迭代器函數(shù)晒衩，會(huì)被Unity引擎隱式調(diào)用StartCoroutine()。如上面的Awake消息函數(shù)墙歪。
    • 被Unity頻繁調(diào)度的消息函數(shù)（Update听系、FixedUpdate和LateUpdate）不能聲明為迭代器函數(shù)。
  • 迭代器函數(shù)內(nèi)yield return合適的YieldInstrunction子類虹菲，以告之Unity本迭代器函數(shù)要在什么時(shí)機(jī)被MoveNext()即再次被執(zhí)行靠胜。列出所有的時(shí)機(jī)如下，具體可參考Unity的執(zhí)行流程圖
    • WaitForFixedUpdate
    • null
    • WaitForSeconds
    • WWW
    • Coroutine
    • WaitForEndFrame