Object.Equals Methode

Definition

Stellt fest, ob zwei Objektinstanzen gleich sind.

Überlädt

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.

Equals(Object, Object)

Stellt fest, ob die angegebenen Objektinstanzen als gleich betrachtet werden.

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.

public:
 virtual bool Equals(System::Object ^ obj);
public virtual bool Equals (object obj);
public virtual bool Equals (object? obj);
abstract member Equals : obj -> bool
override this.Equals : obj -> bool
Public Overridable Function Equals (obj As Object) As Boolean

Parameter

obj
Object

Das Objekt, das mit dem aktuellen Objekt verglichen werden soll.

Gibt zurück

Boolean

true, wenn das angegebene Objekt und das aktuelle Objekt gleich sind, andernfalls false.

Beispiele

Das folgende Beispiel zeigt eine Klasse, die die -Methode überschreibt, um Wertgleichheit zu bieten, und eine Point Equals Klasse, Point3D die von abgeleitet Point ist. Da Point Object.Equals(Object) überschreibt, um auf Wertgleichheit zu testen, wird die Object.Equals(Object) -Methode nicht aufgerufen. Ruft jedoch Point3D.Equals Point.Equals auf, da Point auf eine Object.Equals(Object) Weise implementiert, die Wertgleichheit bietet.

using System;

class Point
{
   protected int x, y;

   public Point() : this(0, 0)
   { }

   public Point(int x, int y)
   {
      this.x = x;
      this.y = y;
   }

   public override bool Equals(Object obj)
   {
      //Check for null and compare run-time types.
      if ((obj == null) || ! this.GetType().Equals(obj.GetType()))
      {
         return false;
      }
      else {
         Point p = (Point) obj;
         return (x == p.x) && (y == p.y);
      }
   }

   public override int GetHashCode()
   {
      return (x << 2) ^ y;
   }

    public override string ToString()
    {
        return String.Format("Point({0}, {1})", x, y);
    }
}

sealed class Point3D: Point
{
   int z;

   public Point3D(int x, int y, int z) : base(x, y)
   {
      this.z = z;
   }

   public override bool Equals(Object obj)
   {
      Point3D pt3 = obj as Point3D;
      if (pt3 == null)
         return false;
      else
         return base.Equals((Point)obj) && z == pt3.z;
   }

   public override int GetHashCode()
   {
      return (base.GetHashCode() << 2) ^ z;
   }

   public override String ToString()
   {
        return String.Format("Point({0}, {1}, {2})", x, y, z);
    }
}

class Example
{
  public static void Main()
  {
     Point point2D = new Point(5, 5);
     Point3D point3Da = new Point3D(5, 5, 2);
     Point3D point3Db = new Point3D(5, 5, 2);
     Point3D point3Dc = new Point3D(5, 5, -1);

     Console.WriteLine("{0} = {1}: {2}",
                       point2D, point3Da, point2D.Equals(point3Da));
     Console.WriteLine("{0} = {1}: {2}",
                       point2D, point3Db, point2D.Equals(point3Db));
     Console.WriteLine("{0} = {1}: {2}",
                       point3Da, point3Db, point3Da.Equals(point3Db));
     Console.WriteLine("{0} = {1}: {2}",
                       point3Da, point3Dc, point3Da.Equals(point3Dc));
  }
}
// The example displays the following output:
//       Point(5, 5) = Point(5, 5, 2): False
//       Point(5, 5) = Point(5, 5, 2): False
//       Point(5, 5, 2) = Point(5, 5, 2): True
//       Point(5, 5, 2) = Point(5, 5, -1): False
Class Point
    Protected x, y As Integer
    
    Public Sub New() 
        Me.x = 0
        Me.y = 0
    End Sub
    
    Public Sub New(x As Integer, y As Integer) 
        Me.x = x
        Me.y = y
    End Sub 

    Public Overrides Function Equals(obj As Object) As Boolean 
        ' Check for null and compare run-time types.
        If obj Is Nothing OrElse Not Me.GetType().Equals(obj.GetType()) Then
           Return False
        Else
           Dim p As Point = DirectCast(obj, Point)
           Return x = p.x AndAlso y = p.y
        End If
    End Function 

    Public Overrides Function GetHashCode() As Integer 
        Return (x << 2) XOr y
    End Function

    Public Overrides Function ToString() As String
        Return String.Format("Point({0}, {1})", x, y)
    End Function
End Class

Class Point3D : Inherits Point
    Private z As Integer
    
    Public Sub New(ByVal x As Integer, ByVal y As Integer, ByVal z As Integer) 
        MyBase.New(x, y) 
        Me.z = Z
    End Sub

    Public Overrides Function Equals(ByVal obj As Object) As Boolean 
        Dim pt3 As Point3D = TryCast(obj, Point3D)
        If pt3 Is Nothing Then
           Return False
        Else
           Return MyBase.Equals(CType(pt3, Point)) AndAlso z = pt3.Z  
        End If
    End Function
    
    Public Overrides Function GetHashCode() As Integer 
        Return (MyBase.GetHashCode() << 2) XOr z
    End Function 
    
    Public Overrides Function ToString() As String
        Return String.Format("Point({0}, {1}, {2})", x, y, z)
    End Function
End Class 

