重写结构中的 Equals 方法

Question

我一直在寻找结构的压倒一切的指导方针，但我能找到的只是类。

起初我以为我不必检查传递的对象是否为空，因为结构是值类型并且不能为空。但现在我开始考虑它，因为 equals 签名似乎

public bool Equals(object obj)

没有什么可以阻止我的结构的用户尝试将它与任意引用类型进行比较。

我的第二点涉及在比较结构中的私有字段之前我（认为我）必须进行的转换。我应该如何将对象转换为我的结构类型？ C# 的 as 关键字似乎只适合引用类型。

Answer 1

struct MyStruct 
{
   public override bool Equals(object obj) 
   {
       if (!(obj is MyStruct))
          return false;

       MyStruct mys = (MyStruct) obj;
       // compare elements here

   }

}

Answer 2

感谢模式匹配的引入在 C# 7.0 中，有一种更简单的方法来完成可接受的答案：

struct MyStruct 
{
    public override bool Equals(object obj) 
    {
        if (!(obj is MyStruct mys)) // type pattern here
            return false;

        return this.field1 == mys.field1 && this.field2 == mys.field2 // mys is already known here without explicit casting
    }
}

您还可以将其作为表达式主体函数使其变得更短：

struct MyStruct 
{
    public override bool Equals(object obj) => 
        obj is MyStruct mys
            && mys.field1 == this.field1
            && mys.field2 == this.field2;
}

Answer 3

我想，如果使用 .NET 4.5，则可以使用 文档：

当您定义自己的类型时，该类型将继承其基类型的 Equals 方法定义的功能。

ValueType.Equals：值相等；直接逐字节比较或使用反射进行逐字段比较。

Answer 4

如果有人想知道将结构装箱到 Nullable 对象中对性能的影响（以避免 is 和强制类型转换的双重类型检查），那么有一个不可忽略的问题开销。

tl;dr：使用is &在这个场景中投射。

struct Foo : IEquatable<Foo>
{
    public int a, b;

    public Foo(int a, int b)
    {
        this.a = a;
        this.b = b;
    }

    public override bool Equals(object obj)
    {
#if BOXING
        var obj_ = obj as Foo?;
        return obj_ != null && Equals(obj_.Value);
#elif DOUBLECHECK
        return obj is Foo && Equals((Foo)obj);
#elif MAGIC
        ?
#endif
    }

    public bool Equals(Foo other)
    {
        return a == other.a && b == other.b;
    }
}

class Program
{
    static void Main(string[] args)
    {
        RunBenchmark(new Foo(42, 43), new Foo(42, 43));
        RunBenchmark(new Foo(42, 43), new Foo(43, 44));
    }

    static void RunBenchmark(object x, object y)
    {
        var sw = Stopwatch.StartNew();
        for (var i = 0; i < 100000000; i++) x.Equals(y);
        sw.Stop();
        Console.WriteLine(sw.ElapsedMilliseconds);
    }
}

结果：

BOXING
EQ  8012    7973    7981    8000
NEQ 7929    7715    7906    7888

DOUBLECHECK
EQ  3654    3650    3638    3605
NEQ 3310    3301    3319    3297

警告：尽管我确实验证了基准代码本身并未以奇怪的方式进行优化，但该测试可能在很多方面存在缺陷。

查看 IL，双重检查方法编译得更干净一些。

拳击 IL：

.method public hidebysig virtual 
    instance bool Equals (
        object obj
    ) cil managed 
{
    // Method begins at RVA 0x2060
    // Code size 37 (0x25)
    .maxstack 2
    .locals init (
        [0] valuetype [mscorlib]System.Nullable`1<valuetype StructIEqualsImpl.Foo> obj_
    )

    IL_0000: ldarg.1
    IL_0001: isinst valuetype [mscorlib]System.Nullable`1<valuetype StructIEqualsImpl.Foo>
    IL_0006: unbox.any valuetype [mscorlib]System.Nullable`1<valuetype StructIEqualsImpl.Foo>
    IL_000b: stloc.0
    IL_000c: ldloca.s obj_
    IL_000e: call instance bool valuetype [mscorlib]System.Nullable`1<valuetype StructIEqualsImpl.Foo>::get_HasValue()
    IL_0013: brfalse.s IL_0023

    IL_0015: ldarg.0
    IL_0016: ldloca.s obj_
    IL_0018: call instance !0 valuetype [mscorlib]System.Nullable`1<valuetype StructIEqualsImpl.Foo>::get_Value()
    IL_001d: call instance bool StructIEqualsImpl.Foo::Equals(valuetype StructIEqualsImpl.Foo)
    IL_0022: ret

    IL_0023: ldc.i4.0
    IL_0024: ret
} // end of method Foo::Equals

仔细检查 IL：

.method public hidebysig virtual 
    instance bool Equals (
        object obj
    ) cil managed 
{
    // Method begins at RVA 0x2060
    // Code size 23 (0x17)
    .maxstack 8

    IL_0000: ldarg.1
    IL_0001: isinst StructIEqualsImpl.Foo
    IL_0006: brfalse.s IL_0015

    IL_0008: ldarg.0
    IL_0009: ldarg.1
    IL_000a: unbox.any StructIEqualsImpl.Foo
    IL_000f: call instance bool StructIEqualsImpl.Foo::Equals(valuetype StructIEqualsImpl.Foo)
    IL_0014: ret

    IL_0015: ldc.i4.0
    IL_0016: ret
} // end of method Foo::Equals

支持 Roman Reiner，因为他发现了一个确实让我看起来不太好的错误。

Answer 5

使用 is 运算符：

public bool Equals(object obj)
{
  if (obj is MyStruct)
  {
    var o = (MyStruct)obj;
    ...
  }
}

Answer 6

添加到现有答案。

如果附加 ?，您仍然可以拥有可为空的值。在结构名称之后（这适用于每个值对象）

int?

也可以通过调用 (MyStructName)variableName 来完成转换