C# 中的IComparable和IComparer

前言

在開發過程中經常會遇到比較排序的問題，比如說對集合數組的排序等情況，基本類型都提供了默認的比較算法，如string提供了按字母進行排序，而int整數則是根據整數大小進行排序.但是在引用類型中(具有多個字段)，那么這個排序當然也是取決於我們特定的值。

IComparable接口

該接口由其值可以排序或排序的類型實現，並提供強類型的比較方法以對泛型集合對象的成員進行排序，例如數字可以大於第二個數字，一個字符串可以在另一個字符串之前以字母順序出現。他要求實現類型定義的一個方法，CompareTo(T)該方法指示當前實現在排序順序中的位置是在同一個類型和第二個對象之前、之后還是與其相同。通常，不會直接從開發人員代碼中調用方法。相反他由List .Sort()和Add等方法自動調用。

通常，提供Icomparable 實現的類型還IEquatable 實現接口。IEquatable 接口Equals定義方法，該方法確定實現類型的實例的相等性。

CompareTo(T)方法的實現必須Int32返回具有以下三個值之一的，如下表所示。

值	含義
小於零	此對象在排序順序中位於CompareTo方法所指定的對象之前。
零	此當前實例在排序順序中與CompareTo方法參數指定的對象出現在同一位置。
大於零	此當前實例位於排序順序中由CompareTo方法自變量指定的對象之后。

示例：

    class Student : IComparable
    {
        public string Name { get; set; }

        public int Age { get; set; }
        public int CompareTo(object obj)
        {
            if (!(obj is Student))
            {
                throw new ArgumentException("Compared Object is not of student");
            }
            Student student = obj as Student;
            return Age.CompareTo(student.Age);
        }
    }

Ps:我們根據通過Age(int)來進行我們的排序

執行測試

class Program
    {
        static void Main(string[] args)
        {
            ArrayList studentList = new ArrayList {
                new Student{Name="a",Age=9 },
                  new Student{Name="a3",Age=7 },
                 new Student{Name="a1",Age=6 },
                 new Student{Name="a2",Age=10 },
            };
            studentList.Sort();
            StudentComparable(studentList);

            Console.ReadLine();
        }

        private static void StudentComparable(ArrayList studentList)
        {
            foreach (Student item in studentList)
            {
                Console.WriteLine("Name:{0},Age:{1}", item.Name, item.Age);
            }
        }
    }

輸出如下

IComparer接口

IComparable 接口的CompareTo方法一次只能對一個字段進行排序，因此無法對不同的屬性進行排序。IComparer接口提供了Compare方法，該方法比較兩個對象並返回一個值，該值指示一個對象小於，等於或大於另一個對象。實現IComparer接口的類必須提供比較兩個對象的Compare方法。例如，您可以創建一個StudentComparer類，該類實現IComparer，並具有一個Compare方法，該方法按Name比較Student對象。然后，您可以將StudentComparer對象傳遞給Array.Sort方法，它可以使用該對象對Student對象的數組進行排序。

示例

    class StudentComparer : IComparer
    {

        public int Compare(object x, object y)
        {
            Student x1 = x as Student;
            Student y1 = y as Student;
            return x1.Name.CompareTo(y1.Name);
        }
    }

Ps:我們根據Name(string)進行排序

執行測試

    class Program
    {
        static void Main(string[] args)
        {
            ArrayList studentList = new ArrayList {
                new Student{Name="a",Age=9 },
                  new Student{Name="a3",Age=7 },
                 new Student{Name="a1",Age=6 },
                 new Student{Name="a2",Age=10 },
            };
            studentList.Sort(new StudentComparer());
            StudentComparable(studentList);

            Console.ReadLine();
        }

        private static void StudentComparable(ArrayList studentList)
        {
            foreach (Student item in studentList)
            {
                Console.WriteLine("Name:{0},Age:{1}", item.Name, item.Age);
            }
        }
    }

輸出結果如下

IComparable 和IComparer

上述示例中我們將對象進行了多次的裝箱和拆箱，那么此時我們可以將方法改為泛型的，泛型的出現也讓我們避免了裝箱和拆箱的資源浪費.

最終我們實現的代碼片段如下:

IComparable

    class Student : IComparable<Student>
    {
        public string Name { get; set; }

        public int Age { get; set; }

        public int CompareTo([AllowNull] Student other)
        {
            return Age.CompareTo(other.Age);
        }
    }

IComparer

    class StudentComparer : IComparer<Student>
    {

        public int Compare([AllowNull] Student x, [AllowNull] Student y)
        {
            return x.Name.CompareTo(y.Name);
           
        }
    }

總結

參考：https://docs.microsoft.com/en-us/dotnet/api/system.icomparable-1?view=netframework-4.8

示例：https://github.com/hueifeng/BlogSample/tree/master/src/CompareDemo