C#程式編寫高質量代碼改善的157個建議【10-12】[創建對象時需要考慮是否實現比較器、區別對待==和Equals]

来源:https://www.cnblogs.com/ljdong7/archive/2019/12/09/12011514.html
-Advertisement-
Play Games

前言 建議10、創建對象時需要考慮是否實現比較器 建議11、區別對待==和Equals 建議12、重寫Equals時也要重寫GetHashCode 建議10、創建對象時需要考慮是否實現比較器 有對象的地方就會存在比較,就像小時候每次拿著考卷回家,媽媽都會問你隔壁的那誰誰誰考了多少分呀。下麵我們也來舉 ...


前言

  建議10、創建對象時需要考慮是否實現比較器

  建議11、區別對待==和Equals

  建議12、重寫Equals時也要重寫GetHashCode

建議10、創建對象時需要考慮是否實現比較器

  有對象的地方就會存在比較,就像小時候每次拿著考卷回家,媽媽都會問你隔壁的那誰誰誰考了多少分呀。下麵我們也來舉個簡單的例子,就是有幾個人的Salary列表。我們根據基本工資來進行羅列:

複製代碼
    class Program
    {
        static void Main(string[] args)
        {
            ArrayList array = new ArrayList();
            array.Add(1100);
            array.Add(1200);
            array.Add(1160);
            array.Sort();
            foreach (var obj in array)
            {
                Console.WriteLine(obj.ToString());
            }
            Console.ReadLine();
        }
    }
複製代碼

 可以發現通過ArrayList.Sort()方法即可完成排序的任務。不過ArrayList這裡只能是一個欄位的。假如有姓名、工資兩個欄位,然後根據工資進行排序那麼按照現在的情況來看,ArrayList是無法實現的。所以介面IComparable現在可以派上用場了。現在先定義一個實體,並且實現介面IComparable。

複製代碼
public class Salary:IComparable
    {
        /// <summary>
        /// 姓名
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// 基本工資
        /// </summary>
        public int BaseSalary { get; set; }

        /// <summary>
        /// 實現IComparable介面
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>
        public int CompareTo(object obj)
        {
            Salary staff = obj as Salary;
            if (BaseSalary > staff.BaseSalary)
            {
                return 1;
            }
            else if (BaseSalary == staff.BaseSalary)
            {
                return 0;
            }
            else
            {
                return -1;
            }
        }
    }
複製代碼

進行排序

複製代碼
                ArrayList array = new ArrayList();
                array.Add(new Salary() { Name = "aehyok", BaseSalary = 12000 });
                array.Add(new Salary() { Name = "Kris", BaseSalary = 11200 });
                array.Add(new Salary() { Name = "Leo", BaseSalary = 18000 });
                array.Add(new Salary() { Name = "Niki", BaseSalary = 20000 });
                array.Sort();
                foreach (Salary obj in array)
                {
                    Console.WriteLine(string.Format("{0} BaseSalary:{1}", obj.Name, obj.BaseSalary));
                }
                Console.ReadLine();
複製代碼

如果未繼承Icomparable介面。那麼會出現如下錯誤。

正確的進行排序,結果如下所示

假如現在在Salary類中添加了一個獎金的欄位如下

複製代碼
public class Salary:IComparable
    {
        /// <summary>
        /// 姓名
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// 基本工資
        /// </summary>
        public int BaseSalary { get; set; }

        /// <summary>
        /// 獎金
        /// </summary>
        public int Bouns { get; set; }

        /// <summary>
        /// 實現IComparable介面
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>
        public int CompareTo(object obj)
        {
            Salary staff = obj as Salary;
            if (BaseSalary > staff.BaseSalary)
            {
                return 1;
            }
            else if (BaseSalary == staff.BaseSalary)
            {
                return 0;
            }
            else
            {
                return -1;
            }
        }
    }
複製代碼

再繼續假如,現在又要以Bouns獎金欄位進行排序,那應該怎麼處理呢?當然修改Salary實體類中繼承的介面方法進行處理肯定是沒問題了,但是比較麻煩。我們可以採用自定義比較介面IComparer來實現。

複製代碼
    public class BounsComparer:IComparer
    {
        public int Compare(object x, object y)
        {
            Salary s1 = x as Salary;
            Salary s2 = y as Salary;
            return s1.Bouns.CompareTo(s2.Bouns);
        }
    }
複製代碼

然後重新進行排序

複製代碼
                ArrayList array = new ArrayList();
                array.Add(new Salary() { Name = "aehyok", BaseSalary = 12000,Bouns=500 });
                array.Add(new Salary() { Name = "Kris", BaseSalary = 11200,Bouns=400 });
                array.Add(new Salary() { Name = "Leo", BaseSalary = 18000,Bouns=300 });
                array.Add(new Salary() { Name = "Niki", BaseSalary = 20000,Bouns=700 });
                array.Sort(new BounsComparer());
                foreach (Salary obj in array)
                {
                    Console.WriteLine(string.Format("{0} \tBaseSalary:{1}\tBouns{2}", obj.Name, obj.BaseSalary,obj.Bouns));
                }
                Console.ReadLine();
