[[346581]]

【51CTO.com原創(chuàng)稿件】作為開(kāi)發(fā)人員我們經(jīng)常會(huì)在程序中編寫(xiě) foreach 語(yǔ)句實(shí)現(xiàn)對(duì)類(lèi)型的遍歷，但是并不是所有的類(lèi)型都可以遍歷，這個(gè)知識(shí)點(diǎn)是絕大部分開(kāi)發(fā)成員所知曉的。但是類(lèi)型可以被 foreach 遍歷的依據(jù)是什么部分程序員并不清楚，下面我就通過(guò)舉例的方式來(lái)具體講解 foreach 原理。

在這里我們首先自定義一個(gè)類(lèi)型 Cat 并遍歷這個(gè)類(lèi)型：

//定義 Cat 類(lèi)型 
class Cat 
{ 
} 
//遍歷 Cat 
class Program 
{ 
   static void Main(string[] args) 
  { 
       Cat cat = new Cat(); 
       foreach(var item in cat) 
      { 
           //more code 
      } 
  } 
} 

我們運(yùn)行上述代碼后編譯器會(huì)提示錯(cuò)誤 “Cat” 不包含 “GetEnumerator” 的公共定義，因此 foreach 語(yǔ)句不能作用于 “Cat” 類(lèi)型的變量，由此錯(cuò)誤提示我們可以得知如果 Cat 類(lèi)型可以被 foreach 遍歷，那么 Cat 類(lèi)就必須實(shí)現(xiàn) GetEnumerator 方法。下面我們就在 Cat 類(lèi)中加入 GetEnumerator 方法。

class Cat 
{ 
   //加入 GetEnumerator 方法的實(shí)現(xiàn) 
   public object GetEnumerator() 
  { 
       return null; 
  } 
} 

我們?cè)俅芜\(yùn)行代碼，這時(shí)程序出現(xiàn)如下兩個(gè)錯(cuò)誤提示：

• foreach 要求 “Cat.GetEnumerator()”的返回類(lèi)型 “object”必須具有適當(dāng)?shù)墓?MoveNext 方法和公共 Current 屬性；

• object 并不包含 “MoveNext” 的定義。

根據(jù)上述錯(cuò)誤提示我們可以推斷出 GetEnumerator 方法的返回值必須要有 MoveNext 方法和 Current 屬性。但是我們目前并不知道 GetEnumerator 方法的返回值類(lèi)型和 Current 屬性是否是只讀的，這種情況我們?cè)撛趺崔k呢？此時(shí)我們可以查看已經(jīng)支持 foreach 遍歷的類(lèi)型是怎么做的，下面的代碼段展示了 string 類(lèi)型是如何實(shí)現(xiàn)的（只列出了關(guān)鍵代碼）。

//more code 
public CharEnumerator GetEnumerator(); 
//more code 
pubic sealed class CharEnumerator:ICloneabe,IEnumerator<char>,IEnumerator,IDisposable 
{ 
   public char Current {get;} 
   //more code 
   public bool MoveNext(); 
   //more code 
} 

根據(jù)上述代碼段我們仿寫(xiě)如下：

class Cat 
{ 
   public CatEnumerator GetEnumerator() 
  { 
       return new CatEnumerator(); 
  } 
} 
class CatEnumerator 
{ 
   public char Current {get;} 
   public bool MoveNext() 
  { 
       return true; 
  } 
} 

這時(shí)我們編譯發(fā)現(xiàn)原來(lái)的錯(cuò)誤已經(jīng)消失了，程序編譯通過(guò)了。但是不要以為到這里就完了，Cat 類(lèi)僅僅包含這些是沒(méi)有任何意義的，這些內(nèi)容只是為了讓程序通過(guò)編譯而已，在實(shí)際開(kāi)發(fā)中我們遍歷的對(duì)象是一個(gè)序列，那么我們現(xiàn)在就在 Cat 類(lèi)中添加一個(gè)固定的序列：

class Cat 
{ 
   string[] datas=new string[]{"波斯貓","貍花貓","無(wú)毛貓","虎斑貓"}; 
   public CatEnumerator GetEnumerator() 
  { 
       return new CatEnumerator(); 
  } 
} 

我們已經(jīng)添加了數(shù)據(jù)對(duì)象，那么 foreach 是如何訪問(wèn)到這個(gè)數(shù)據(jù)的呢？這時(shí)我們可以將數(shù)據(jù)對(duì)象通過(guò) GetEnumerator 方法作為迭代計(jì)數(shù)器對(duì)象（CatEnumerator）構(gòu)造函數(shù)的參數(shù)傳遞進(jìn)去，然后迭代計(jì)數(shù)器對(duì)象提供一個(gè)屬性將這些數(shù)據(jù)存儲(chǔ)起來(lái)。

class Cat 
{ 
   string[] datas=new string[]{"波斯貓","貍花貓","無(wú)毛貓","虎斑貓"}; 
   public CatEnumerator GetEnumerator() 
  { 
       return new CatEnumerator(datas); 
  } 
} 
class CatEnumerator 
{ 
   //存儲(chǔ)數(shù)據(jù) 
   private string[] datas; 
   //帶參構(gòu)造函數(shù) 
   public CatEnumerator(string[] datas) 
  { 
       this.datas=datas; 
  } 
   public char Current {get;} 
   public bool MoveNext() 
  { 
       return true; 
  } 
} 

