【稿件】在 C# 中 Object 是所有類的基類，所有的結(jié)構(gòu)和類都直接或間接的派生自它。前面這段話可以說所有的 C# 開發(fā)人員都知道，但是我相信其中有一部分程序員并不清楚甚至不知道我們常用的 ToString 、 Equals 和 GetHashCode 虛方法都來自于 Object 類，并且我們可以對它們進行重寫。重寫這三個虛方法可以說在項目開發(fā)中經(jīng)常用到，只不過大部分開發(fā)人員并未留意這三個虛方法可以重寫，而是自己寫方法來實現(xiàn)。

下面我就來具體講解一下它們?nèi)齻€應該怎么重寫。在這里我需要說明的是本篇文章會大量涉及到設(shè)計規(guī)范和設(shè)計要求，代碼只是作為輔助理解的形式出現(xiàn)，因此文章中的所有代碼將會以代碼段的形式出現(xiàn)。

一、ToString

ToString 重寫是這三種方法中重寫最簡單的，也是最常用的。但是有一部分開發(fā)人員認為重寫 ToString 方法意義不大，那么我在這里要說的是這種想法是錯誤的。當我們在對象上調(diào)用 ToString 時默認返回的是類的完全限定名稱，比如說我們在 System.IO.File 對象上調(diào)用這個方法，就會返回字符串 System.IO.File ，這個結(jié)果往往并不是我們所需要的結(jié)果并且這個結(jié)果也沒有什么意義。例如我們在一個 User 類中重寫 ToString 方法，每次調(diào)用 User.ToString() 時返回 "XXX今年XX歲"，如果我們不重寫 ToString 方法的話就得不到我們想要的結(jié)果。因此我們必須重寫，這時我們就可以這么寫。

 
 
 

  
  
  
public class User 
  
  
  
{ 
  
  
  
   public int Id {get;set;} 
  
  
  
   public string Name {get;set;} 
  
  
  
   public int Age {get;set;} 
  
  
  
   public string Sex {get;set;}  
  
  
  
   public override string ToString() 
  
  
  
  { 
  
  
  
       return $"{Name}今年{Age}歲！"; 
  
  
  
  } 
  
  
  
} 
 
 
 

重寫之后我們就可以得到我們想要的輸出內(nèi)容了。雖然重寫 ToString 可以得到我們想要的內(nèi)容，但是我們不能在任何情況下都重寫 ToString， 只有在以下三種情況下方可重寫 ToString ：

1. 代碼面對的最終用戶是開發(fā)人員;
2. 需要寫入日志;
3. IDE調(diào)試輸出。

在上面三種情況下重寫 ToString 我們還需要遵循一些設(shè)計規(guī)范，這些設(shè)計規(guī)范并不是微軟所定義的，而是開發(fā)人員在開發(fā)過程中總結(jié)出來的：

1. ToString 返回的字符串長度應該簡短，內(nèi)容描述應該清晰;
2. 不要從 ToString 方法中返回 “”，而要返回 null ;
3. 不要再 ToString 方法中引發(fā)并拋出異常，針對異常應該及時捕獲并處理;
4. 如果返回值存在地域文化(比如語言)或存在格式化要求，那么就必須重寫 ToString 方法;
5. ToString 重寫后必須返回獨一無二的字符串來標識實例對象。

到這里為止我們講解完了 ToString 重寫的方法以及規(guī)則。相對來說 ToString 方法重寫是 Object 虛方法重寫中十分簡單的部分，作為開發(fā)人員只需按照我前面多說的規(guī)則、方法以及實際情況來重寫即可。

二、 Equals 和 ReferenceEquals

在 C# 中如果對兩個對象進行相等判斷，一共有兩種情況分別是：判斷兩者的值相等 或者 判斷兩者的引用地址相同 。一般情況下我們需要對值類型對象判斷值相等，對引用類型對象判斷指向地址相同。Equals 就是用來對引用類型對象判斷指向地址是否相同的。對于重寫 Equals 方法，很多開發(fā)人員認為易如反掌，但是在開發(fā)中往往忘記一些很重要的細節(jié)，這些細節(jié)對于程序來說至關(guān)重要，下面我將一一進行詳細講解。

