Object.Equals Метод

Определение

Определяет, равны ли два экземпляра объекта.

Перегрузки

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

Equals(Object, Object)

Определяет, считаются ли равными указанные экземпляры объектов.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

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

Параметры

obj
Object

Объект, который требуется сравнить с текущим объектом.

Возвращаемое значение

Boolean

Значение true, если указанный объект равен текущему объекту; в противном случае — значение false.

Примеры

В следующем примере показан Point класс, который переопределяет Equals метод, чтобы обеспечить равенство значений, и Point3D класс, производный от Point . Поскольку Point переопределения для Object.Equals(Object) проверки равенства значений, Object.Equals(Object) метод не вызывается. Однако Point3D.Equals вызывается, Point.Equals поскольку Point реализуется Object.Equals(Object) способом, предоставляющим равенство значений.

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

Point.EqualsМетод проверяет, что аргумент не равен obj null и ссылается на экземпляр того же типа, что и этот объект. Если проверка завершается ошибкой, метод возвращает значение false .

Point.EqualsМетод вызывает метод, GetType чтобы определить, идентичны ли типы времени выполнения двух объектов. если метод использовал проверку формы obj is Point в C# или TryCast(obj, Point) в Visual Basic, проверка вернется true в случаях obj , когда является экземпляром производного класса Point , хотя obj и текущий экземпляр не относится к одному и тому же типу времени выполнения. Убедившись, что оба объекта имеют одинаковый тип, метод приводится obj к типу Point и возвращает результат сравнения полей экземпляров двух объектов.

В Point3D.Equals унаследованный Point.Equals метод, который переопределяет Object.Equals(Object) , вызывается до того, как все еще выполняется. поскольку Point3D является запечатанным классом ( NotInheritable в Visual Basic), проверка формы obj is Point в C# или TryCast(obj, Point) в Visual Basic достаточно, чтобы гарантировать, что obj является Point3D объектом. Если это Point3D объект, он приводится к Point объекту и передается в реализацию базового класса Equals . Только при Point.Equals возврате унаследованного метода true метод сравнивает z поля экземпляра, представленные в производном классе.

В следующем примере определяется Rectangle класс, который внутренне реализует прямоугольник как два Point объекта. RectangleКласс также переопределяет Object.Equals(Object) , чтобы обеспечить равенство значений.

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

некоторые языки, такие как C# и Visual Basic, поддерживают перегрузку операторов. Если тип перегружает оператор равенства, он также должен переопределять Equals(Object) метод, чтобы обеспечить ту же функциональность. Обычно это достигается путем написания Equals(Object) метода с точки зрения перегруженного оператора равенства, как показано в следующем примере.

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

Поскольку Complex является типом значения, он не может быть производным от. поэтому Equals(Object) методу переопределения метода не требуется вызывать GetType для определения точного типа времени выполнения каждого объекта, но вместо этого можно использовать is оператор в C# или TypeOf оператор в Visual Basic для проверки типа obj параметра.

Комментарии

Тип сравнения текущего экземпляра и obj параметра зависит от того, является ли текущий экземпляр ссылочным типом или типом значения.

  • Если текущий экземпляр является ссылочным типом, Equals(Object) метод проверяет равенство ссылок, а вызов Equals(Object) метода эквивалентен вызову ReferenceEquals метода. Равенство ссылок означает, что сравниваемые объектные переменные ссылаются на один и тот же объект. В следующем примере показан результат такого сравнения. Он определяет Person класс, который является ссылочным типом, и вызывает Person конструктор класса для создания экземпляров двух новых Person объектов person1a и person2 , имеющих одно и то же значение. Она также назначается person1a другой объектной переменной, person1b . Как показано в выходных данных примера, person1a и person1b равны, так как они ссылаются на один и тот же объект. Однако person1a и person2 не равны, хотя они имеют одинаковое значение.

    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
    
  • Если текущий экземпляр является типом значения, Equals(Object) метод проверяет равенство значений. Равенство значений означает следующее:

    • Два объекта имеют один и тот же тип. Как показано в следующем примере, Byte объект со значением 12 не равен Int32 объекту со значением 12, поскольку два объекта имеют разные типы времени выполнения.

      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
      
    • Значения открытого и закрытого полей двух объектов равны. В следующем примере проверяется равенство значений. Он определяет Person структуру, которая является типом значения, и вызывает Person конструктор класса для создания экземпляров двух новых Person объектов person1 и person2 , имеющих одно и то же значение. Как видно из выходных данных примера, две объектные переменные ссылаются на разные объекты person1 и person2 равны, так как они имеют одинаковое значение для закрытого personName поля.

      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
      

поскольку Object класс является базовым классом для всех типов в платформа .NET Framework, Object.Equals(Object) метод предоставляет сравнение на равенство по умолчанию для всех остальных типов. Однако типы часто переопределяют Equals метод, чтобы реализовать равенство значений. Дополнительные сведения см. в примечаниях для вызывающих объектов и примечаний для разделов наследников.

