c# yield關鍵字原理詳解

c# yield關鍵字的用法

1.yield實現的功能
yield return：
先看下面的程式碼，通過yield return實現了類似用foreach遍歷陣列的功能，說明yield return也是用來實現迭代器的功能的。

using static System.Console;
using System.Collections.Generic;

class Program
{
    //一個返回型別為IEnumerable<int>，其中包含三個yield return
    public static IEnumerable<int> enumerableFuc()
    {
        yield return 1;
        yield return 2;
        yield return 3;
    }

    static void Main(string[] args)
    {
        //通過foreach迴圈迭代此函式
        foreach(int item in enumerableFuc())
        {
            WriteLine(item);
        }
        ReadKey();
    }
}

輸出結果：
1
2
3

yield break:
再看下面的程式碼，只輸出了1，2，沒有輸出3，說明這個迭代器被yield break停掉了，所以yield break是用來終止迭代的。

using static System.Console;
using System.Collections.Generic;
class Program
{
    //一個返回型別為IEnumerable<int>，其中包含三個yield return
    public static IEnumerable<int> enumerableFuc()
    {
        yield return 1;
        yield return 2;
        yield break;
        yield return 3;
    }

    static void Main(string[] args)
    {
        //通過foreach迴圈迭代此函式
        foreach(int item in enumerableFuc())
        {
            WriteLine(item);
        }
        ReadKey();
    }
}

輸出結果：
1
2

2.只能使用在返回型別必須為 IEnumerable、IEnumerable<T>、IEnumerator 或 IEnumerator<T>的方法、運算子、get訪問器中。

3.yield關鍵字的實現原理
我們用while迴圈代替foreach迴圈，發現我們雖然沒有實現GetEnumerator()，也沒有實現對應的IEnumerator的MoveNext()，和Current屬性，但是我們仍然能正常使用這些函式。

class Program
{
    //一個返回型別為IEnumerable<int>，其中包含三個yield return
    public static IEnumerable<int> enumerableFuc()
    {
        yield return 1;
        yield return 2;
        yield return 3;
    }

    static void Main(string[] args)
    {
        //用while迴圈代替foreach
        IEnumerator<int> enumerator = enumerableFuc().GetEnumerator();
        while (enumerator.MoveNext())
        {
            int current = enumerator.Current;
            WriteLine(current);
        }
        ReadKey();
    }
}

輸出結果：
1
2
3

至於為什麼會出現這種情況，我們可以用ILSpy對生成的exe進行反編譯來找到原因。
由於直接反編譯成C#會變為原樣

所以我們選擇反編譯為帶C#註釋的IL程式碼，雖然可讀性差點，但是可以詳細的瞭解其中過的原理。
先來看Program翻譯的情況，編譯的時候自動生成了一個新的類。

接下來我們來仔細看這些程式碼，EnumerableFuc()返回了這個新的類。

看這個程式碼自動生成的類的實現，發現它繼承了IEnumerable、IEnumerable<T>、IEnumerator 或 IEnumerator<T>，這時我們應該已經能猜到這個新的類就是我們沒有實現對應的IEnumerator的MoveNext()，和Current屬性，但是我們仍然能正常使用這些函式的原因了。

我們再來看一下這個類具體是如何實現迭代的呢，我們主要來看一下MoveNext()函式

每次呼叫MoveNext()函式都會將state加1，一共進行了4次迭代，前三次返回true，最後一次返回false，代表迭代結束。這四次迭代對應被3個yield return語句分成4部分的enumberableFuc()中的語句。

用enumberableFuc()來進行迭代的真實流程就是：
1.執行enumberableFuc()函式，獲取程式碼自動生成的類的例項。
2.接著呼叫GetEnumberator()函式，將獲取的類自己作為迭代器開始迭代。
3.每次執行MoveNext()，state增加1，通過switch語句可以讓每次呼叫MoveNext()的時候執行不同部分的程式碼。
4。MoveNext()返回false，結束。
這也能說明yield關鍵字其實是一種語法糖，最終還是通過實現IEnumberable<T>、IEnumberable、IEnumberator<T>和IEnumberator介面實現的迭代功能。