複製代碼

結果如下所示

註意,剛纔實現介面名字叫IComparable,而自定義的比較器介面是IComparer

如果我們稍有經驗,會發現如下函數中的問題

        public int Compare(object x, object y)
        {
            Salary s1 = x as Salary;
            Salary s2 = y as Salary;
            return s1.Bouns.CompareTo(s2.Bouns);
        }

這個函數中進行了轉型處理,這是會影響性能的。如果集合中有成千上萬個複雜的實體對象,那麼進行排序時耗費的時間是巨大的。所以泛型登場,很好的解決了這個問題。

因此以上代碼中的ArrayList,可以替換為List<T>,對應的我們就應該實現IComparable<T>和IComparer<T>。

實現的代碼如下:  

1、實體類實現介面IComparable<T>  2、自定義比較器實現介面IComparer<T> 3、進行排序的調用

複製代碼
    public class Salary:IComparable<Salary>
    {
        /// <summary>
        /// 姓名
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// 基本工資
        /// </summary>
        public int BaseSalary { get; set; }

        /// <summary>
        /// 獎金
        /// </summary>
        public int Bouns { get; set; }

        /// <summary>
        /// 實現IComparable介面
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>

        public int CompareTo(Salary other)
        {
            return BaseSalary.CompareTo(other.BaseSalary);
        }
    }
複製代碼 複製代碼
    public class BounsComparer : IComparer<Salary>
    {
        public int Compare(Salary x, Salary y)
        {
            return x.Bouns.CompareTo(y.Bouns);
        }
    }
複製代碼 複製代碼
                List<Salary> array =new List<Salary>();
                array.Add(new Salary() { Name = "aehyok", BaseSalary = 12000,Bouns=500 });
                array.Add(new Salary() { Name = "Kris", BaseSalary = 11200,Bouns=400 });
                array.Add(new Salary() { Name = "Leo", BaseSalary = 18000,Bouns=300 });
                array.Add(new Salary() { Name = "Niki", BaseSalary = 20000,Bouns=700 });
                array.Sort(new BounsComparer());
                foreach (Salary obj in array)
                {
                    Console.WriteLine(string.Format("{0} \tBaseSalary:{1}\tBouns{2}", obj.Name, obj.BaseSalary,obj.Bouns));
                }
                Console.ReadLine();
複製代碼

最終結果

建議11、區別對待==和Equals

 這裡我之前有一篇博文針對==和Equals有過專門的介紹,在此就不再進行過多的闡述了http://www.cnblogs.com/aehyok/p/3505000.html

建議12、重寫Equals時也要重寫GetHashCode

 下麵先來看一個簡單的小例子,定義如下實體類:

複製代碼
    public class Person
    {
        public string IDCode { get;private set; }

        public Person(string idCode)
        {
            this.IDCode = idCode;
        }

        public override bool Equals(object obj)
        {
            return IDCode == (obj as Person).IDCode;
        }
    }
複製代碼

針對上面實體類進行編譯

這裡會有一個提示暫時先不管

    public class PersonMoreInfo
    {
        public string SomeThing { get; set; }
    }

通過這兩個實體類,我們來使用以下Dictionary類型,代碼如下:

複製代碼
    class Program
    {
        static Dictionary<Person, PersonMoreInfo> PersonValues = new Dictionary<Person, PersonMoreInfo>();
        static void Main(string[] args)
        {
            AddAPerson();
            Person mike = new Person("aehyok");
            Console.WriteLine(PersonValues.ContainsKey(mike));
            //Console.WriteLine(mike.GetHashCode());
            Console.ReadLine();
        }
        static void AddAPerson()
        {
            Person mike = new Person("aehyok");
            PersonMoreInfo mikeValue = new PersonMoreInfo() {  SomeThing="aehyok's Info"};
            PersonValues.Add(mike, mikeValue);
            //Console.WriteLine(mike.GetHashCode());
            Console.WriteLine(PersonValues.ContainsKey(mike));
        }
    }
複製代碼

結果為true,false。

理論上來說,我們重寫了Person類中的Equals方法,也就是說在AddAPerson方法中的mike和在Main函數中的mike屬於”值相等“。從上面的結果可以發現,針對同一個實例,這種結論是正確的,針對不同的實例,這種結果就是有問題的。

基於鍵值的集合(如上面的Dictionary)會根據Key值來查找Value值。CLR內部會優化這種查找,實際上,最終是根據Key值的HasCode來查找Value值。代碼運行的時候,CRL首先會調用Person類型的GetHashCode,由於發現Person沒有實現GetHashCode,所以CLR最終會調用Object的 GetHashCode方法。將上面代碼中的兩行註釋代碼去掉,運行程式得到輸出

 