到目前為止我們已經(jīng)設(shè)置了遍歷的數(shù)據(jù)，如果要將數(shù)據(jù)遍歷出來(lái)還需要一個(gè)下標(biāo)索引來(lái)讀取數(shù)組中的每個(gè)元素，并將每次讀取出來(lái)的元素值賦值給 Current 屬性。我們可以在迭代計(jì)數(shù)器對(duì)象中定義一個(gè) index 整型私有屬性作為下標(biāo)索引屬性，這里需要注意的是我們 index 這個(gè)屬性的默認(rèn)值為 -1 ，這一點(diǎn)是很多新手開(kāi)發(fā)人員比較容易出錯(cuò)的地方。既然有下標(biāo)了，我們?cè)诒闅v的時(shí)候下標(biāo)就必須是遞增變化，不斷指向下一個(gè)元素的位置直到到達(dá)數(shù)組的末端為止。這時(shí)我們就需要在 MoveNext 方法中進(jìn)行執(zhí)行下標(biāo)遞增的操作了，MoveNext 方法是一個(gè)返回值為 bool 類(lèi)型的方法，其目的是告知 foreach 當(dāng)前遍歷的數(shù)據(jù)對(duì)象是否存在還未遍歷到的元素，如果存在就返回 true 反之返回 false 遍歷結(jié)束。下面我們針對(duì)這一段所說(shuō)的內(nèi)容進(jìn)行代碼編寫(xiě)。

class CatEnumerator 
{ 
   //存儲(chǔ)數(shù)據(jù) 
   private string[] datas; 
   //帶參構(gòu)造函數(shù) 
   public CatEnumerator(string[] datas) 
  { 
       this.datas=datas; 
  } 
   //數(shù)組下標(biāo) 
   private int index=-1; 
   //遍歷當(dāng)前元素 
   public char Current  
  { 
       get 
      { 
           return datas[index]; 
      } 
  } 
   public bool MoveNext() 
  { 
       index++; 
       return index < datas.Length; 
       return true; 
  } 
} 

到目前為止我們就編寫(xiě)了一個(gè)可以通過(guò) foreach 遍歷的類(lèi)型，這里有三點(diǎn)很重要：

• GetEnumerator 方法的作用是 foreach 調(diào)用當(dāng)前需要遍歷的類(lèi)型的迭代計(jì)數(shù)器對(duì)象，該方法的返回類(lèi)型為用于foreach 遍歷的迭代計(jì)數(shù)器對(duì)象；

• Current 屬性就是當(dāng)前遍歷到的對(duì)象；

• MoveNext 方法促使迭代計(jì)數(shù)器對(duì)象的計(jì)數(shù)移動(dòng)到下一位。

通過(guò)前面所述的內(nèi)容，我們可知 foreach 遍歷主要有三個(gè)步驟：

• foreach 調(diào)用當(dāng)前可遍歷類(lèi)型的 GetEnumerator 方法創(chuàng)建一個(gè)迭代計(jì)數(shù)器對(duì)象，并將要遍歷的數(shù)據(jù)傳遞給迭代計(jì)數(shù)器對(duì)象的構(gòu)造函數(shù)中；

• 迭代計(jì)數(shù)器對(duì)象調(diào)用它 MoveNext 方法將所以小標(biāo)遞增 1 ，若下標(biāo)大于數(shù)據(jù)長(zhǎng)度則迭代完成；

• MoveNext 方法返回 true 并返回 Current 屬性中存儲(chǔ)的數(shù)據(jù)。

以上三個(gè)步驟總結(jié)起來(lái)就是 獲取迭代計(jì)數(shù)器對(duì)象 >> 調(diào)用 MoveNext 方法 >> 獲取 Current 屬性。

小技巧：在 c# 中如果要查看某個(gè)類(lèi)型是否支持 foreach 我們可以查看該類(lèi)型和該類(lèi)型的迭代計(jì)數(shù)器是否都實(shí)現(xiàn)了 IEnumerable 接口，因?yàn)?IEnumerable 接口中的就包含了 foreach 實(shí)現(xiàn)的原理和必須調(diào)用的成員。

作者簡(jiǎn)介

朱鋼，筆名喵叔，國(guó)內(nèi)某技術(shù)博客認(rèn)證專(zhuān)家，.NET高級(jí)開(kāi)發(fā)工程師，7年一線開(kāi)發(fā)經(jīng)驗(yàn)，參與過(guò)電子政務(wù)系統(tǒng)和AI客服系統(tǒng)的開(kāi)發(fā)，以及互聯(lián)網(wǎng)招聘網(wǎng)站的架構(gòu)設(shè)計(jì)，目前就職于一家初創(chuàng)公司，從事企業(yè)級(jí)安全監(jiān)控系統(tǒng)的開(kāi)發(fā)。

【51CTO原創(chuàng)稿件，合作站點(diǎn)轉(zhuǎn)載請(qǐng)注明原文作者和出處為51CTO.com】