深入理解C#(一)_雙等號跟Equals差異_如用於集合中請再記得覆寫GetHashCode

-
在日常開發中常碰到的比對數值、字串是否相等 
你都是用雙等號 還是 Equals呢?

而這兩者到底有捨麼差別


在此之前必須先有一觀念
於CLR(Common Language Runtime，.NET 提供的執行期間環境)
有定義所謂的「相等性」分為「值相等性」和「引用相等性」
「值相等性」(對數值型別)
若比較兩變數所含的值相等，則定義為值的相等。
在,NET裡面對於string這種一特殊的參考型態，微軟則覺得它更趨近於數值型態。

「引用相等性」(對參考型別)
若筆記的是兩變數引用的是記憶體中相同一個物件，則稱為引用的相等。


一般我們在使用上其實不會有很大差異
但實際上，值類型 和 參考(引用)類型的 Equals比較方式不一樣  !!
因此會看到有人用雙等號有人用Equals

Test Code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace App1
{
    class Program
    {
        static void Main(string[] args)
        {
            int num1 = 1;//C# 內建關鍵字  對應到System.Int32 struct型別
            int num2 = 1;
            Console.WriteLine(num1 == num2);//true
            Console.WriteLine(num1.Equals(num2));//true
            string strVal1 = "apple";//C# 內建關鍵字 對應到System.String Class型別
            string strVal2 = "apple";
            Console.WriteLine(strVal1 == strVal2);//true
            Console.WriteLine(strVal1.Equals(strVal2));//true

            String strObj1 = "banana";//System.String 屬於內建型態(Predefined Type) 這個是Class (Reference Type)
            String strObj2 = "banana";
            Console.WriteLine(strObj1 == strObj2);//true
            Console.WriteLine(strObj1.Equals(strObj2));//true

            Console.ReadKey();
        }
    }
}

一般自定義的類別設計層面較會跟string這參考型別類似
(PS:於FLC(.NET Framework Class Library)中，String的比較會是針對於"型別的值"，而非針對引用本身的比較。)

String.Equals 方法:
判斷兩個 String 物件是否具有相同的值。
而若用雙等於運算子實際上底層也是間接call String.Equals



以下我們做一個Reference Type的測試

在透過object來測試同樣值都是1的情況
又會發現明明值一樣但雙等號竟然返回false的情況，


因為object num1 , num2各自都為獨立的物件。
1這個值並非透過明確實質型別int來存，而是Boxing成object，因此會變成是在做
object == object之間的比對。

等於等於 ( = = ) 比較運算子:
對於預先定義的實值型別 (Value Type)，等號比較運算子 (==) 在運算元相等時傳回 true；否則傳回 false。 對於 string 以外的參考型別，若兩個運算元參考到同一物件，== 會傳回 true。 對於 string 型別，== 會比較字串的值。

換言之，等於等於運算子只有在實際型別(int ,double)或string這種時候用來比較值相等會是有效的，就是我們平常認知的值相等比對，但若是物件跟物件之間的參考型別比對則會發現即便值相同，但參考不同記憶體位址因而返回false這結果。


一個生活化例子
一家公司員工離職後又復職的一個情境

Test Code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace App1
{
    class Program
    {
        static void Main(string[] args)
        {
            Employee employee1 = new Employee("A0001");
            Employee employee2 = new Employee("A0001");
            Console.WriteLine(employee1.Equals(employee2));//false
            employee2 = employee1;
            Console.WriteLine(employee1.Equals(employee2));//true
            Console.ReadKey();
        }
    }

    class Employee
    {
        public string WorkerId { get; private set; }
        public Employee(string WorkId)
        {
            this.WorkerId = WorkId;
        }

    }

}

會得知參考型別下確實會返回不同即便工號不變，再重新導向記憶體後就又回傳為相同了。

於現實環境中，只要工號一致理論上就代表同一人。
這時候則可透過覆寫Equals的技巧。
於比對時將傳入的object強制轉型為Employee針對WorkerId屬性進行比較。

Test Code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace App1
{
    class Program
    {
        static void Main(string[] args)
        {
            Employee employee1 = new Employee("A0001");
            Employee employee2 = new Employee("A0001");
            Console.WriteLine(employee1.Equals(employee2));//true
            
            //employee2 = employee1;
            //Console.WriteLine(employee1.Equals(employee2));//true
            Console.ReadKey();
        }
    }

    class Employee
    {
        public string WorkerId { get; private set; }
        public Employee(string WorkId)
        {
            this.WorkerId = WorkId;
        }
        public override bool Equals(object obj)
        {
            //return base.Equals(obj);
            return this.WorkerId == ((Employee)obj).WorkerId;
        }
    }

}



