检查一对对象是否相等有两种方法:引用相等和结构/值相等。引用相等是所有引用类型(类)的默认值,结构相等是所有值类型的默认值(但默认实现不是最优的)。使用以下指南为引用类型和值类型实现结构相等。
平等
相等性检查应遵循以下规则:
- 一个对象等于它自己(身份)
- 比较
x
返回y
与比较相同的y
事实x
。(对称)
- 如果
x
等于y
并且y
等于z
,则x
必须等于z
。(传递性)
- 一个对象永远不等于
null
。
null
等于null
。
- 不应抛出任何异常。
让您的类或结构实现IEquatable<T>
自定义相等检查的接口,然后实现IEquatable<T>.Equals(T)
andObject.Equals()
方法。
引用类型(类)的相等性
对于引用类型,实现如下IEquatable<T>.Equals(T)
方法:
public bool Equals(MyType other)
{
if (Object.ReferenceEquals(other, null) || // When 'other' is null
other.GetType() != this.GetType()) // or of a different type
return false; // they are not equal.
return this.field1 == other.field1
&& this.field2 == other.field2;
}
然后像这样覆盖Object.Equals()
:
public override bool Equals(object obj)
{
return Equals(obj as MyType);
}
值类型(结构)的平等
由于值类型不能是null
,因此实现如下IEquatable<T>.Equals(T)
方法:
public bool Equals(MyType other)
{
return this.field == other.field
&& this.field2 == other.field2;
}
然后像这样覆盖Object.Equals()
:
public override bool Equals(object obj)
{
if (!(obj is MyType))
return false;
return Equals((MyType)obj);
}
等式运算符
对于引用类型和值类型,您可能希望覆盖默认的相等和不等运算符。根据Jon Skeet的这篇文章,等式和不等式运算符可以这样实现:
public static bool operator ==(MyType left, MyType right)
{
return Object.Equals(left, right);
}
public static bool operator !=(MyType left, MyType right)
{
return !(left == right);
}
请注意, when和left
/或right
is不调用覆盖(因此不调用方法)。null
Object.Equals(object, object)
Object.Equals(object)
IEquatable<T>.Equals(T)
哈希码
有时对象的哈希码很重要,例如当对象可能被放入字典或哈希表时。一般来说,当你重写Equals()
方法时,重写GetHashCode()
方法。哈希码应遵循以下规则:
- 哈希码永远不应该改变,即使在修改了对象中的某些字段之后也是如此。
- 对于被认为相等的对象,哈希码必须相等。
- 对于被认为不相等的对象,哈希码可以是任何东西(包括相等)。
- 哈希码应该是随机分布的。
- 哈希码函数绝不能抛出异常,并且必须始终返回。
- 哈希码的计算速度应该非常快。
因此,要实现Object.GetHashCode()
使用结构相等的类或结构,请从对象中选择一些不可变的字段并标记它们readonly
。仅使用这些字段来计算哈希码。覆盖该Object.GetHashCode()
方法并像这样实现它:
public override int GetHashCode()
{
unchecked
{
int hash = 17;
// Don't forget to check for null values.
hash = hash * 29 + field1.GetHashCode();
hash = hash * 29 + field2.GetHashCode();
// ...
return hash;
}
}
或者,如果您只有一个不可变字段,您可以考虑只使用:
public override int GetHashCode()
{
// Don't forget to check for null values.
return field1.GetHashCode();
}
如果您没有不可变字段,请返回一个常量哈希码。例如,类型本身的哈希码。
public override int GetHashCode()
{
return GetType().GetHashCode();
}
集合的结构平等
不应使用默认Equals()
方法比较集合。相反,集合的默认相等性应该是引用相等性。要实现结构相等,请实现IStructuralEquatable
接口。例如:
bool IStructuralEquatable.Equals(object obj, IEqualityComparer comparer)
{
var other = obj as MyType;
if (other == null)
return false;
return ((IStructuralEquatable)this.innerArray)
.Equals(other.innerArray, comparer);
}
int IStructuralEquatable.GetHashCode(IEqualityComparer comparer)
{
return ((IStructuralEquatable)this.innerArray).GetHashCode(comparer);
}