Effective C# 使用IComparable和IComparer接口实现排序关系

有时候，我们的类型需要排序关系来支持它们在集合中的排序和搜索。.NET框架定义了两个接口来描述类型的排序关系：IComparable和IComparer。IComparable接口定义了类型的自然排序方式。IComparer则为类型提供了另外的排序方式。我们可以为类型实现各种关系操作符（<、>、<=、>=）来提供特定于类型的比较操作，从而避免接口实现所带来的运行时开销。本条款讨论如何通过两个接口IComparable和IComparer，来为类型实现排序关系，从而支持使用.NET框架对我们的类型进行排序，并帮助其他用户通过这些操作获取最佳的性能。

IComparable接口仅包含一个方法：CompareTo()。该方法保持了C语言库函数strcmp的传统：返回值小于0表示当前对象小于被比较的对象，返回值等于0表示两个对象相等，返回值大于0表示当前对象大于被比较的对象。

IComparable接口接受的参数类型为System.Object，因此我们需要对CompareTo()函数的参数进行运行时类型校验。每一次执行比较时，我们都要重新解析参数的类型：

 

public struct Customer : IComparable

{

private readonly string _name;

public Customer( string name )

{

    _name = name;

}

IComparable Members#region IComparable Members

public int CompareTo( object right )

{

    if ( ! ( right is Customer ) )

      throw new ArgumentException( "Argument not a customer",

        "right" );

    Customer rightCustomer = ( Customer )right;

    return _name.CompareTo( rightCustomer._name );

}

#endregion

}

 

像上面这样使用IComparable接口来实现比较操作有许多缺点。首先，我们必须检查参数的运行时类型。一些不正确的代码可以合法地将任何类型传递给CompareTo()方法。另外，即使正确的参数，如果是像上面的值类型，也要被执行装箱和拆箱来进行实际的比较。这对于每一次比较来说又是一个成本。对一个集合进行排序需要使用 IComparable. CompareTo()方法进行平均数为N×log(n)次的比较。每一次都将导致三次装箱操作和拆箱操作。对于一个拥有1000个Point的数组来说，平均将有超过20 000次装箱与拆箱操作，其中N×log(n)大约为7 000，每次比较有3次装箱与拆箱操作。我们必须寻找更好的替代方案。我们当然不能更改IComparable.CompareTo()的定义。

但这并非意味着我们必须强制用户承担这种弱类型实现的性能代价。我们可以创建自己的CompareTo()方法实现，使其接受的参数类型为Customer：

 

public struct Customer : IComparable

{

private string _name;

public Customer( string name )

{

    _name = name;

}

IComparable Members#region IComparable Members

// IComparable.CompareTo()

// 该方法在类型上不够安全。

// 必须检查参数right的运行时类型。

int IComparable.CompareTo( object right )

{

    if ( ! ( right is Customer ) )

      throw new ArgumentException( "Argument not a customer",

        "right" );

    Customer rightCustomer = ( Customer )right;

    return CompareTo( rightCustomer );

}

// 类型安全的CompareTo。

// 其中right是一个Customer或者派生自Customer的类。

public int CompareTo( Customer right )

{

    return _name.CompareTo( right._name );

}

#endregion

}

 

IComparable.CompareTo ()现在是一个显式接口实现（explicit interface implementa- tion）；它只可以通过IComparable接口来调用。从此，Customer结构的用户访问的将是类型安全的CompareTo( Customer right )，而类型不安全的IComparable.CompareTo ( object right )则无法访问。这样，如下有明显错误的代码就不会再通过编译：

 

Customer c1;

Employee e1;

if ( c1.CompareTo( e1 ) > 0 )

Console.WriteLine( "Customer one is greater" );

 

这段代码不能通过编译是因为所传递的参数e1与公有方法Customer.CompareTo ( Customer right )要求的参数类型不匹配。IComparable.CompareTo( object right )方法使用Customer是无法访问的，我们只可以通过将对象显式转型为IComparable接口来访问IComparable中的方法：

 

 

Customer c1;

Employee e1;

if ( ( c1 as IComparable ).CompareTo( e1 ) > 0 )

Console.WriteLine( "Customer one is greater" );

 

实现IComparable接口时，我们应该使用显式接口实现，同时为接口中的方法提供一个公有的强类型重载版本。强类型的重载版本在提高代码性能的同时，能减少误用CompareTo()方法的可能。对于.NET框架中的Sort函数，我们看不到这种做法所获得的好处，因为它仍旧是通过接口指针来访问CompareTo()方法（参见条款19）。但是如果代码已知两个参与比较的对象类型，那么上述做法就会获得比较好的性能。