可以發現,AddAPerson方法和Main方法中的兩個mike的HashCode是不同的。這是因為:Object為所有的CLR類型都提供了GetHashCode的預設實現。每new一個對象,CLR都會為該對象生成一個固定的整形值,該整形值在對象的生存周期內不會改變,而該對象預設的GetHashCode實現就是對該整型值求HashCode。所以,在上面的代碼中,兩個mike兌現雖然屬性值都一致,但是它們預設實現的HashCode不一致,這就導致Dictionary中出現異常的行為。

想要修正該問題,就必須重寫GetHashCode方法。Person類的一個簡單的重寫可以是如下的代碼:

        public override int GetHashCode()
        {
            return this.IDCode.GetHashCode();
        }

此時再運行上面的代碼,會發現

兩者的HashCode是一致的,而dictionary也會找到相應的鍵值。

GetHasCode方法存在另外一個問題,就是它永遠只返回一個整型,而整型類型的容量顯然無法滿足字元串的容量

            string str1 = "NB0903100006";
            string str2 = "NB0904140001";
            Console.WriteLine(str1.GetHashCode());
            Console.WriteLine(str2.GetHashCode());

這兩個字元串產生的HasCode是一樣的。為了減少這種情況,我們稍作修改:

        public override int GetHashCode()
        {
            return (System.Reflection.MethodBase.GetCurrentMethod().DeclaringType.FullName+"#"+this.IDCode).GetHashCode();
        }

重寫Equals方法的同時,也應該實現一個類型安全的介面IEquatable<T>,所以Person類型的最終代碼如下:

複製代碼
    public class Person:IEquatable<Person>
    {
        public string IDCode { get;private set; }

        public Person(string idCode)
        {
            this.IDCode = idCode;
        }

        public override bool Equals(object obj)
        {
            return IDCode == (obj as Person).IDCode;
        }

        public override int GetHashCode()
        {
            return (System.Reflection.MethodBase.GetCurrentMethod().DeclaringType.FullName+"#"+this.IDCode).GetHashCode();
        }

        public bool Equals(Person other)
        {
            return IDCode == other.IDCode;
        }
    }
複製代碼

對於IEquatable介面暫時沒接觸過。第一次使用


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 前言本文的文字及圖片來源於網路,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯繫我們以作處理。作者:唯戀殊雨 目錄 pexpect fabric pexpect Pexpect 是 Don Libes 的 Expect 語言的一個 Python 實現,是一個用來啟動子程式 ...
  • [TOC] 數據可視化是用圖形或者表格的形式進行數據顯示,用圖形化的手段,清晰有效地傳遞與溝通信息。既要保證直觀易分析,又要保證美感。實現的對稀疏,肉眼無法分析的數據進行深入洞察。 下麵就介紹用python的一些方法進行可視化處理。 使用工具:jupyter notebook。 一:配置jupyte ...
  • 最近做了幾個項目,都有在產品貼標的需求 基本就是有個證卡類印表機,然後把產品的信息列印在標簽上。 然後通過機器人把標簽貼到產品上面 標簽信息包括文本,二維碼,條形碼之類的,要根據對應的數據生成二維碼,條形碼。 列印標簽的需求接到手後,開始了我的填坑之旅。 列印3.0源代碼:https://githu ...
  • [toc] 目前存在多個 .NET 框架。 Microsoft 的宗旨是在最大範圍的操作系統和硬體平臺上提供 .NET 實現。 下表列出了最主要的 .NET 實現: 實現|描述| | .NET Core|真正跨平臺和開源的 .NET 框架,為伺服器和命令行應用程式提供了高度模塊化的 API 集合 M ...
  • [toc] 處理器不能直接解釋程式集。程式集用的是另一種語言,即公共中間語言(Common Intermediate Language,CIL),或稱為中間語言(IL)[^1]。 [^1]: CIL 的第三種說法是 Microsoft IL(MSIL)。 本博客使用 CIL 一詞,因其是 CLI 標 ...
  • 前言 本文已更新至http://www.cnblogs.com/aehyok/p/3624579.html 。本文主要學習記錄以下內容: 建議13、為類型輸出格式化字元串 建議14、正確實現淺拷貝和深拷貝 建議15、使用dynamic來簡化反射實現 建議13、為類型輸出格式化字元串 有兩種方法可以為 ...
  • 時間一晃,2019年即將結束了,Aspose公司在這一年又不斷更新和研發,發佈了好幾款全新的文件格式API以及適用於更多新的語言平臺,滿足了更多用戶的需求。 Aspose是全球領先的圖表控制項開發商,旗下產品覆蓋Word、Excel、PDF、條碼、ZIP、CAD、HTML、電子郵件、PSD等各個文檔管 ...
  • PDF 1.7標準發佈已久,而令人興奮的是,終於,.NET版Aspose Words轉換升級,支持將PDF轉換為PDF 1.7標準!近日,Aspose Words for .NET更新到了v19.12版,在Windows10上使用SystemFontSource時,支持用戶安裝的字體,OLE對象數據 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...