1. 同一和相等 所謂的同一指的是兩個對象如果引用的是同一個實例，那么我們就說這兩個對象具有同一性。在 C# 中我們可以利用 object 類或者它的派生類中的 ReferenceEquals 靜態(tài)方法來判斷對象之間的同一性。但是同一只是相等的一種，因為在某些情況下兩個對象的部分值或者全部值相等但引用不同，我們也可以說它們具有相等性。下面我們來看一個例子，這個例子通過重寫相等性來實現(xiàn)兩個對象的相等性。

      
      
      
   
       
       
       
     class Program 
       
       
       
   { 
       
       
       
       static void Main(string[] args) 
       
       
       
       { 
       
       
       
           Student s1 = new Student 
       
       
       
           { 
       
       
       
               Age = 12, 
       
       
       
               Id = 1, 
       
       
       
               Name = "小明" 
       
       
       
           }; 
       
       
       
           Student s2 = new Student 
       
       
       
           { 
       
       
       
               Age = 13, 
       
       
       
               Id = 1, 
       
       
       
               Name = "小明" 
       
       
       
           }; 
       
       
       
           if (Student.ReferenceEquals(s1, s2)) 
       
       
       
           { 
       
       
       
               Console.WriteLine("是同一個學生"); 
       
       
       
           } 
       
       
       
           else 
       
       
       
           { 
       
       
       
               Console.WriteLine("不是同一個學生"); 
       
       
       
           } 
       
       
       
           Console.Read(); 
       
       
       
       } 
       
       
       
   } 
       
       
       
   ? 
       
       
       
   class Student 
       
       
       
   { 
       
       
       
       public int Id { get; set; } 
       
       
       
       public string Name { get; set; } 
       
       
       
       public int Age { get; set; } 
       
       
       
       public static bool ReferenceEquals(Student s1, Student s2) 
       
       
       
       { 
       
       
       
           if (s1.Equals(s2) || 
       
       
       
                object.ReferenceEquals(s1, s2) || 
       
       
       
                s1.Id==s2.Id  
       
       
       
                s1==s2) 
       
       
       
           { 
       
       
       
               return true; 
       
       
       
           } 
       
       
       
           else 
       
       
       
           { 
       
       
       
               return false; 
       
       
       
           } 
       
       
       
       } 
       
       
       
   } 
      
      
      

   從上述代碼中我們可以看出，雖然 s1 和 s2 引用是不相等的，但是這兩個對象使用了相同的 Id ，因此我們認為 Id 相同的學生就是同一個學生。這么做可以確保數(shù)據(jù)庫中不會出現(xiàn)重復的錄入。

   Tip：只有引用類型才會可能出現(xiàn)引用相等的情況，對于值類型來說調(diào)用 ReferenceEquals 方法永遠返回的是 false ，因為值類型轉(zhuǎn)換成 object 時是需要裝箱的，即是傳遞的兩個參數(shù)是同一個值，也會返回 false 。

2. Equals 判斷兩個對象是否相等，可以使用 Equals ，通過它可以判斷出兩個對象是否具有相同的數(shù)據(jù)。在 object 中這個方法只是調(diào)用了 ReferenceEquals 方法來判斷同一性，因此在必要的時候我們必須重寫 Equals 方法。一般來說重寫 Equals 方法常用的步驟如下：

   • 檢查對象是否為 null ；

   • 判斷是否是引用類型，如果是就判斷引用是否相等；

   • 判斷數(shù)據(jù)類型是否相等；

   • 調(diào)用具體類型的輔助方法，參數(shù)必須是要比較的類型；

   • 判斷哈希碼是否相等，這一步需進行短路操作和字段比較；

   • 在基類的 Equals 方法被重寫的前提下，必須檢查基類的 Equals 方法；

   • 判斷關(guān)鍵字段的值是否相等；

   • 重寫 GetHashCode 方法；

   • 重寫 == 、 != 操作符。

   Tip： 如果類型是密封類型，那么第三步可以省略掉。

   我們不僅需要按照上述的步驟重寫 Equals 方法，還需要注意如下幾點：

   • GetHashCode 方法不一定返回的是獨一無二的值，因此我們不能僅僅依賴它的返回值來判斷兩個對象是否相等；

   • 我們不能在 GetHashCode 和 Equals 中引發(fā)任何異常；

   • 必須保證對象之間可以隨意比較，且不能觸發(fā)任何異常；

   • 必須實現(xiàn)重寫 Equals 、 GetHashCode 、 == 和 != ，且重寫的算法必須相同；

   • 盡量不要在可變類型上重寫相等性操作符。