Module Example
    Public Sub Main() 
        Dim point2D As New Point(5, 5)
        Dim point3Da As New Point3D(5, 5, 2)
        Dim point3Db As New Point3D(5, 5, 2)
        Dim point3Dc As New Point3D(5, 5, -1)
        
        Console.WriteLine("{0} = {1}: {2}", 
                          point2D, point3Da, point2D.Equals(point3Da))
        Console.WriteLine("{0} = {1}: {2}", 
                          point2D, point3Db, point2D.Equals(point3Db))        
        Console.WriteLine("{0} = {1}: {2}", 
                          point3Da, point3Db, point3Da.Equals(point3Db))
        Console.WriteLine("{0} = {1}: {2}", 
                          point3Da, point3Dc, point3Da.Equals(point3Dc))
    End Sub  
End Module 
' The example displays the following output
'       Point(5, 5) = Point(5, 5, 2): False
'       Point(5, 5) = Point(5, 5, 2): False
'       Point(5, 5, 2) = Point(5, 5, 2): True
'       Point(5, 5, 2) = Point(5, 5, -1): False

Die -Methode überprüft, ob das Argument nicht NULL ist und auf eine Instanz desselben Typs wie Point.Equals obj dieses Objekt verweist. Wenn eine der Überprüfungen fehlschlägt, gibt die Methode false zurück.

Die -Methode ruft die -Methode auf, um zu bestimmen, ob die Point.Equals GetType Laufzeittypen der beiden -Objekte identisch sind. Wenn die Methode eine Überprüfung des Formulars in C# oder in Visual Basic verwendet hat, würde die Überprüfung in Fällen zurückgeben, in denen eine Instanz einer abgeleiteten Klasse von ist, obwohl und die aktuelle Instanz nicht vom gleichen Laufzeittyp obj is Point TryCast(obj, Point) true obj Point obj sind. Nachdem sichergestellt wurde, dass beide Objekte denselben Typ haben, wird die Methode in den Typ um- und gibt das Ergebnis des Vergleichs der Instanzfelder obj Point der beiden Objekte zurück.

In Point3D.Equals wird die Point.Equals geerbte Methode, die Object.Equals(Object) überschreibt, aufgerufen, bevor etwas anderes erledigt wird. Da eine versiegelte Klasse ( in Visual Basic) ist, ist eine Prüfung im Formular in C# oder in Visual Basic ausreichend, um sicherzustellen, dass ein Point3D NotInheritable obj is Point TryCast(obj, Point) obj -Objekt Point3D ist. Wenn es sich um ein Point3D -Objekt handelt, wird es in ein -Objekt Point cast und an die Basisklassenimplementierung von Equals übergeben. Nur wenn die geerbte Point.Equals Methode true zurückgibt, vergleicht die Methode die z Instanzfelder, die in der abgeleiteten Klasse eingeführt wurden.

Im folgenden Beispiel wird eine Klasse definiert, die intern ein Rectangle Rechteck als zwei -Objekte Point implementiert. Die Rectangle -Klasse überschreibt auch Object.Equals(Object) , um Wertgleichheit zu ermöglichen.

using System;

class Rectangle
{
   private Point a, b;

   public Rectangle(int upLeftX, int upLeftY, int downRightX, int downRightY)
   {
      this.a = new Point(upLeftX, upLeftY);
      this.b = new Point(downRightX, downRightY);
   }

   public override bool Equals(Object obj)
   {
      // Perform an equality check on two rectangles (Point object pairs).
      if (obj == null || GetType() != obj.GetType())
          return false;
      Rectangle r = (Rectangle)obj;
      return a.Equals(r.a) && b.Equals(r.b);
   }

   public override int GetHashCode()
   {
      return Tuple.Create(a, b).GetHashCode();
   }

    public override String ToString()
    {
       return String.Format("Rectangle({0}, {1}, {2}, {3})",
                            a.x, a.y, b.x, b.y);
    }
}

class Point
{
  internal int x;
  internal int y;

  public Point(int X, int Y)
  {
     this.x = X;
     this.y = Y;
  }

  public override bool Equals (Object obj)
  {
     // Performs an equality check on two points (integer pairs).
     if (obj == null || GetType() != obj.GetType()) return false;
     Point p = (Point)obj;
     return (x == p.x) && (y == p.y);
  }

  public override int GetHashCode()
  {
     return Tuple.Create(x, y).GetHashCode();
  }
}

class Example
{
   public static void Main()
   {
      Rectangle r1 = new Rectangle(0, 0, 100, 200);
      Rectangle r2 = new Rectangle(0, 0, 100, 200);
      Rectangle r3 = new Rectangle(0, 0, 150, 200);

      Console.WriteLine("{0} = {1}: {2}", r1, r2, r1.Equals(r2));
      Console.WriteLine("{0} = {1}: {2}", r1, r3, r1.Equals(r3));
      Console.WriteLine("{0} = {1}: {2}", r2, r3, r2.Equals(r3));
   }
}
// The example displays the following output:
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 100, 200): True
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False
//    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False
Class Rectangle 
    Private a, b As Point
    
    Public Sub New(ByVal upLeftX As Integer, ByVal upLeftY As Integer, _
                   ByVal downRightX As Integer, ByVal downRightY As Integer) 
        Me.a = New Point(upLeftX, upLeftY)
        Me.b = New Point(downRightX, downRightY)
    End Sub 
    
    Public Overrides Function Equals(ByVal obj As [Object]) As Boolean 
        ' Performs an equality check on two rectangles (Point object pairs).
        If obj Is Nothing OrElse Not [GetType]().Equals(obj.GetType()) Then
            Return False
        End If
        Dim r As Rectangle = CType(obj, Rectangle)
        Return a.Equals(r.a) AndAlso b.Equals(r.b)
    End Function

    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(a, b).GetHashCode()
    End Function 

    Public Overrides Function ToString() As String
       Return String.Format("Rectangle({0}, {1}, {2}, {3})",
                            a.x, a.y, b.x, b.y) 
    End Function
