如何重寫object虛方法-有解無憂

在 C# 中 Object 是所有類的基類，所有的結構和類都直接或間接的派生自它，前面這段話可以說所有的 C# 開發人員都知道，但是我相信其中有一部分程式員并不清楚甚至不知道我們常用的 ToString 、 Equals 和 GetHashCode 虛方法都來自于 Object 類，并且我們可以對它們進行重寫，重寫這三個虛方法可以說在專案開發中經常用到，只不過大部分開發人員并未留意這三個虛方法可以重寫，而是自己寫方法來實作，
下面我就來具體講解一下它們三個應該怎么重寫，在這里我需要說明的是本篇文章會大量涉及到設計規范和設計要求，代碼只是作為輔助理解的形式出現，因此文章中的所有代碼將會以代碼段的形式出現，

零、 ToString

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

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

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

代碼面對的最終用戶是開發人員；
需要寫入日志；
IDE除錯輸出，

在上面三種情況下重寫 ToString 我們還需要遵循一些設計規范，這些設計規范并不是微軟所定義的，而是開發人員在開發程序中總結出來的：

ToString 回傳的字串長度應該簡短，內容描述應該清晰；
不要從 ToString 方法中回傳 “”，而要回傳 null ;
不要再 ToString 方法中引發并拋出例外，針對例外應該及時捕獲并處理；
如果回傳值存在地域文化（比如語言）或存在格式化要求，那么就必須重寫 ToString 方法；
ToString 重寫后必須回傳獨一無二的字串來標識實體物件，

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

一、 Equals 和 ReferenceEquals

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

同一和相等
所謂的同一指的是兩個物件如果參考的是同一個實體，那么我們就說這兩個物件具有同一性，在 C# 中我們可以利用 object 類或者它的派生類中的 ReferenceEquals 靜態方法來判斷物件之間的同一性，但是同一只是相等的一種，因為在某些情況下兩個物件的部分值或者全部值相等但參考不同，我們也可以說它們具有相等性，下面我們來看一個例子，這個例子通過重寫相等性來實作兩個物件的相等性，
```
    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 相同的學生就是同一個學生，這么做可以確保資料庫中不會出現重復的錄入，

Tip：只有參考型別才會可能出現參考相等的情況，對于值型別來說呼叫 ReferenceEquals 方法永遠回傳的是 false ，因為值型別轉換成 object 時是需要裝箱的，即是傳遞的兩個引數是同一個值，也會回傳 false ，
Equals
判斷兩個物件是否相等，可以使用 Equals ，通過它可以判斷出兩個物件是否具有相同的資料，在 object 中這個方法只是呼叫了 ReferenceEquals 方法來判斷同一性，因此在必要的時候我們必須重寫 Equals 方法，一般來說重寫 Equals 方法常用的步驟如下：
- 檢查物件是否為 null ；
- 判斷是否是參考型別，如果是就判斷參考是否相等；
- 判斷資料型別是否相等；
- 呼叫具體型別的輔助方法，引數必須是要比較的型別；
- 判斷哈希碼是否相等，這一步需進行短路操作和欄位比較；
- 在基類的 Equals 方法被重寫的前提下，必須檢查基類的 Equals 方法；
- 判斷關鍵欄位的值是否相等；
- 重寫 GetHashCode 方法；
- 重寫 == 、 != 運算子，
Tip：如果型別是密封型別，那么第三步可以省略掉，

我們不僅需要按照上述的步驟重寫 Equals 方法，還需要注意如下幾點：
- GetHashCode 方法不一定回傳的是獨一無二的值，因此我們不能僅僅依賴它的回傳值來判斷兩個物件是否相等；
- 我們不能在 GetHashCode 和 Equals 中引發任何例外；
- 必須保證物件之間可以隨意比較，且不能觸發任何例外；
- 必須實作重寫 Equals 、 GetHashCode 、 == 和 != ，且重寫的演算法必須相同；
- 盡量不要在可變型別上重寫相等性運算子，

二、 GetHashCode

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

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

三、總結

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

本文由博客一文多發平臺 OpenWrite 發布！更多文章請掃碼關注公眾號：“喵叔呦”

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/68970.html

標籤：C#

上一篇：使用記憶體映射檔案MMF實作大資料量匯出時的記憶體優化（Linux篇）

下一篇：.NetCore學習筆記：四、AutoMapper物件映射