C#中Foreach循環遍歷的本質與枚舉器詳解

Posted on by

前言

對於C#裡面的Foreach學過 語言的人都知道怎麼用，但是其原理相信很多人和我一樣都沒有去深究。剛回顧泛型講到枚舉器讓我聯想到瞭Foreach的實現，所以進行一番探究，有什麼不對或者錯誤的地方大傢多多斧正。

1、創建一個控制臺應用程序

2、編寫測試代碼並分析

在Program類中寫一個foreach循環

class Program
{
    static void Main(string[] args)
    {
        List peopleList = new List() { "張三", "李四", "王五" };
        foreach (string people in peopleList)
        {
            Console.WriteLine(people);
        }
        Console.ReadKey();
    }
}

生成項目將項目編譯後在debug目錄下用Reflection反編譯ForeachTest.exe程序集後查看Program類的IL代碼，IL代碼如下：

.class private auto ansi beforefieldinit Program
    extends [mscorlib]System.Object
{
    .method public hidebysig specialname rtspecialname instance void .ctor() cil managed
    {
        .maxstack 8
        L_0000: ldarg.0
        L_0001: call instance void [mscorlib]System.Object::.ctor()
        L_0006: ret
    }

    .method private hidebysig static void Main(string[] args) cil managed
    {
        .entrypoint
        .maxstack 2
        .locals init (
            [0] class [mscorlib]System.Collections.Generic.List`1<string> list,
            [1] string str,
            [2] class [mscorlib]System.Collections.Generic.List`1<string> list2,
            [3] valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator`0<string> enumerator,
            [4] bool flag)
        L_0000: nop
        L_0001: newobj instance void [mscorlib]System.Collections.Generic.List`1<string>::.ctor()
        L_0006: stloc.2
        L_0007: ldloc.2
        L_0008: ldstr "\u5f20\u4e09"
        L_000d: callvirt instance void [mscorlib]System.Collections.Generic.List`1<string>::Add(!0)
        L_0012: nop
        L_0013: ldloc.2
        L_0014: ldstr "\u674e\u56db"
        L_0019: callvirt instance void [mscorlib]System.Collections.Generic.List`1<string>::Add(!0)
        L_001e: nop
        L_001f: ldloc.2
        L_0020: ldstr "\u738b\u4e94"
        L_0025: callvirt instance void [mscorlib]System.Collections.Generic.List`1<string>::Add(!0)
        L_002a: nop
        L_002b: ldloc.2
        L_002c: stloc.0
        L_002d: nop
        L_002e: ldloc.0
        L_002f: callvirt instance valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator`0<!0> [mscorlib]System.Collections.Generic.List`1<string>::GetEnumerator()
        L_0034: stloc.3
        L_0035: br.s L_0048
        L_0037: ldloca.s enumerator
        L_0039: call instance !0 [mscorlib]System.Collections.Generic.List`1/Enumerator`0<string>::get_Current()
        L_003e: stloc.1
        L_003f: nop
        L_0040: ldloc.1
        L_0041: call void [mscorlib]System.Console::WriteLine(string)
        L_0046: nop
        L_0047: nop
        L_0048: ldloca.s enumerator
        L_004a: call instance bool [mscorlib]System.Collections.Generic.List`1/Enumerator`0<string>::MoveNext()
        L_004f: stloc.s flag
        L_0051: ldloc.s flag
        L_0053: brtrue.s L_0037
        L_0055: leave.s L_0066
        L_0057: ldloca.s enumerator
        L_0059: constrained. [mscorlib]System.Collections.Generic.List`1/Enumerator`0<string>
        L_005f: callvirt instance void [mscorlib]System.IDisposable::Dispose()
        L_0064: nop
        L_0065: endfinally
        L_0066: nop
        L_0067: call valuetype [mscorlib]System.ConsoleKeyInfo [mscorlib]System.Console::ReadKey()
        L_006c: pop
        L_006d: ret
        .try L_0035 to L_0057 finally handler L_0057 to L_0066
    }
}

在反編譯的IL代碼中我們看到除瞭構建List和其他輸出，然後多瞭三個方法：GetEnumerator()，get_Current() ，MoveNext() ，於是通過反編譯reflector查看List泛型類，在List裡面找到GetEnumerator方法是繼承自接口IEnumerable 的方法，List實現的GetEnumerator方法代碼

public Enumerator GetEnumerator() => new Enumerator((List) this);

即返回一個Enumerator泛型類，然後傳入的參數是List泛型自己 this。接下來查看 Enumerator<T>泛型類

[Serializable, StructLayout(LayoutKind.Sequential)]
public struct Enumerator : IEnumerator<T>, IDisposable, IEnumerator
{
    private List<T> list;
    private int index;
    private int version;
    private T current;
    internal Enumerator(List<T> list)
    {
        this.list = list;
        this.index = 0;
        this.version = list._version;
        this.current = default(T);
    }
 
    public void Dispose()
    {
    }
 
    public bool MoveNext()
    {
        List<T> list = this.list;
        if ((this.version == list._version) && (this.index < list._size))
        {
            this.current = list._items[this.index];
            this.index++;
            return true;
        }
        return this.MoveNextRare();
    }
 
    private bool MoveNextRare()
    {
        if (this.version != this.list._version)
        {
            ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumFailedVersion);
        }
        this.index = this.list._size + 1;
        this.current = default(T);
        return false;
    }
 
    public T Current =>
        this.current;
    object IEnumerator.Current
    {
        get
        {
            if ((this.index == 0) || (this.index == (this.list._size + 1)))
            {
                ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumOpCantHappen);
            }
            return this.Current;
        }
    }
    void IEnumerator.Reset()
    {
        if (this.version != this.list._version)
        {
            ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumFailedVersion);
        }
        this.index = 0;
        this.current = default(T);
    }
}

我們看到這個Enumerator<T>泛型類實現瞭接口IEnumerator的方法，也就是我們測試的ForeachTest程序集反編譯後IL代碼中出現的get_Current() ，MoveNext() 方法。所以foreach實際上是編譯器編譯後先調用GetEnumerator方法返回Enumerator的實例，這個實例即是一個枚舉器實例。通過MoveNext方法移動下標來查找下一個list元素，get_Current方法獲取當前查找到的元素，Reset方法是重置list。

3、總結

因此要使用Foreach遍歷的對象是繼承瞭IEnumerable接口然後實現GetEnumerator方法。返回的實體對象需要繼承IEnumerator接口並實現相應的方法遍歷對象。因此Foreach的另一種寫法如下。

到此這篇關於C#中Foreach循環遍歷本質與枚舉器的文章就介紹到這瞭,更多相關C# Foreach循環與枚舉器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：