примечания для среда выполнения Windows

при вызове Equals(Object) перегрузки метода для класса в среда выполнения Windows он предоставляет поведение по умолчанию для классов, которые не переопределяются Equals(Object) . это является частью поддержки, предоставляемой платформа .NET Framework для среда выполнения Windows (см. платформа .NET Framework поддержка Windows приложений магазина и среда выполнения Windows). классы в среда выполнения Windows не наследуют Object и в настоящее время не реализуют Equals(Object) метод. однако они выглядят как ToString Equals(Object) методы, и GetHashCode при их использовании в коде C# или Visual Basic, а платформа .NET Framework предоставляет поведение по умолчанию для этих методов.

Примечание

Windows классы среды выполнения, написанные на языке C# или Visual Basic, могут переопределять Equals(Object) перегрузку метода.

Примечания для вызывающих объектов

Производные классы часто переопределяют Object.Equals(Object) метод для реализации равенства значений. Кроме того, типы часто предоставляют дополнительный строго типизированную перегрузку для Equals метода, обычно реализуя IEquatable<T> интерфейс. При вызове Equals метода для проверки на равенство следует знать, переопределяются ли текущий экземпляр Object.Equals и понимаете, как Equals разрешается определенный вызов метода. В противном случае вы можете выполнить проверку на равенство, отличное от предполагаемого, и метод может вернуть непредвиденное значение.

Ниже приведен пример. Он создает три StringBuilder объекта с одинаковыми строками, а затем выполняет четыре вызова Equals методов. Первый вызов метода возвращает true , а остальные три возвращают false .

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

В первом случае StringBuilder.Equals(StringBuilder) вызывается перегруженный метод строгой типизации, который проверяет равенство значений. Так как строки, назначенные двум StringBuilder объектам, равны, метод возвращает true . Однако не StringBuilder переопределяет Object.Equals(Object) . В связи с этим при StringBuilder приведении объекта к типу Object , когда StringBuilder экземпляр присваивается переменной типа Object , и когда Object.Equals(Object, Object) методу передается два StringBuilder объекта, вызывается метод по умолчанию Object.Equals(Object) . Поскольку StringBuilder является ссылочным типом, это эквивалентно передаче двух StringBuilder объектов в ReferenceEquals метод. Хотя все три StringBuilder объекта содержат одинаковые строки, они ссылаются на три различных объекта. В результате эти три вызова метода возвращают false .

Можно сравнить текущий объект с другим объектом для равенства ссылок, вызвав ReferenceEquals метод. в Visual Basic также можно использовать is ключевое слово (например, If Me Is otherObject Then ... ).

Примечания для наследников

При определении собственного типа этот тип наследует функциональность, определенную Equals методом базового типа. в следующей таблице приведена реализация метода по умолчанию Equals для основных категорий типов в платформа .NET Framework.

Категория типа Равенство, определенное Комментарии
Класс, производный непосредственно от Object Object.Equals(Object) Равенство ссылок; эквивалентно вызову Object.ReferenceEquals .
structure ValueType.Equals Равенство значений; прямое побайтовое сравнение или Сравнение полей по полям с помощью отражения.
Перечисление Enum.Equals Значения должны иметь одинаковый тип перечисления и одно и то же базовое значение.
Делегат MulticastDelegate.Equals Делегаты должны иметь одинаковый тип с одинаковыми списками вызовов.
Интерфейс Object.Equals(Object) Равенство ссылок.

Для типа значения следует всегда переопределять Equals , поскольку тесты на равенство, основанные на отражении, имеют низкую производительность. Можно также переопределить реализацию по умолчанию Equals для ссылочных типов, чтобы проверить равенство значений, а не равенство ссылок и определить точное значение равенства значений. Такие реализации Equals возвращают true , если два объекта имеют одинаковое значение, даже если они не являются одним и тем же экземпляром. Разработчик типа принимает решение, что составляет значение объекта, но обычно это некоторые или все данные, хранящиеся в переменных экземпляра объекта. Например, значение String объекта основано на символах строки. String.Equals(Object) метод переопределяет Object.Equals(Object) метод, возвращаемый true для любых двух экземпляров строк, содержащих одинаковые символы в том же порядке.

В следующем примере показано, как переопределить Object.Equals(Object) метод для проверки на равенство значений. Он переопределяет Equals метод для Person класса. Если он Person принял реализацию равенства базового класса, два Person объекта будут равны, только если они ссылались на один объект. Однако в этом случае два Person объекта равны, если они имеют одинаковое значение для Person.Id Свойства.

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

Помимо переопределения Equals , можно реализовать IEquatable<T> интерфейс, чтобы обеспечить строго типизированный тест на равенство.

