2010-03-30 99 views
49

我查找了结构的重写指导原则,但是我可以找到的所有指南都是针对类的。构造中的重写等式方法

起初我以为我不需要检查传递的对象是否为null,因为结构是值类型并且不能为null。但现在,我想起来了,因为等于签名是

public bool Equals(object obj) 

似乎没有受到什么阻碍我的结构的用户试图将它与任意的引用类型进行比较。

我的第二点涉及到我在我的结构中比较我的私有字段之前,我想(我想)必须做的。我该如何将对象转换为我的结构类型? C#的as关键字似乎只适用于引用类型。

+6

只是说明你鼓励避免.Net中的可变结构。它的设置应该坚持引用类型(类)大部分时间,并且很少使用结构。 – 2010-03-30 03:34:40

+4

我第二。使用不可变结构*不带*子类型。然后Equals和==对于给定的接收者(左侧值)应该是相同的,其中实现中唯一的区别是Equals需要'is'检查,然后为简单起见,将调度为==。因此,两个合同都得到履行,意外情况得到缓解。 – 2010-03-30 03:40:56

+0

是的,这个结构是不可变的。我只比较一个int。 – 2010-03-30 03:51:00

回答

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

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

    } 

} 
+1

为了清楚起见,你可以在这里添加'override'关键字吗?在Java中总是很好的做法,在C#中应该是一样的。 – 2013-08-06 13:12:13

+1

另请参阅Microsoft的指导原则 - http://msdn.microsoft.com/en-us/library/ms173147(v=vs.80).aspx – yoyo 2014-08-26 17:23:20

+7

@JohanS在C#中,不仅仅是一种好的做法,如果您省略了重写该方法实际上做了完全不同的事情。 – Pharap 2014-12-23 09:08:19

5

使用is操作:

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

添加到现有的答案。

如果你添加一个?你仍然可以有空值。该结构名称后(这个工程的每一个值对象)

int? 

铸造是通过调用(MyStructName)variableName

+2

你可以,但是可能有一个非常高的性能损失,会比通过使用“as”而不是“is”而获得的利益多得多。 – 2010-03-30 16:46:52

+0

@DanStory我不会那么快。如果你想看看[this](http://stackoverflow.com/a/28281410),我很想知道是否有任何我错过了。 tl; dr:is + cast的确编译得更好一些,但是对于as + boxing来说,似乎并没有像“非常高的性能损失”那样的东西。事实上,我不能让is + cast的运行速度更快(有时候as + boxing方法会带头)。 – tne 2015-02-02 15:49:53

+0

@DanStory对于之前的评论,我绝对是错的。惩罚* *高(无论如何,与微基准的选择相比)。编辑了相同的链接答案。 – tne 2015-06-17 16:47:37

12

也做了,我想,如果一个人的使用.NET 4.5,可以使用缺省实现注意在documentation中:

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

ValueType.Equals:Value equality;可以直接逐字节比较或使用反射进行逐场比较。

+1

它实际上是在4.5之前,我不知道它是什么时候添加的,但它在4中是绝对可用的。尽管对MSDN的一个评论似乎表明它对于浮点类型可能不准确。 – Pharap 2014-12-23 09:22:02

+1

有关性能考虑,请参阅http://stackoverflow.com/q/1009394。 – tne 2015-02-02 14:53:01

+0

@Pharap:当定义“Equals”时,Microsoft未能清楚地说明,事情应该如何“平等”才能返回“真实”;有一些上下文有用于测试*等价性*的浮点值(正数和负数在数值上相等并不意味着它们是等价的,因为如果x和y是等价的,那应该意味着1/x = = 1/y,但这不是正值和负值)。对某些结构中的浮点值进行等价测试,但我知道没有通用的方法来请求这样的测试。 – supercat 2015-02-03 00:40:01

6

如果任何人的疑惑拳击在可空对象的结构的性能损失(以避免is double类型检查和演员),还有一个不可忽略的开销。

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 

道具罗马莱纳为察觉真的没有让我看好了一个错误。

+0

您的测试* *有瑕疵!你的基准调用'Foo.Equals(Foo)'方法。 'Foo.Equals(object)'永远不会执行。 – 2015-06-17 06:39:15

+0

@RomanReiner:噢,耻辱。我显然是想抛弃物体而忘了;带来很大的后果(实际结果是非常不同的) - 好吧,如果任何人都重视微基准。非常感谢! – tne 2015-06-17 10:26:53

1

由于some news in 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 
      ? true // the initial "true" doesn't affect the overall boolean operation yet allows nice line aligning below 
       && this.field1 == mys.field1 
       && this.field2 == mys.field2 
      : false; // obj is not MyStruct 
}