C#集合 -- Equality和Order插件

在前面的文章C#相等性比較和C#排序比較中，我已經敘述了類型相等，類型哈希，和類型比較的.NET標準協議。實現了這些協議的類型在一個字典或者列表中也可以正常工作。但是需要注意的是：

• 只有當類型的Equals方法和GetHashCode方法返回有意義的結果時，該類型才可以作為Dictionary或Hashtable的鍵
• 只有當類型實現了IComparable/IComparable<T>才可以作為排序字典或排序列表的鍵

一個類型的默認相等實現或比較實現典型地反映了該類型最“自然”的那一面。但是，有時候，默認的行為并不是你期望的效果。你可能希望一個string類型的鍵可以區分大小寫；或者你希望一個可排序的客戶列表按照客戶的郵政編碼排序。由于這些原因，.NET Framework定義了一組對應的插入協議，該協議可以實現下面兩個目的：

• 允許你在可替代的相等性行為或可替代的比較行為之間相互切換
• 允許你使用一個字典或一個排序集合，它們的鍵的類型內在是不等的或不可比較的

這些協議由下面的接口組成：

IEqualiyComparer和IEqualityComparer<T>

• 執行插件式相等性比較和哈希
• 可被Hashtable和Dictionary識別

IComparer和IComparer<T>

• 執行插件式排序比較
• 可被排序字典或拍戲集合，以及Array.Sort識別

每個接口都有generic和非generic的版本。IEqualityComparer接口也包含了EqualityComparer的默認的實現。

此外，在Framework 4.0中，還引入了兩個新的接口IStructuralEquatable和IStructuralComparable，它們允許結構可以像類或者數組那樣執行比較。

IEqualityComparer和EqualityComparer

相等性比較在非默認的相等性和哈希行為上切換，這主要適用于Dictionary類和HashTable類。

回憶一下以哈希表為基礎的字典，對于一個指定的鍵，需要回答下面兩個問題：

• 該鍵與其他的鍵是否相同？
• 該鍵的哈希碼是多少？

實現IEqualityComparer的相等性比較器可以回答上面兩個問題

public interface IEqualityComparer<T>{bool Equals (T x, T y);int GetHashCode (T obj);}public interface IEqualityComparer // Nongeneric version{bool Equals (object x, object y);int GetHashCode (object obj);}

為了創建一個自定義比較器，你需要實現上面一個或者兩個接口（如果實現了上面連個接口，那么就可以保證最大程度的互操作）。但這么做優點單調，另外一種替換方法是為抽象類EqualityComparer類創建子類，EqualityComparer的定義如下：

public abstract class EqualityComparer<T> : IEqualityComparer,IEqualityComparer<T>{public abstract bool Equals (T x, T y);public abstract int GetHashCode (T obj);bool IEqualityComparer.Equals (object x, object y);int IEqualityComparer.GetHashCode (object obj);public static EqualityComparer<T> Default { get; }}

由于EqualityComparer實現連個兩個接口，因此你的工作就簡化為重寫它的兩個抽象方法。

Equals方法和GetHashCode與我們在C#相等性比較中所敘述的一樣。在下面的例子中，我們定義一個Customer類，它包含兩個成員，然后創建一個相等性比較器以比較客戶的姓名是否相等。

public class Customer{public string LastName;public string FirstName;public Customer (string last, string first){LastName = last;FirstName = first;}}public class LastFirstEqComparer : EqualityComparer <Customer>{public override bool Equals (Customer x, Customer y){return x.LastName == y.LastName && x.FirstName == y.FirstName;}public override int GetHashCode (Customer obj){return (obj.LastName + ";" + obj.FirstName).GetHashCode();}}

為了演示器可以工作，我們創建兩個客戶實例

Customer c1 = new Customer ("Bloggs", "Joe");Customer c2 = new Customer ("Bloggs", "Joe");

由于我們沒有重寫object.Equals，在執行比較時，會執行常規的引用類型比較

Console.WriteLine (c1 == c2); // FalseConsole.WriteLine (c1.Equals (c2)); // False

如果我們創建一個客戶字典實例，且使用默認的相等性比較器對這兩個客戶進行比較，那么會返回false

var d = new Dictionary<Customer, string>();d [c1] = "Joe";Console.WriteLine (d.ContainsKey (c2)); // False

最后，如果我們在創建字典實例時，在構造函數中指定了自定義相等性比較

var eqComparer = new LastFirstEqComparer();var d = new Dictionary<Customer, string> (eqComparer);d [c1] = "Joe";Console.WriteLine (d.ContainsKey (c2)); // True

EqualityComparer<T>.Default

調用EqualityComparer<T>.Default返回一個generic的相等性比較器，使用這個比較器可以替代靜態的object.Equals方法。使用這種方式的優點在于，它首先檢查類型T是否實現了IEquatble<T>；如果它實現了這個接口，那么就就調用該實現，從而避免了額外的裝箱操作。這特別適用于generic的方法：