Следующие инструкции должны быть истинными для всех реализаций Equals(Object) метода. В списке,, x y и z представляют ссылки на объекты, которые не равны null.

  • x.Equals(x) Возвращает true , за исключением случаев, в которых задействованы типы с плавающей запятой. См. статью ISO/IEC/IEEE 60559:2011, информационные технологии — системы микропроцессора — Floating-Point арифметические действия.

  • x.Equals(y) возвращает то же значение, что и y.Equals(x).

  • x.Equals(y) Возвращает, true Если x и y имеют значение NaN .

  • Если (x.Equals(y) && y.Equals(z)) возвращает true , возвращается x.Equals(z) значение true .

  • Последовательные вызовы x.Equals(y) возвращают одно и то же значение до тех пор, пока объекты, на которые ссылаются x и y , не изменяются.

  • x.Equals(null) возвращает false.

Реализации Equals не должны вызывать исключения. они всегда должны возвращать значение. Например, если obj имеет значение null , Equals метод должен возвращать, false а не создавать исключение ArgumentNullException .

При переопределении выполните следующие рекомендации Equals(Object) .

  • Типы, реализующие, IComparable должны переопределяться Equals(Object) .

  • Типы, переопределяющие, Equals(Object) также должны переопределяться GetHashCode ; в противном случае хэш-таблицы могут работать неправильно.

  • Рекомендуется реализовать IEquatable<T> интерфейс для поддержки строго типизированных тестов на равенство. Ваша реализация IEquatable<T>.Equals должна возвращать результаты, которые соответствуют Equals.

  • Если ваш язык программирования поддерживает перегрузку операторов и вы передаете оператор равенства для заданного типа, необходимо также переопределить метод, Equals(Object) чтобы он возвращал тот же результат, что и оператор равенства. Это позволяет гарантировать, что код библиотеки классов, используемый Equals (например ArrayList , и Hashtable ), ведет себя таким образом, который согласуется с тем, как код приложения использует оператор равенства.

Рекомендации по ссылочным типам

Следующие рекомендации применяются для переопределения Equals(Object) ссылочного типа.

  • Рассмотрите возможность переопределения, Equals Если семантика типа основана на том, что тип представляет некоторые значения.

  • Большинство ссылочных типов не должны перегружать оператор равенства, даже если они переопределяют Equals . Однако при реализации ссылочного типа, который должен иметь семантику значений, например тип комплексного числа, необходимо переопределить оператор равенства.

  • Не следует переопределять Equals для изменяемого ссылочного типа. Это обусловлено тем Equals , что переопределение требует также переопределения GetHashCode метода, как описано в предыдущем разделе. Это означает, что хэш-код экземпляра изменяемого ссылочного типа может измениться в течение своего времени существования, что может привести к потере объекта в хэш-таблице.

Рекомендации по типам значений

Ниже приведены рекомендации по переопределению Equals(Object) для типа значения.

  • При определении типа значения, включающего одно или несколько полей, значения которых являются ссылочными типами, следует переопределить Equals(Object) . Equals(Object)Реализация, предоставляемая функцией, выполняет побайтовое ValueType Сравнение для типов значений, поля которых являются типами значений, но использует отражение для выполнения сравнения по полям типов значений, поля которых включают ссылочные типы.

  • Если вы переопределяете Equals и язык разработки поддерживает перегрузку операторов, необходимо перегрузить оператор равенства.

  • Необходимо реализовать IEquatable<T> интерфейс. Вызов строго типизированного IEquatable<T>.Equals метода позволяет избежать упаковки-преобразования obj аргумента.

См. также раздел

Применяется к

Equals(Object, Object)

Определяет, считаются ли равными указанные экземпляры объектов.

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

Параметры

objA
Object

Первый из сравниваемых объектов.

objB
Object

Второй из сравниваемых объектов.

Возвращаемое значение

Boolean

true, если указанные объекты равны; в противном случае — false. Если оба параметра objA и objB имеют значение NULL, метод возвращает значение true.

Примеры

В следующем примере показан Equals(Object, Object) метод и его сравнение с ReferenceEquals методом.

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

Комментарии

Статический Equals(Object, Object) метод указывает, равны ли два объекта, objA и objB . Он также позволяет тестировать объекты, значение которых равно null , для проверки на равенство. Он сравнивает objA и objB для равенства следующим образом:

  • Он определяет, представляют ли два объекта одну и ту же ссылку на объект. В противном случае метод возвращает значение true . Этот тест эквивалентен вызову ReferenceEquals метода. Кроме того, если оба objA objB значения и имеют значение NULL, метод возвращает true .

  • Он определяет, objA является ли objB либо значением NULL. Если это так, возвращается значение false .

  • Если два объекта не представляют одну и ту же ссылку на объект и ни один из них не имеет значения NULL, то вызывает objA . Equals ( objB ) и возвращает результат. Это означает, что если objA переопределяет Object.Equals(Object) метод, вызывается это переопределение.

См. также раздел

Применяется к