End Class 

Class Point
    Friend x As Integer
    Friend y As Integer
    
    Public Sub New(ByVal X As Integer, ByVal Y As Integer) 
        Me.x = X
        Me.y = Y
    End Sub 

    Public Overrides Function Equals(ByVal obj As [Object]) As Boolean 
        ' Performs an equality check on two points (integer pairs).
        If obj Is Nothing OrElse Not [GetType]().Equals(obj.GetType()) Then
            Return False
        Else
           Dim p As Point = CType(obj, Point)
           Return x = p.x AndAlso y = p.y
        End If
    End Function 
    
    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(x, y).GetHashCode()
    End Function 
End Class  

Class Example
    Public Shared Sub Main() 
        Dim r1 As New Rectangle(0, 0, 100, 200)
        Dim r2 As New Rectangle(0, 0, 100, 200)
        Dim r3 As New Rectangle(0, 0, 150, 200)
        
        Console.WriteLine("{0} = {1}: {2}", r1, r2, r1.Equals(r2))
        Console.WriteLine("{0} = {1}: {2}", r1, r3, r1.Equals(r3))
        Console.WriteLine("{0} = {1}: {2}", r2, r3, r2.Equals(r3))
    End Sub 
End Class 
' The example displays the following output:
'    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 100, 200): True
'    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False
'    Rectangle(0, 0, 100, 200) = Rectangle(0, 0, 150, 200): False

Einige Sprachen wie C# und Visual Basic unterstützen das Überladen von Operatoren. Wenn ein Typ den Gleichheitsoperator überlastet, muss er auch die -Methode Equals(Object) überschreiben, um die gleiche Funktionalität zu bieten. Dies wird in der Regel erreicht, indem die -Methode in Bezug auf Equals(Object) den überladenen Gleichheitsoperator geschrieben wird, wie im folgenden Beispiel.

using System;

public struct Complex
{
   public double re, im;

   public override bool Equals(Object obj)
   {
      return obj is Complex && this == (Complex)obj;
   }

   public override int GetHashCode()
   {
      return Tuple.Create(re, im).GetHashCode();
   }

   public static bool operator ==(Complex x, Complex y)
   {
      return x.re == y.re && x.im == y.im;
   }

   public static bool operator !=(Complex x, Complex y)
   {
      return !(x == y);
   }

    public override String ToString()
    {
       return String.Format("({0}, {1})", re, im);
    }
}

class MyClass
{
  public static void Main()
  {
    Complex cmplx1, cmplx2;

    cmplx1.re = 4.0;
    cmplx1.im = 1.0;

    cmplx2.re = 2.0;
    cmplx2.im = 1.0;

    Console.WriteLine("{0} <> {1}: {2}", cmplx1, cmplx2, cmplx1 != cmplx2);
    Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1.Equals(cmplx2));

    cmplx2.re = 4.0;

    Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1 == cmplx2);
    Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1.Equals(cmplx2));
  }
}
// The example displays the following output:
//       (4, 1) <> (2, 1): True
//       (4, 1) = (2, 1): False
//       (4, 1) = (4, 1): True
//       (4, 1) = (4, 1): True
Public Structure Complex
    Public re, im As Double
    
    Public Overrides Function Equals(ByVal obj As [Object]) As Boolean 
        Return TypeOf obj Is Complex AndAlso Me = CType(obj, Complex)
    End Function 
    
    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(re, im).GetHashCode()
    End Function 
    
    Public Shared Operator = (x As Complex, y As Complex) As Boolean
       Return x.re = y.re AndAlso x.im = y.im
    End Operator 
    
    Public Shared Operator <> (x As Complex, y As Complex) As Boolean
       Return Not (x = y)
    End Operator 
    
    Public Overrides Function ToString() As String
       Return String.Format("({0}, {1})", re, im)
    End Function 
End Structure

Class Example
   Public Shared Sub Main() 
      Dim cmplx1, cmplx2 As Complex
        
      cmplx1.re = 4.0
      cmplx1.im = 1.0
        
      cmplx2.re = 2.0
      cmplx2.im = 1.0

      Console.WriteLine("{0} <> {1}: {2}", cmplx1, cmplx2, cmplx1 <> cmplx2)        
      Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1.Equals(cmplx2))        
      
      cmplx2.re = 4.0
        
      Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1 = cmplx2)        
      Console.WriteLine("{0} = {1}: {2}", cmplx1, cmplx2, cmplx1.Equals(cmplx2))        
   End Sub
End Class 
' The example displays the following output:
'       (4, 1) <> (2, 1): True
'       (4, 1) = (2, 1): False
'       (4, 1) = (4, 1): True
'       (4, 1) = (4, 1): True

Da Complex ein Werttyp ist, kann er nicht von abgeleitet werden. Daher muss die Außerkraftsetzung der -Methode nicht aufrufen, um den genauen Laufzeittyp jedes Objekts zu bestimmen, sondern kann stattdessen den -Operator in C# oder den -Operator in Visual Basic verwenden, um den Typ des Parameters Equals(Object) GetType zu is TypeOf obj überprüfen.

Hinweise

