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 Point Klasse, die die Equals -Methode überschreibt, um Wertgleichheit bereitzustellen, und eine Point3D Klasse, 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 auf, Point.Equals weil auf eine Point Weise Object.Equals(Object) implementiert, die Wertgleichheit bereitstellt.

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 Point.Equals -Methode überprüft, ob das obj Argument nicht NULL ist und auf eine Instanz desselben Typs wie dieses Objekt verweist. Wenn bei beiden Überprüfungen ein Fehler auftritt, gibt die Methode false zurück.

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

In Point3D.Equals wird die geerbte Point.Equals Methode, die überschreibt, Object.Equals(Object) aufgerufen, bevor etwas anderes ausgeführt wird. Da Point3D eine versiegelte Klasse ( NotInheritable in Visual Basic) ist, ist eine Überprüfung im Format obj is Point in C# oder in Visual Basic TryCast(obj, Point) ausreichend, um sicherzustellen, dass obj ein Point3D -Objekt ist. Wenn es sich um ein Point3D -Objekt handelt, wird es in ein -Objekt um Point umwandlungen und an die Basisklassenimplementierungen 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 Rectangle Klasse definiert, die intern ein Rechteck als zwei Point -Objekte implementiert. Die Rectangle -Klasse überschreibt auch Object.Equals(Object) , um Für -Wertgleichheit bereitzustellen.

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 überlädt, muss er auch die Equals(Object) -Methode überschreiben, um die gleiche Funktionalität bereitzustellen. Dies wird in der Regel erreicht, indem die Equals(Object) -Methode im Hinblick auf 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 Equals(Object) -Methode nicht aufrufen, GetType um den genauen Laufzeittyp jedes Objekts zu bestimmen, sondern kann stattdessen den is -Operator in C# oder den TypeOf -Operator in Visual Basic verwenden, um den Typ des Parameters zu obj überprüfen.

Hinweise

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

  • Wenn die aktuelle Instanz ein Verweistyp ist, prüft die Equals(Object) Methode auf Verweisgleichheit, und ein Aufruf der Equals(Object) -Methode entspricht einem Aufruf 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 Person Klasse, die ein Verweistyp ist, und ruft den Person Klassenkonstruktor auf, um zwei neue Objekte zu instanziieren, Person und , die den gleichen Wert person1a person2 aufweisen. Außerdem wird einer person1a anderen Objektvariablen zugewiesen: person1b . Wie die Ausgabe des Beispiels zeigt, person1a sind und person1b gleich, da sie auf das gleiche Objekt verweisen. und sind jedoch person1a person2 nicht gleich, obwohl sie den gleichen 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, prüft die Methode auf Equals(Object) Wertgleichheit. Wertgleichheit bedeutet Folgendes:

    • Die beiden Objekte haben denselben Typ. Wie im folgenden Beispiel gezeigt, entspricht ein Byte -Objekt mit dem Wert 12 nicht einem Int32 Objekt mit dem Wert 12, da die beiden Objekte unterschiedliche Laufzeittypen aufweisen.

      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 getestet. Sie definiert eine Person -Struktur, bei der es sich um einen Werttyp handelt, und ruft den Person Klassenkonstruktor auf, um zwei neue Objekte zu instanziieren, Person und , die den gleichen Wert person1 person2 aufweisen. Wie die Ausgabe des Beispiels zeigt, verweisen die beiden Objektvariablen zwar auf verschiedene Objekte person1 und person2 sind gleich, da sie den gleichen Wert für das private personName Feld 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 Object -Klasse die Basisklasse für alle Typen im .NET Framework ist, stellt die Object.Equals(Object) -Methode den Standardgleichheitsvergleich für alle anderen Typen bereit. 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 Inheritors.

Hinweise zur Windows Runtime

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

Hinweis

Windows Laufzeitklassen, die in C# oder Visual Basic geschrieben werden, 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 eine zusätzliche stark typisierte Überladung für die Equals -Methode bereit, in der Regel durch Implementieren der IEquatable<T> -Schnittstelle. Wenn Sie die Equals -Methode aufrufen, um die Gleichheit zu testen, sollten Sie wissen, ob die aktuelle Instanz überschreibt Object.Equals und verstehen, wie ein bestimmter Aufruf einer Equals Methode aufgelöst wird. Andernfalls führen Sie möglicherweise einen Test auf Gleichheit durch, der sich von Ihren Absichten unterscheidet, und die Methode gibt möglicherweise einen unerwarteten Wert zurück.

Dies wird im folgenden Beispiel veranschaulicht. Es instanziiert drei StringBuilder Objekte mit identischen Zeichenfolgen und ruft dann vier Equals Methoden auf. Der erste Methodenaufruf gibt true zurück, und die verbleibenden 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 typisierte StringBuilder.Equals(StringBuilder) Methodenüberladung aufgerufen, die auf Wertgleichheit prüft. Da die den beiden Objekten zugewiesenen Zeichenfolgen StringBuilder gleich sind, gibt die Methode true zurück. überschreibt jedoch StringBuilder nicht Object.Equals(Object) . Aus diesem Grund wird die StringBuilder Standardmethode aufgerufen, wenn das -Objekt in ein -Objekt umgestellt wird, Object wenn eine StringBuilder -Instanz einer Variablen vom Typ zugewiesen wird Object und wenn der Methode zwei Object.Equals(Object, Object) -Objekte übergeben StringBuilder Object.Equals(Object) werden. 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 ReferenceEquals -Methode aufrufen. In Visual Basic können Sie auch das Schlüsselwort verwenden is (z. If Me Is otherObject Then ... B. ).

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. Die folgende Tabelle enthält die Standardimplementierungen der Equals -Methode für die Hauptkategorien von Typen im .NET Framework.