Equals 基本上不太建議自行去覆寫，除非遇到的情境是自訂的型別會用於某個集合的鍵值。
如用於集合中請再記得覆寫GetHashCode

這裡擴充一Class
EmployeeInfo

Test Code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace App1
{
    class Program
    {
        static Dictionary<Employee, EmployeeInfo> dicEmpInfo = new Dictionary<Employee, EmployeeInfo>();

        static void Main(string[] args)
        {
            #region test
            AddEmp();
            Employee employee1 = new Employee("A0001");
            Console.WriteLine("Is Contains Info:" + dicEmpInfo.ContainsKey(employee1));//false
            #endregion
            Console.ReadKey();
        }

        static void AddEmp()
        {
            Employee employee1 = new Employee("A0001");
            EmployeeInfo emp1_info = new EmployeeInfo() { EmpFile = @"C:\EmpDoc\A0001" };
            dicEmpInfo.Add(employee1, emp1_info);
            Console.WriteLine("Is Contains Info:" + dicEmpInfo.ContainsKey(employee1));//true
        }
    }

    class Employee
    {
        public string WorkerId { get; private set; }
        public Employee(string WorkId)
        {
            this.WorkerId = WorkId;
        }
        public override bool Equals(object obj)
        {
            //return base.Equals(obj);
            return this.WorkerId == ((Employee)obj).WorkerId;
        }
    }

    class EmployeeInfo
    {
        public string EmpFile { get; set; }
    }

}




於主程式中會發現返回是false，但明明已經有添加相同值的物件了
原因則在於HashCode的差別


因此除了上述覆寫的Equals
還要再對GetHashCode 覆寫

Test Code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
class Employee
    {
        public string WorkerId { get; private set; }
        public Employee(string WorkId)
        {
            this.WorkerId = WorkId;
        }
        public override bool Equals(object obj)
        {
            //return base.Equals(obj);
            return this.WorkerId == ((Employee)obj).WorkerId;
        }
        public override int GetHashCode()
        {
            //return base.GetHashCode();
            return this.WorkerId.GetHashCode();
        }
    }

再次執行就可更精確的得到 True ，Dictionary 也就能正常使用了!


結論:
若比較型別屬於參考的物件型態則需要額外注意或動手腳!!!
其餘數值、字串，只要是以明確實質型態在宣告指派的都能混用比較運算子(雙等號)或Equals



Ref:
Object.Equals 方法
https://docs.microsoft.com/zh-tw/dotnet/api/system.object.equals?view=netcore-3.1

String.Equals 方法
https://docs.microsoft.com/zh-tw/dotnet/api/system.string.equals?view=netcore-3.1

