C# 中的IComparable和IComparer

前言

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

IComparable介面

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

通常，提供Icomparable實作的型別還IEquatable實作介面，IEquatable介面Equals定義方法，該方法確定實作型別的實體的相等性，

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

示例：

    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

標籤：其他

上一篇：C#日志類

下一篇：如何運用領域驅動設計 - 作業單元