Typkategorie Durch definierte Gleichheit 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 den gleichen zugrunde liegenden Wert aufweisen.
Delegat MulticastDelegate.Equals Delegaten müssen den gleichen Typ mit identischen Aufruflisten aufweisen.
Schnittstelle Object.Equals(Object) Verweisgleichheit.

Für einen Werttyp sollten Sie immer überschreiben, Equals da Tests auf Gleichheit, die auf Reflektion basieren, eine schlechte Leistung bieten. Sie können auch die Standardimplementierungen von Equals für Verweistypen überschreiben, um die Wertgleichheit anstelle der Verweisgleichheit zu testen und die genaue Bedeutung der Wertgleichheit zu definieren. Solche Implementierungen von Equals geben true zurück, wenn die beiden Objekte den gleichen Wert haben, auch wenn sie nicht die gleiche Instanz sind. Der Implementierer des Typs entscheidet, was den Wert eines Objekts darstellt, 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 String -Objekts auf den Zeichen der Zeichenfolge. Die String.Equals(Object) -Methode überschreibt die Object.Equals(Object) -Methode, um true für zwei beliebige Zeichenfolgeninstanzen zurückzugeben, die die gleichen Zeichen in der gleichen Reihenfolge 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 Person die Implementierung der Basisklasse der Gleichheit akzeptiert wird, sind zwei Objekte nur Person gleich, wenn sie auf ein einzelnes Objekt verweisen. In diesem Fall sind jedoch zwei Person -Objekte gleich, wenn sie den gleichen Wert für die Person.Id -Eigenschaft 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 Equals von können Sie die IEquatable<T> -Schnittstelle implementieren, um einen stark typisierten Test auf Gleichheit bereitzustellen.

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

  • x.Equals(x) gibt true zurück, mit Ausnahme von Fällen, die Gleitkommatypen umfassen. Siehe ISO/IEC/IEEE 60559:2011, Information technology -- Microprocessor Systems -- Floating-Point arithmetic.

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

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

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

  • Aufeinanderfolgende Aufrufe, um x.Equals(y) denselben Wert zurückzugeben, solange die Objekte, auf die von und verwiesen x 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. B. obj null ist, sollte die Equals -Methode zurückgeben, false anstatt eine zu ArgumentNullException auslösen.

Befolgen Sie diese Richtlinien, wenn Sie Equals(Object) überschreiben:

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

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

  • Sie sollten erwägen, die IEquatable<T> -Schnittstelle zu implementieren, um stark typisierte 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 Equals(Object) -Methode überschreiben, um das gleiche Ergebnis wie der Gleichheitsoperator zurückzugeben. Dadurch wird sichergestellt, dass klassenbibliothekscode, der verwendet Equals (z. B. und ), sich in einer Weise verhält, die mit der Art und ArrayList Weise Hashtable konsistent ist, wie der Gleichheitsoperator vom Anwendungscode verwendet wird.

Richtlinien für Verweistypen

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

  • Erwägen Sie das Equals Überschreiben, wenn die Semantik des Typs auf der Tatsache basiert, dass 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 über Wertsemantik verfügen soll, z. B. einen komplexen Zahlentyp, müssen Sie den Gleichheitsoperator überschreiben.

  • Sie sollten für Equals einen änderbaren Verweistyp nicht überschreiben. Dies liegt daran, dass das Überschreiben Equals erfordert, dass Sie auch die GetHashCode -Methode überschreiben, wie im vorherigen Abschnitt erläutert. Dies bedeutet, dass sich der Hashcode einer Instanz eines änderbaren 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 mindestens ein Feld enthält, dessen Werte Verweistypen sind, sollten Sie Equals(Object) überschreiben. Die Equals(Object) von bereitgestellte Implementierung ValueType führt einen 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 enthalten.

  • Wenn Sie überschreiben Equals und Ihre Entwicklungssprache das Überladen von Operatoren unterstützt, müssen Sie den Gleichheitsoperator überladen.

  • Sie sollten die IEquatable<T> -Schnittstelle implementieren. Das Aufrufen der stark IEquatable<T>.Equals typisierten 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 -Methode veranschaulicht Equals(Object, Object) und mit der ReferenceEquals -Methode 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 -Objekte, objA und , gleich objB sind. Außerdem können Sie Objekte testen, deren Wert NULL ist, um gleichheitsgleich zu sein. Es vergleicht objA und auf Gleichheit wie objB folgt:

  • Sie bestimmt, ob die beiden Objekte denselben Objektverweis darstellen. Wenn sie dies tun, 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 ja, wird false zurückgegeben.

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

Siehe auch

Gilt für