等號比較運算子 (C# 參考)
https://docs.microsoft.com/zh-tw/dotnet/csharp/language-reference/operators/equality-operators

留言

張貼留言

這個網誌中的熱門文章

何謂淨重(Net Weight)、皮重(Tare Weight)與毛重(Gross Weight)

-
圖片
當談到貨物的重量時，往往會分成所謂的淨重(Net Weight)與毛重(Gross Weight)。 會有以下公式關係存在 淨重=毛重-皮重(包裝物的重量) 毛重=淨重+皮重 淨重( Net Weight 縮寫為N.W.) 指物品本身的重量，不包括容器或包裝材料的重量。 凈重是國際貿易中最常見的計重辦法。 例如，如果運輸原材料，原材料的重量就是所運輸貨物的淨重。包裝原材料的容器或包裝不計入淨重。同樣地，當我們考慮一罐豆子時，罐子內所含物品的重量就算作淨重。因此，淨重將包括豆子、罐頭里的任何液體，以及保存豆子所含的物品。 大多數 以重量為計價的貨物買賣 ，採用此計價方法。 若合同中並未明確規範以何種方式計量和計價時，按慣例以凈重計價。 毛重( Gross Weight 縮寫G.W.) 貨物連同它的包裝的重量，是你托運的所有物品的總重量。 皮重(Tare Weight) 指商品外包裝材料的重量(即運輸包裝的重量)，不包括內包裝材料和襯墊物的重量。 比方一個空的貨櫃、容器、或任何包裝材料的重量。 Net Net Weight純淨重 (指從Net Weight中扣除內包裝後的重量) 進出口商品為了因應運輸及消費需求, 一般都有內包裝與外包裝。 一般在買賣合同與信用狀中,通常只要求於裝箱單上註明Gross Weight和Net Weight即可, 但有些L/C 要求 Net Net Weight,大多是海關徵收從量稅時的依據 運輸重量對於航運業或者航空運輸等各自都通用這些術語 為何特別在意重量? 主要就在於會影響像是傳輸安全乘載限制。 就運輸層面(不同方式的運輸) 航空運輸：對機長而言，毛重包括皮重、產品淨重以及飛機、燃料、乘客和機組人員的重量。 公路/鐵路運輸:對於火車車長而言，毛重包括產品淨重、皮重和運輸車輛的重量。 水路航運運輸：對船長而言，毛重就是淨重和皮重之和。 就公司ERP成本角度 成本一般都會採用 "淨重" 主要是因為若用毛重，可能會有輔材不可控因素存在 比方一個 5cm 固定塑膠件，今天用一個 10cm 紙箱測重，明天用一個 100cm 紙箱測重，那可能就容易導致ERP資料比較會失真。 就物流層面來探討 通常還會有一名詞即所謂「實際重量」(Actual Weight) 根據稱重(過磅)所得到的重量，實際重量分為實際毛重(Gross Weig...
閱讀完整內容

Architecture(架構) 和 Framework(框架) 有何不同?_軟體設計前的事前規劃的藍圖概念

-
圖片
一個應用程式(軟體) 不管是  互動拍照 也好、 投影也好、車牌偵測... 舞台演唱會後方電視牆的互動應用程序、 粒子特效、3D或2D遊戲  等等 開發者通常都需要在一開始做規劃 ㄟ  假設我今天要寫 跟影像有關 可能需要偵測、可能需要提取前景、可能需要偵測圓形 之類的 我有  emgucv 、AForge.Net、 opencv 等等可以用 但是 假設我今天要做的應用程序是需要有視窗介面的~~ emgucv 跟 C# windows form 媒合性 就很高 而且直接在 visual studio 做開發 opencv 我可能還需要依賴 Qt 之類等等  framework 假設我今天是要寫一個 演唱會電視牆互動粒子特效 可能就會挑   openframeworks  、 processing 、kinect 來寫互動 Achitecture  --->全稱 :  Software Architecture   軟體架構 Achitecture   由好多 framework 組成 軟體架構（Software Architecture）是一種軟體在開發前的設計藍圖， 用來告訴軟體的結構，功能，介面，用法，與其他系統的構連以及資料交換等等規範， 但它並沒有叫你要用什麼方式實作， 因此軟體架構通常會產生文件，圖樣，原型以及規格等， 就是沒有可用的程式碼，因為那不是軟體架構應該有的東西， 就像蓋房子時是給你藍圖，而不是一幢蓋好的房子。 軟體框架（Framework):是一個已經成形的方法，而且有程式碼實體 （例如鋼構工法也是要有鋼材才能做），並且會告訴你要如何使用它 （即 Framework Documentation，MSDN Library 即為一最佳例子）
閱讀完整內容

經得起原始碼資安弱點掃描的程式設計習慣培養(五)_Missing HSTS Header

-
圖片
  接續前幾篇系列 經得起原始碼資安弱點掃描的程式設計習慣培養(一)_OWASP Top 10(十大網站安全風險)_學習寫更安全程式碼的網站推薦 經得起原始碼資安弱點掃描的程式設計習慣培養(二)_8.Insecure Deserialization ：不安全的反序列化漏洞ASP.NET處理方式 經得起原始碼資安弱點掃描的程式設計習慣培養(三)_7.Cross Site Scripting(XSS)_Stored XSS_Reflected XSS All Clients 經得起原始碼資安弱點掃描的程式設計習慣培養(四)_1.Injection注入攻擊_SQL Injection)_order by 語句正確參數化套入 最近又遇到被若安掃描到高風險要修正的程式碼啦.... 一看這還真是搞不懂該怎麼修呢 HSTS(HTTP Strict Transport Security)  主要是一份國際標準規格 (RFC 6797) 的網際網路瀏覽安全機制， 用於宣告瀏覽器與伺服器之間通訊方式必須強制採用 TLS/SSL 加密通道。 只要從伺服器端送出一個 Strict-Transport-Security 標頭 (Header) 給瀏覽器，即可告知瀏覽器於未來的某段時間內一律使用 SSL 來和該網站連接 (設定可涵蓋所有子域名網站)， 一旦發生憑證失效情況，使用者將無法再瀏覽該網站，如此一來便可大幅減少中間人攻擊的問題發生。 再更白話一點 HSTS Header 就是負責將 http 強制轉為 https CheckMarx掃碼報告給的說明 ============================================================ 風險: 如果web config沒有設置HSTS表頭、"max-age"(有效期)不足一年， 或沒有設定"includeSubDomains"(包含所有子網域)，可能會使用戶容易遭受中間人攻擊。 發生原因: 許多使用者只要在瀏覽器的網址列輸入網域名稱(Domain Name)即可瀏覽網站， 並沒有輸入協定(Protocol)的名稱。 瀏覽器會自動假設使用者使用的是HTTP協定而不是有加密機制的HTTPS協定。 在第一次發出前往特定網站的請求時，攻擊者可以執行中間人攻擊並將用戶轉址到...
閱讀完整內容