Der Vergleichstyp zwischen der aktuellen Instanz und dem Parameter hängt davon ab, ob die aktuelle Instanz ein Verweistyp obj oder ein Werttyp ist.

  • Wenn die aktuelle Instanz ein Verweistyp ist, testet die Methode auf Verweisgleichheit, und ein Aufruf der -Methode entspricht einem Aufruf Equals(Object) Equals(Object) der ReferenceEquals -Methode. Verweisgleichheit bedeutet, dass die verglichenen Objektvariablen auf dasselbe Objekt verweisen. Das folgende Beispiel veranschaulicht das Ergebnis eines solchen Vergleichs. Sie definiert eine Klasse, die ein Verweistyp ist, und ruft den Klassenkonstruktor auf, um zwei neue Objekte zu instanziieren, und Person Person , die Person person1a person2 denselben Wert haben. Sie weist auch einer person1a anderen Objektvariablen zu, person1b . Wie die Ausgabe des Beispiels zeigt, person1a sind und person1b gleich, da sie auf dasselbe Objekt verweisen. Und sind person1a person2 jedoch nicht gleich, obwohl sie denselben Wert haben.

    using System;
    
    // Define a reference type that does not override Equals.
    public class Person
    {
       private string personName;
    
       public Person(string name)
       {
          this.personName = name;
       }
    
       public override string ToString()
       {
          return this.personName;
       }
    }
    
    public class Example
    {
       public static void Main()
       {
          Person person1a = new Person("John");
          Person person1b = person1a;
          Person person2 = new Person(person1a.ToString());
    
          Console.WriteLine("Calling Equals:");
          Console.WriteLine("person1a and person1b: {0}", person1a.Equals(person1b));
          Console.WriteLine("person1a and person2: {0}", person1a.Equals(person2));
    
          Console.WriteLine("\nCasting to an Object and calling Equals:");
          Console.WriteLine("person1a and person1b: {0}", ((object) person1a).Equals((object) person1b));
          Console.WriteLine("person1a and person2: {0}", ((object) person1a).Equals((object) person2));
       }
    }
    // The example displays the following output:
    //       person1a and person1b: True
    //       person1a and person2: False
    //
    //       Casting to an Object and calling Equals:
    //       person1a and person1b: True
    //       person1a and person2: False
    
    ' Define a reference type that does not override Equals.
    Public Class Person
       Private personName As String
       
       Public Sub New(name As String)
          Me.personName = name
       End Sub
       
       Public Overrides Function ToString() As String
          Return Me.personName
       End Function 
    End Class
    
    Module Example
       Public Sub Main()
          Dim person1a As New Person("John")
          Dim person1b As Person = person1a
          Dim person2 As New Person(person1a.ToString())
          
          Console.WriteLine("Calling Equals:") 
          Console.WriteLine("person1a and person1b: {0}", person1a.Equals(person1b))               
          Console.WriteLine("person1a and person2: {0}", person1a.Equals(person2))  
          Console.WriteLine()
          
          Console.WriteLine("Casting to an Object and calling Equals:")
          Console.WriteLine("person1a and person1b: {0}", CObj(person1a).Equals(CObj(person1b)))
          Console.WriteLine("person1a and person2: {0}", CObj(person1a).Equals(CObj(person2))) 
       End Sub
    End Module
    ' The example displays the following output:
    '       Calling Equals:
    '       person1a and person1b: True
    '       person1a and person2: False
    '       
    '       Casting to an Object and calling Equals:
    '       person1a and person1b: True
    '       person1a and person2: False
    
  • Wenn die aktuelle Instanz ein Werttyp ist, testet Equals(Object) die Methode auf Wertgleichheit. Wertgleichheit bedeutet Folgendes:

    • Die beiden -Objekte sind vom gleichen Typ. Wie das folgende Beispiel zeigt, entspricht ein -Objekt mit dem Wert 12 nicht einem Objekt mit dem Wert 12, da die beiden -Objekte unterschiedliche Byte Int32 Laufzeittypen haben.

      byte value1 = 12;
      int value2 = 12;
      
      object object1 = value1;
      object object2 = value2;
      
      Console.WriteLine("{0} ({1}) = {2} ({3}): {4}",
                        object1, object1.GetType().Name,
                        object2, object2.GetType().Name,
                        object1.Equals(object2));
      
      // The example displays the following output:
      //        12 (Byte) = 12 (Int32): False
      
      Module Example
         Public Sub Main()
            Dim value1 As Byte = 12
            Dim value2 As Integer = 12
            
            Dim object1 As Object = value1
            Dim object2 As Object = value2
            
            Console.WriteLine("{0} ({1}) = {2} ({3}): {4}",
                              object1, object1.GetType().Name,
                              object2, object2.GetType().Name,
                              object1.Equals(object2))
         End Sub
      End Module
      ' The example displays the following output:
      '       12 (Byte) = 12 (Int32): False
      
    • Die Werte der öffentlichen und privaten Felder der beiden Objekte sind gleich. Im folgenden Beispiel wird auf Wertgleichheit überprüft. Sie definiert eine -Struktur, bei der es sich um einen Werttyp handelt, und ruft den Klassenkonstruktor auf, um zwei neue Objekte zu instanziieren, und Person Person , die Person person1 person2 denselben Wert haben. Wie die Ausgabe des Beispiels zeigt, verweisen die beiden Objektvariablen zwar auf verschiedene Objekte und sind gleich, da sie denselben Wert für das person1 person2 private Feld personName haben.

      using System;
      
      // Define a value type that does not override Equals.
      public struct Person
      {
         private string personName;
      
         public Person(string name)
         {
            this.personName = name;
         }
      
         public override string ToString()
         {
            return this.personName;
         }
      }
      
      public struct Example
      {
         public static void Main()
         {
            Person person1 = new Person("John");
            Person person2 = new Person("John");
      
            Console.WriteLine("Calling Equals:");
            Console.WriteLine(person1.Equals(person2));
      
            Console.WriteLine("\nCasting to an Object and calling Equals:");
            Console.WriteLine(((object) person1).Equals((object) person2));
         }
      }
      // The example displays the following output:
      //       Calling Equals:
      //       True
      //
      //       Casting to an Object and calling Equals:
      //       True
      
      ' Define a value type that does not override Equals.
      Public Structure Person
         Private personName As String
         
         Public Sub New(name As String)
            Me.personName = name
         End Sub
         
         Public Overrides Function ToString() As String
            Return Me.personName
         End Function 
      End Structure
      
      Module Example
         Public Sub Main()
            Dim p1 As New Person("John")
            Dim p2 As New Person("John")
            
            Console.WriteLine("Calling Equals:") 
            Console.WriteLine(p1.Equals(p2))
            Console.WriteLine()
            
            Console.WriteLine("Casting to an Object and calling Equals:")
            Console.WriteLine(CObj(p1).Equals(p2))
         End Sub
      End Module
      ' The example displays the following output:
      '       Calling Equals:
      '       True
      '       
      '       Casting to an Object and calling Equals:
      '       True
      

