[[316458]]

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

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

一、ToString

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

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}歲！"; 
  } 
} 

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

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

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

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

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

二、 Equals 和 ReferenceEquals

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

1. 同一和相等 所謂的同一指的是兩個(gè)對(duì)象如果引用的是同一個(gè)實(shí)例，那么我們就說(shuō)這兩個(gè)對(duì)象具有同一性。在 C# 中我們可以利用 object 類或者它的派生類中的 ReferenceEquals 靜態(tài)方法來(lái)判斷對(duì)象之間的同一性。但是同一只是相等的一種，因?yàn)樵谀承┣闆r下兩個(gè)對(duì)象的部分值或者全部值相等但引用不同，我們也可以說(shuō)它們具有相等性。下面我們來(lái)看一個(gè)例子，這個(gè)例子通過(guò)重寫(xiě)相等性來(lái)實(shí)現(xiàn)兩個(gè)對(duì)象的相等性。  

     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("是同一個(gè)學(xué)生"); 
           } 
           else 
           { 
               Console.WriteLine("不是同一個(gè)學(xué)生"); 
           } 
           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 引用是不相等的，但是這兩個(gè)對(duì)象使用了相同的 Id ，因此我們認(rèn)為 Id 相同的學(xué)生就是同一個(gè)學(xué)生。這么做可以確保數(shù)據(jù)庫(kù)中不會(huì)出現(xiàn)重復(fù)的錄入。

   Tip：只有引用類型才會(huì)可能出現(xiàn)引用相等的情況，對(duì)于值類型來(lái)說(shuō)調(diào)用 ReferenceEquals 方法永遠(yuǎn)返回的是 false ，因?yàn)橹殿愋娃D(zhuǎn)換成 object 時(shí)是需要裝箱的，即是傳遞的兩個(gè)參數(shù)是同一個(gè)值，也會(huì)返回 false 。

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

   • 檢查對(duì)象是否為 null ；

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

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

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

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

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

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

   • 重寫(xiě) GetHashCode 方法；

   • 重寫(xiě) == 、 != 操作符。

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

   我們不僅需要按照上述的步驟重寫(xiě) Equals 方法，還需要注意如下幾點(diǎn)：

   • GetHashCode 方法不一定返回的是獨(dú)一無(wú)二的值，因此我們不能僅僅依賴它的返回值來(lái)判斷兩個(gè)對(duì)象是否相等；

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

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

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

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

三、 GetHashCode

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

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

四、總結(jié)

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

作者簡(jiǎn)介：

朱鋼，筆名喵叔，國(guó)內(nèi)某技術(shù)博客認(rè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】