三、 GetHashCode

在上一小節(jié)中我們也注意到在重寫 Equals 過程中我們需要重寫 GetHashCode 方法。 所謂 Hash Code 就是用來生成和對象值對應的數(shù)字，從而高效的平衡哈希表的作用。 重寫 GetHashCode 方法是比較困難的，下面我就來詳細講解一下重寫規(guī)則、方法和注意事項。重寫 GetHashCode 方法需要從性能、安全方面考慮，同時也需要滿足一些要求。

1. 性能  由于哈希碼的返回值是 int 類型，因此會出現(xiàn)部分對象包含的值比 int 取值范圍大的情況，這時哈希碼就肯定會存在重復的情況，所以這時我們要保證哈希碼的返回值盡可能的唯一。此外針對哈希碼的算法我們要盡可能的保證返回的哈希碼應當在 int 類型取值范圍內(nèi)平均分布。在 Equals 中利用 GetHashCode 方法進行短路操作時我們必須對算法的性能進行優(yōu)化，避免將類型作為字典集合中的鍵類型使用，因為這會導致頻繁的調(diào)用 GetHashCode 方法。在設(shè)計 GetHashCode 的算法時應保證良好的平衡性，即無論哈希表如何對哈希值進行 bucketing，也不會破壞平衡性。一般來說最理想的狀態(tài)是兩個對象間 1 bit 的差異應該造成哈希碼 16 bit 的差異。
2. 安全  在安全性這方面首先應該遵循的是難以偽造哈希碼對象，一般來說攻擊者會向哈希表中寫入大量哈希值相同的數(shù)據(jù)，這時如果哈希表實現(xiàn)效率不高將會收到拒絕服務攻擊。我們一般會向來自相關(guān)類型的哈希碼使用異或操作，且保證操作數(shù)不相近或者相等。如果出現(xiàn)操作數(shù)相近或者相等的情況，那么應該考慮使用位移和加法操作。但是多次使用 and 操作符會出現(xiàn)哈希值為 0 的情況，而多次使用 or 操作符則會出現(xiàn)哈希值為 1 的情況，這一點需要注意一下。更進一步的做法是，我們在開發(fā)中應該使用移位操作符來分解比 int 大的類型。
3. 要求  要求是性能和安全的基礎(chǔ)，只要完全符合了要求的規(guī)定，性能和安全才能很好的起作用。要求的第一點也是最基礎(chǔ)的優(yōu)點，相等的對象它們的哈希碼也相等，其次在特定的生命周期內(nèi)，特定對象的 GetHashCode 的返回值始終是一樣的，最后 GetHashCode 不能引發(fā)任何異常，如果其中出現(xiàn)異常也必須返回一個值來表示內(nèi)部出現(xiàn)異常。

四、總結(jié)

本篇文章主要講解了重寫 object 中虛方法的知識，其中涉及到了很多 C# 核心內(nèi)容，這些內(nèi)容和知識在實際開發(fā)中用的很多，但是大多數(shù)開發(fā)人員并不在意，因此我希望讀者閱讀完我這篇文章后能對這些內(nèi)容和知識有初步的了解。

 

作者簡介：

 

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

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

網(wǎng)頁標題：如何重寫C#中的Object虛方法
當前路徑：http://uogjgqi.cn/article/dhihecs.html