Da die -Klasse die Basisklasse für alle Typen in der .NET Framework ist, stellt die -Methode den Object Object.Equals(Object) Standardgleichheitsvergleich für alle anderen Typen zur Seite. Typen überschreiben jedoch häufig die Equals -Methode, um Wertgleichheit zu implementieren. Weitere Informationen finden Sie in den Abschnitten Hinweise für Aufrufer und Hinweise für Erber.

Hinweise zur Windows Runtime

Wenn Sie die Methodenüberladung für eine Klasse in der Windows Runtime aufrufen, wird das Standardverhalten für Klassen bereitgestellt, die Equals(Object) nicht Equals(Object) überschreiben. Dies ist Teil der Unterstützung, die der .NET Framework für die Windows Runtime bietet (siehe .NET Framework Support for Windows Store Apps and Windows Runtime). Klassen in der Windows Runtime erben nicht und implementieren derzeit Object keine Equals(Object) Methode. Sie scheinen jedoch über die Methoden , und zu verfügen, wenn Sie sie ToString Equals(Object) in Ihrem C#- oder Visual Basic-Code verwenden, und die .NET Framework stellt das Standardverhalten für diese GetHashCode Methoden zur Anwendung.

Hinweis

Windows Runtime-Klassen, die in C# oder Visual Basic können die Equals(Object) Methodenüberladung überschreiben.

Hinweise für Aufrufer

Abgeleitete Klassen überschreiben häufig die Object.Equals(Object) -Methode, um Wertgleichheit zu implementieren. Darüber hinaus stellen Typen häufig auch eine zusätzliche stark typierte Überladung für die -Methode bereit, in der Regel durch Equals Implementierung der IEquatable<T> -Schnittstelle. Wenn Sie die -Methode aufrufen, um auf Gleichheit zu testen, sollten Sie wissen, ob die aktuelle Instanz überschreibt, und verstehen, wie ein bestimmter Aufruf einer Methode Equals Object.Equals aufgelöst Equals wird. Andernfalls können Sie einen Gleichheitstest durchführen, der sich von dem abschließt, was Sie beabsichtigt haben, und die -Methode gibt möglicherweise einen unerwarteten Wert zurück.

Dies wird im folgenden Beispiel veranschaulicht. Sie instanziiert drei StringBuilder Objekte mit identischen Zeichenfolgen und ruft dann vier Methoden Equals auf. Der erste Methodenaufruf gibt true zurück, und die restlichen drei geben false zurück.

using System;
using System.Text;

public class Example
{
   public static void Main()
   {
      StringBuilder sb1 = new StringBuilder("building a string...");
      StringBuilder sb2 = new StringBuilder("building a string...");

      Console.WriteLine("sb1.Equals(sb2): {0}", sb1.Equals(sb2));
      Console.WriteLine("((Object) sb1).Equals(sb2): {0}",
                        ((Object) sb1).Equals(sb2));
      Console.WriteLine("Object.Equals(sb1, sb2): {0}",
                        Object.Equals(sb1, sb2));

      Object sb3 = new StringBuilder("building a string...");
      Console.WriteLine("\nsb3.Equals(sb2): {0}", sb3.Equals(sb2));
   }
}
// The example displays the following output:
//       sb1.Equals(sb2): True
//       ((Object) sb1).Equals(sb2): False
//       Object.Equals(sb1, sb2): False
//
//       sb3.Equals(sb2): False
Imports System.Text

Module Example
   Public Sub Main()
      Dim sb1 As New StringBuilder("building a string...")
      Dim sb2 As New StringBuilder("building a string...")
      
      Console.WriteLine("sb1.Equals(sb2): {0}", sb1.Equals(sb2))
      Console.WriteLine("CObj(sb1).Equals(sb2): {0}", 
                        CObj(sb1).Equals(sb2))
      Console.WriteLine("Object.Equals(sb1, sb2): {0}",
                        Object.Equals(sb1, sb2))                  
      
      Console.WriteLine()
      Dim sb3 As Object = New StringBuilder("building a string...")
      Console.WriteLine("sb3.Equals(sb2): {0}", sb3.Equals(sb2))                              
   End Sub
End Module
' The example displays the following output:
'       sb1.Equals(sb2): True
'       CObj(sb1).Equals(sb2): False
'       Object.Equals(sb1, sb2): False
'
'       sb3.Equals(sb2): False