static bool Foo<T> (T x, T y){bool same = EqualityComparer<T>.Default.Equals (x, y);...}

IComparer和Comparer

對于排序字典和集合，比較器還經常用于替代自定義排序。

請注意，比較器對于非排序字典和哈希表沒有作用，這位非排序字典和哈希表需要IEqualityComperer去獲取哈希碼。類似地，一個相等性比較器在排序字典和集合中也不會有用。

下面是IComparer接口的定義

public interface IComparer{int Compare(object x, object y);}public interface IComparer <in T>{int Compare(T x, T y);}

如果，你要使用相等性比較，你可以繼承抽象類Comparer<T>，而不是實現ICompare接口或/和ICompare<T>接口。

public abstract class Comparer<T> : IComparer, IComparer<T>{public static Comparer<T> Default { get; }public abstract int Compare (T x, T y); // Implemented by youint IComparer.Compare (object x, object y); // Implemented for you}

下面的列子演示了一個類wish，一個比較器通過wish類的PRipority屬性進行排序

class Wish{public string Name;public int Priority;public Wish (string name, int priority){Name = name;Priority = priority;}}class PriorityComparer : Comparer <Wish>{public override int Compare (Wish x, Wish y){if (object.Equals (x, y)) return 0; // Fail-safe checkreturn x.Priority.CompareTo (y.Priority);}}

調用object.Equals方法確保了我們的比較結果不會與Equals方法矛盾。在上面的例子中，調用靜態方法object.Equals方法比調用x.Equals方法好，這是因為x可能是null。

下面的代碼演示了如何使用PriorityComparer來排序一個列表

var wishList = new List<Wish>();wishList.Add (new Wish ("Peace", 2));wishList.Add (new Wish ("Wealth", 3));wishList.Add (new Wish ("Love", 2));wishList.Add (new Wish ("3 more wishes", 1));wishList.Sort (new PriorityComparer());foreach (Wish w in wishList) Console.Write (w.Name + " | ");// OUTPUT: 3 more wishes | Love | Peace | Wealth |

在下面的例子中，SurnameComparer允許你對電話簿列表的聯系人數據按照姓進行排序

class SurnameComparer : Comparer <string>{string Normalize (string s){s = s.Trim().ToUpper();if (s.StartsWith ("MC")) s = "MAC" + s.Substring (2);return s;}public override int Compare (string x, string y){return Normalize (x).CompareTo (Normalize (y));}}var dic = new SortedDictionary<string,string> (new SurnameComparer());dic.Add ("MacPhail", "second!");dic.Add ("MacWilliam", "third!");dic.Add ("McDonald", "first!");foreach (string s in dic.Values)Console.Write (s + " "); // first! second! third!

StringComparer

StringComparer是一個預定義的插件式類，用于字符串的相等性比較和排序比較，并允許你指定語言和是否區分大小寫。StringComparer實現了IEqualityComparer和IComparer接口（以及它們的Generic類型接口）。因此，它可以用于任何類型的字典或者排序集合。它的定義如下

public abstract class StringComparer : IComparer, IComparer <string>,IEqualityComparer,IEqualityComparer <string>{public abstract int Compare (string x, string y);public abstract bool Equals (string x, string y);public abstract int GetHashCode (string obj);public static StringComparer Create (CultureInfo culture,bool ignoreCase);public static StringComparer CurrentCulture { get; }public static StringComparer CurrentCultureIgnoreCase { get; }public static StringComparer InvariantCulture { get; }public static StringComparer InvariantCultureIgnoreCase { get; }public static StringComparer Ordinal { get; }public static StringComparer OrdinalIgnoreCase { get; }}

由于StringComparer是抽象類，所以你需要通過它的靜態方法或屬性獲取實例。StringComparer.Ordinal是字符串相等性比較的默認行為；StringComparer.CurrentCulture是字符串排序的默認行為。

在下面的例子中，創建了一個有序的區分大小寫的字典，因為dict[“Joe”]和dict[“JOE”]是相等的

var dict = new Dictionary<string, int> (StringComparer.OrdinalIgnoreCase);

在下面的例子中，名字數組使用澳洲英語排序

string[] names = { "Tom", "HARRY", "sheila" };CultureInfo ci = new CultureInfo ("en-AU");Array.Sort<string> (names, StringComparer.Create (ci, false));

最后一個例子則是區分文化的SurnameComparer

class SurnameComparer : Comparer <string>{StringComparer strCmp;public SurnameComparer (CultureInfo ci){// Create a case-sensitive, culture-sensitive string comparerstrCmp = StringComparer.Create (ci, false);}string Normalize (string s){s = s.Trim();if (s.ToUpper().StartsWith ("MC")) s = "MAC" + s.Substring (2);return s;}public override int Compare (string x, string y){//