下面我们对Customer结构做一个小的更改。C#语言允许我们重载标准的关系操作符，在为Customer重载这些操作符时，我们也应该使用类型安全的CompareTo()方法：

 

public struct Customer : IComparable

{

private string _name;

public Customer( string name )

{

    _name = name;

}

IComparable Members#region IComparable Members

// IComparable.CompareTo()

// 该方法在类型上不够安全。

// 必须检查参数right的运行时类型。

int IComparable.CompareTo( object right )

{

    if ( ! ( right is Customer ) )

      throw new ArgumentException( "Argument not a customer",

        "right");

    Customer rightCustomer = ( Customer )right;

    return CompareTo( rightCustomer );

}

// 类型安全的CompareTo()。

// 其中right是一个Customer或者派生自Customer的类。

public int CompareTo( Customer right )

{

    return _name.CompareTo( right._name );

}

// 关系操作符。

public static bool operator < ( Customer left,

    Customer right )

{

    return left.CompareTo( right ) < 0;

}

public static bool operator <=( Customer left,

    Customer right )

{

    return left.CompareTo( right ) <= 0;

}

public static bool operator >( Customer left,

    Customer right )

{

    return left.CompareTo( right ) > 0;

}

public static bool operator >=( Customer left,

    Customer right )

{

    return left.CompareTo( right ) >= 0;

}

#endregion

}

 

上面的代码描述了Customer根据name决定的标准排序关系。之后，我们需要创建一个根据revenue（收入）对所有客户进行排序的报表。我们仍然需要Customer中已经定义的标准比较功能——即根据name进行排序。这时，我们可以通过创建一个实现了IComparer接口的类，来满足其他的排序要求。IComparer接口为类型实现多种排序支持提供了一种标准的方式。.NET FCL中所有支持IComparable的方法也都提供了另外的重载版本来支持IComparer排序。因为是Customer结构的作者，所以我们可以在Customer结构中创建一个新的私有嵌套类（RevenueComparer），然后通过Customer结构中的静态属性提供给外界：

 

public struct Customer : IComparable

{

private string _name;

private double _revenue;

// 包含在前面示例代码的部分省略。

private static RevenueComparer _revComp = null;

// 返回一个实现了IComparer的对象。

// 使用“缓式评估（lazy evaluation）”只创建一个对象。

public static IComparer RevenueCompare

{

    get

    {

      if ( _revComp == null )

        _revComp = new RevenueComparer();

      return _revComp;

    }

}

// 下面的类根据收入来比较Customer。

// 因为总是通过接口指针来使用，所以仅提供接口方法的实现。

private class RevenueComparer : IComparer

{

    IComparer Members#region IComparer Members

    int IComparer.Compare( object left, object right )

    {

      if ( ! ( left is Customer ) )

        throw new ArgumentException(

          "Argument is not a Customer",

          "left");

      if (! ( right is Customer) )

        throw new ArgumentException(

          "Argument is not a Customer",

          "right");

      Customer leftCustomer = ( Customer ) left;

      Customer rightCustomer = ( Customer ) right;

      return leftCustomer._revenue.CompareTo(

        rightCustomer._revenue);

    }

    #endregion

}

}

 

在最后一个版本的Customer结构中，我们内嵌了一个类RevenueComparer。这个新版的Customer，除了允许我们按照name对Customer集合进行排序之外（Customer的自然排序），还通过实现Icomparer接口的RevenueComparer类为我们提供了另一种排序方式，即根据 revenue对Customer进行排序。如果不能访问Customer类的源代码，我们仍然可以提供IComparer接口，来使用公有属性对 Customer进行排序。只有在访问不到类的源代码时，我们才应该这么做——比如对于.NET框架中的类，如果需要一种不同的排序方式，我们就要这么做。

本条款没有提及Equals()或者==操作符（参见条款9）。排序关系和相等比较是不同的操作。我们不需要实现相等比较来实现排序关系。实际上，引用类型通常是基于对象的内容来实现排序关系，并根据对象标识来实现相等比较。即使Equals()返回false，CompareTo()也可能返回0。这是绝对合法的。相等比较和排序关系并不必然相同。

综上所述，IComparable和IComparer为类型实现排序关系提供了两种标准的机制。IComparable接口应该用于为类型实现最自然的排序关系。


实现IComparable接口时，我们也应该重载四个比较操作符（<、>、<=、>=），并使它们与IComparable的排序关系保持一致。IComparable.CompareTo()方法使用System.Object作为参数，因此我们也应该提供一个重载版本的 CompareTo()方法，让其接受具体类型作为参数。而IComparer可以用于提供有别于IComparable的排序关系，或者为我们提供类型本身所没有实现的排序关系。