Im ersten Fall wird die stark typierte Methodenüberladung aufgerufen, die auf StringBuilder.Equals(StringBuilder) Wertgleichheit testet. Da die den beiden -Objekten zugewiesenen StringBuilder Zeichenfolgen gleich sind, gibt die Methode true zurück. überschreibt StringBuilder jedoch nicht Object.Equals(Object) . Aus diesem Grund wird die Standardmethode aufgerufen, wenn das -Objekt in ein -Objekt umgestellt wird, wenn eine -Instanz einer Variablen vom Typ zugewiesen wird und die -Methode zwei -Objekte übergeben StringBuilder Object StringBuilder Object Object.Equals(Object, Object) StringBuilder Object.Equals(Object) wird. Da StringBuilder ein Verweistyp ist, entspricht dies der Übergabe der beiden StringBuilder Objekte an die ReferenceEquals -Methode. Obwohl alle drei StringBuilder Objekte identische Zeichenfolgen enthalten, verweisen sie auf drei unterschiedliche Objekte. Daher geben diese drei Methodenaufrufe false zurück.

Sie können das aktuelle -Objekt auf Verweisgleichheit mit einem anderen Objekt vergleichen, indem Sie die -Methode ReferenceEquals aufrufen. In Visual Basic können Sie auch das Schlüsselwort is verwenden (z. B. If Me Is otherObject Then ... ).

Hinweise für Inheritors

Wenn Sie einen eigenen Typ definieren, erbt dieser Typ die Funktionalität, die von der Equals -Methode des Basistyps definiert wird. In der folgenden Tabelle ist die Standardimplementierung der Equals -Methode für die Hauptkategorien von Typen in der .NET Framework.

Typkategorie Gleichheit definiert durch Kommentare
Direkt von abgeleitete Klasse Object Object.Equals(Object) Verweisgleichheit; entspricht dem Aufrufen von Object.ReferenceEquals .
Struktur ValueType.Equals Wertgleichheit; entweder direkter Byte-by-Byte-Vergleich oder Feld-für-Feld-Vergleich mit Reflektion.
Enumeration Enum.Equals Werte müssen den gleichen Enumerationstyp und denselben zugrunde liegenden Wert haben.
Delegat MulticastDelegate.Equals Delegaten müssen denselben Typ mit identischen Aufruflisten haben.
Schnittstelle Object.Equals(Object) Verweisgleichheit.

Für einen Werttyp sollten Sie immer überschreiben, da Tests auf Gleichheit, die auf Reflektion Equals basieren, eine schlechte Leistung bieten. Sie können auch die Standardimplementierung von für Verweistypen überschreiben, um anstelle von Verweisgleichheit auf Wertgleichheit zu prüfen und die genaue Bedeutung von Equals Wertgleichheit zu definieren. Solche Implementierungen von geben zurück, wenn die beiden Objekte denselben Wert haben, auch Equals wenn sie nicht dieselbe Instanz true sind. Der Implementer des Typs entscheidet, was den Wert eines Objekts bildet, aber es handelt sich in der Regel um einige oder alle Daten, die in den Instanzvariablen des Objekts gespeichert sind. Beispielsweise basiert der Wert eines -Objekts auf den Zeichen der Zeichenfolge. Die -Methode überschreibt die -Methode, um für alle zwei Zeichenfolgeninstanzen zurück zu geben, die die gleichen Zeichen in der gleichen Reihenfolge String String.Equals(Object) Object.Equals(Object) true enthalten.

Das folgende Beispiel zeigt, wie die -Methode überschrieben Object.Equals(Object) wird, um auf Wertgleichheit zu testen. Sie überschreibt die Equals -Methode für die Person -Klasse. Wenn die Implementierung der Basisklasse der Gleichheit akzeptiert wird, sind zwei Objekte nur Person gleich, Person wenn sie auf ein einzelnes Objekt verweisen. In diesem Fall sind jedoch zwei Person -Objekte gleich, wenn sie denselben Wert für die -Eigenschaft Person.Id haben.

public class Person
{
   private string idNumber;
   private string personName;

   public Person(string name, string id)
   {
      this.personName = name;
      this.idNumber = id;
   }

   public override bool Equals(Object obj)
   {
      Person personObj = obj as Person;
      if (personObj == null)
         return false;
      else
         return idNumber.Equals(personObj.idNumber);
   }

   public override int GetHashCode()
   {
      return this.idNumber.GetHashCode();
   }
}

public class Example
{
   public static void Main()
   {
      Person p1 = new Person("John", "63412895");
      Person p2 = new Person("Jack", "63412895");
      Console.WriteLine(p1.Equals(p2));
      Console.WriteLine(Object.Equals(p1, p2));
   }
}
// The example displays the following output:
//       True
//       True
Public Class Person
   Private idNumber As String
   Private personName As String
   
   Public Sub New(name As String, id As String)
      Me.personName = name
      Me.idNumber = id
   End Sub
   
   Public Overrides Function Equals(obj As Object) As Boolean
      Dim personObj As Person = TryCast(obj, Person) 
      If personObj Is Nothing Then
         Return False
      Else
         Return idNumber.Equals(personObj.idNumber)
      End If   
   End Function
   
   Public Overrides Function GetHashCode() As Integer
      Return Me.idNumber.GetHashCode() 
   End Function
End Class

Module Example
   Public Sub Main()
      Dim p1 As New Person("John", "63412895")
      Dim p2 As New Person("Jack", "63412895")
      Console.WriteLine(p1.Equals(p2))
      Console.WriteLine(Object.Equals(p1, p2))
   End Sub
End Module
' The example displays the following output:
'       True
'       True

Zusätzlich zum Überschreiben von können Sie die -Schnittstelle implementieren, um einen stark Equals IEquatable<T> typierten Test auf Gleichheit zu ermöglichen.

Die folgenden Anweisungen müssen für alle Implementierungen der -Methode true Equals(Object) sein. In der Liste stellen x , y und z Objektverweise dar, die nicht NULL sind.

  • true gibt x.Equals(x) zurück.

  • x.Equals(y) gibt denselben Wert zurück wie y.Equals(x).

  • x.Equals(y) gibt true zurück, wenn x sowohl als auch y NaN sind.

  • Wenn (x.Equals(y) && y.Equals(z)) true zurückgibt, gibt x.Equals(z) true zurück.

  • Aufeinanderfolgende Aufrufe, um den gleichen Wert zurück zu geben, solange die Objekte, auf die x.Equals(y) x von und verwiesen y wird, nicht geändert werden.

  • x.Equals(null) gibt false zurück.

Implementierungen von Equals dürfen keine Ausnahmen auslösen. Sie sollten immer einen Wert zurückgeben. Wenn z. obj B. null ist, sollte Equals die Methode false zurückgeben, anstatt eine zu ArgumentNullException auslösen.

Befolgen Sie diese Richtlinien beim Überschreiben Equals(Object) von :

  • Typen, die IComparable implementieren, müssen überschreiben. Equals(Object)

  • Typen, die Equals(Object) überschreiben, müssen ebenfalls GetHashCode überschreiben. Andernfalls funktionieren Hashtabellen möglicherweise nicht ordnungsgemäß.

  • Sie sollten erwägen, die IEquatable<T> -Schnittstelle zu implementieren, um stark typierte Tests auf Gleichheit zu unterstützen. Ihre IEquatable<T>.Equals-Implementierung sollte Ergebnisse zurückgeben, die Equals entsprechen.

  • Wenn Ihre Programmiersprache das Überladen von Operatoren unterstützt und Sie den Gleichheitsoperator für einen bestimmten Typ überladen, müssen Sie auch die -Methode überschreiben, um das gleiche Ergebnis wie der Equals(Object) Gleichheitsoperator zurück zu geben. Dadurch wird sichergestellt, dass sich Klassenbibliothekscode, der verwendet (z. B. und ) verwendet, auf eine Weise verhält, die mit der Verwendung des Gleichheitsoperers durch Equals ArrayList Hashtable Anwendungscode konsistent ist.

Richtlinien für Verweistypen

Die folgenden Richtlinien gelten für das Überschreiben Equals(Object) für einen Verweistyp:

  • Erwägen Sie das Überschreiben, wenn die Semantik des Typs auf der Tatsache basiert, dass Equals der Typ einige Werte darstellt.

  • Die meisten Verweistypen dürfen den Gleichheitsoperator nicht überladen, auch wenn sie Equals überschreiben. Wenn Sie jedoch einen Verweistyp implementieren, der wertsemantisch sein soll, z. B. einen komplexen Zahlentyp, müssen Sie den Gleichheitsoperator überschreiben.

  • Sie sollten nicht für einen Equals veränderlichen Verweistyp überschreiben. Dies liegt daran, dass Equals das Überschreiben erfordert, dass Sie auch die -Methode GetHashCode überschreiben, wie im vorherigen Abschnitt erläutert. Dies bedeutet, dass sich der Hashcode einer Instanz eines veränderlichen Verweistyps während seiner Lebensdauer ändern kann, was dazu führen kann, dass das Objekt in einer Hashtabelle verloren geht.

Richtlinien für Werttypen

Die folgenden Richtlinien gelten für das Überschreiben Equals(Object) für einen Werttyp:

  • Wenn Sie einen Werttyp definieren, der ein oder mehrere Felder enthält, deren Werte Verweistypen sind, sollten Sie Equals(Object) überschreiben. Die von bereitgestellte Implementierung führt einen Equals(Object) Byte-by-Byte-Vergleich für Werttypen durch, deren Felder alle Werttypen sind. Sie verwendet jedoch Reflektion, um einen Feld-für-Feld-Vergleich von Werttypen durchzuführen, deren Felder Verweistypen ValueType enthalten.

  • Wenn Sie Equals überschreiben und Ihre Entwicklungssprache operatorüberladene Operatoren unterstützt, müssen Sie den Gleichheitsoperator überladen.

  • Sie sollten die -Schnittstelle IEquatable<T> implementieren. Das Aufrufen der stark typierten IEquatable<T>.Equals Methode vermeidet das Boxing des obj Arguments.

Siehe auch

Gilt für

Equals(Object, Object)

Stellt fest, ob die angegebenen Objektinstanzen als gleich betrachtet werden.

public:
 static bool Equals(System::Object ^ objA, System::Object ^ objB);
public static bool Equals (object objA, object objB);
public static bool Equals (object? objA, object? objB);
static member Equals : obj * obj -> bool
Public Shared Function Equals (objA As Object, objB As Object) As Boolean

Parameter

objA
Object

Das erste zu vergleichende Objekt.

objB
Object

Das zweite zu vergleichende Objekt.

Gibt zurück

Boolean

true, wenn die Objekte als gleich betrachtet werden, andernfalls false. Wenn sowohl objA, als auch objBNULL sind, gibt diese Methode true zurück.

Beispiele

Im folgenden Beispiel wird die Equals(Object, Object) -Methode veranschaulicht und mit der -Methode ReferenceEquals verglichen.

using System;

public class Example
{
   public static void Main()
   {
      Dog m1 = new Dog("Alaskan Malamute");
      Dog m2 = new Dog("Alaskan Malamute");
      Dog g1 = new Dog("Great Pyrenees");
      Dog g2 = g1;
      Dog d1 = new Dog("Dalmation");
      Dog n1 = null;
      Dog n2 = null;

      Console.WriteLine("null = null: {0}", Object.Equals(n1, n2));
      Console.WriteLine("null Reference Equals null: {0}\n", Object.ReferenceEquals(n1, n2));

      Console.WriteLine("{0} = {1}: {2}", g1, g2, Object.Equals(g1, g2));
      Console.WriteLine("{0} Reference Equals {1}: {2}\n", g1, g2, Object.ReferenceEquals(g1, g2));

      Console.WriteLine("{0} = {1}: {2}", m1, m2, Object.Equals(m1, m2));
      Console.WriteLine("{0} Reference Equals {1}: {2}\n", m1, m2, Object.ReferenceEquals(m1, m2));

      Console.WriteLine("{0} = {1}: {2}", m1, d1, Object.Equals(m1, d1));
      Console.WriteLine("{0} Reference Equals {1}: {2}", m1, d1, Object.ReferenceEquals(m1, d1));
   }
}

public class Dog
{
   // Public field.
   public string Breed;

   // Class constructor.
   public Dog(string dogBreed)
   {
      this.Breed = dogBreed;
   }

   public override bool Equals(Object obj)
   {
      if (obj == null || !(obj is Dog))
         return false;
      else
         return this.Breed == ((Dog) obj).Breed;
   }

   public override int GetHashCode()
   {
      return this.Breed.GetHashCode();
   }

   public override string ToString()
   {
      return this.Breed;
   }
}
// The example displays the following output:
//       null = null: True
//       null Reference Equals null: True
//
//       Great Pyrenees = Great Pyrenees: True
//       Great Pyrenees Reference Equals Great Pyrenees: True
//
//       Alaskan Malamute = Alaskan Malamute: True
//       Alaskan Malamute Reference Equals Alaskan Malamute: False
//
//       Alaskan Malamute = Dalmation: False
//       Alaskan Malamute Reference Equals Dalmation: False
Module Example
   Public Sub Main()
      Dim m1 As New Dog("Alaskan Malamute")
      Dim m2 As New Dog("Alaskan Malamute")
      Dim g1 As New Dog("Great Pyrenees")
      Dim g2 As Dog = g1
      Dim d1 As New Dog("Dalmation")
      Dim n1 As Dog = Nothing
      Dim n2 As Dog = Nothing
      
      Console.WriteLine("null = null: {0}", Object.Equals(n1, n2))
      Console.WriteLine("null Reference Equals null: {0}", Object.ReferenceEquals(n1, n2))
      Console.WriteLine()
      
      Console.WriteLine("{0} = {1}: {2}", g1, g2, Object.Equals(g1, g2))
      Console.WriteLine("{0} Reference Equals {1}: {2}", g1, g2, Object.ReferenceEquals(g1, g2))
      Console.WriteLine()
      
      Console.WriteLine("{0} = {1}: {2}", m1, m2, Object.Equals(m1, m2))
      Console.WriteLine("{0} Reference Equals {1}: {2}", m1, m2, Object.ReferenceEquals(m1, m2))
      Console.WriteLine()
      
      Console.WriteLine("{0} = {1}: {2}", m1, d1, Object.Equals(m1, d1))  
      Console.WriteLine("{0} Reference Equals {1}: {2}", m1, d1, Object.ReferenceEquals(m1, d1))  
   End Sub
End Module

Public Class Dog
   ' Public field.
   Public Breed As String
   
   ' Class constructor.
   Public Sub New(dogBreed As String)
      Me.Breed = dogBreed
   End Sub

   Public Overrides Function Equals(obj As Object) As Boolean
      If obj Is Nothing OrElse Not typeof obj Is Dog Then
         Return False
      Else
         Return Me.Breed = CType(obj, Dog).Breed
      End If   
   End Function
   
   Public Overrides Function GetHashCode() As Integer
      Return Me.Breed.GetHashCode()
   End Function
   
   Public Overrides Function ToString() As String
      Return Me.Breed
   End Function
End Class
' The example displays the following output:
'       null = null: True
'       null Reference Equals null: True
'       
'       Great Pyrenees = Great Pyrenees: True
'       Great Pyrenees Reference Equals Great Pyrenees: True
'       
'       Alaskan Malamute = Alaskan Malamute: True
'       Alaskan Malamute Reference Equals Alaskan Malamute: False
'       
'       Alaskan Malamute = Dalmation: False
'       Alaskan Malamute Reference Equals Dalmation: False

Hinweise

Die statische Equals(Object, Object) -Methode gibt an, ob zwei objA -Objekte, und objB , gleich sind. Außerdem können Sie Objekte, deren Wert NULL ist, auf Gleichheit testen. Und werden objA wie folgt auf Gleichheit objB verglichen:

  • Sie bestimmt, ob die beiden -Objekte denselben Objektverweis darstellen. Wenn dies der Wert ist, gibt die Methode true zurück. Dieser Test entspricht dem Aufrufen der ReferenceEquals -Methode. Darüber hinaus gibt die Methode zurück, wenn sowohl als auch objA objB NULL true sind.

  • Sie bestimmt, ob objA oder objB NULL ist. Wenn dies der Wert ist, wird false zurückgegeben.

  • Wenn die beiden -Objekte nicht denselben Objektverweis darstellen und keines von null ist, ruft es objA auf. Equals ( objB ) und gibt das Ergebnis zurück. Dies bedeutet, dass diese Überschreibung aufgerufen wird, wenn die -Methode objA Object.Equals(Object) überschreibt.

Siehe auch

Gilt für