Object.Equals Метод

Определение

Определяет, равны ли два экземпляра объекта.Determines whether two object instances are equal.

Перегрузки

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

Equals(Object, Object)

Определяет, считаются ли равными указанные экземпляры объектов.Determines whether the specified object instances are considered equal.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

public:
 virtual bool Equals(System::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

Объект, сравниваемый с текущим объектом.The object to compare with the current object.

Возвраты

Значение true, если указанный объект равен текущему объекту; в противном случае — значение false.true if the specified object is equal to the current object; otherwise, false.

Примеры

В следующем примере показан класс Point, который переопределяет метод Equals, чтобы обеспечить равенство значений, и класс Point3D, производный от Point.The following example shows a Point class that overrides the Equals method to provide value equality, and a Point3D class that is derived from Point. Поскольку Point переопределяет Object.Equals(Object) для проверки равенства значений, метод Object.Equals(Object) не вызывается.Because Point overrides Object.Equals(Object) to test for value equality, the Object.Equals(Object) method is not called. Однако Point3D.Equals вызывает Point.Equals, так как Point реализует Object.Equals(Object) способом, обеспечивающим равенство значений.However, Point3D.Equals calls Point.Equals because Point implements Object.Equals(Object) in a manner that provides value equality.

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 и ссылается на экземпляр того же типа, что и этот объект.The Point.Equals method checks to make sure that the obj argument is not null and that it references an instance of the same type as this object. Если проверка завершается ошибкой, метод возвращает false.If either check fails, the method returns false.

Метод Point.Equals вызывает метод GetType, чтобы определить, идентичны ли типы времени выполнения двух объектов.The Point.Equals method calls the GetType method to determine whether the run-time types of the two objects are identical. Если метод использовал проверку формы obj is Point в C# или TryCast(obj, Point) в Visual Basic, проверка будет возвращать true в случаях, когда obj является экземпляром производного класса Point, даже если obj и текущий экземпляр имеют разные типы времени выполнения.If the method used a check of the form obj is Point in C# or TryCast(obj, Point) in Visual Basic, the check would return true in cases where obj is an instance of a derived class of Point, even though obj and the current instance are not of the same run-time type. Убедившись, что оба объекта имеют одинаковый тип, метод приводит obj к типу Point и возвращает результат сравнения полей экземпляров двух объектов.Having verified that both objects are of the same type, the method casts obj to type Point and returns the result of comparing the instance fields of the two objects.

В Point3D.Equalsунаследованный метод Point.Equals, который переопределяет Object.Equals(Object), вызывается до того, как все еще выполняется.In Point3D.Equals, the inherited Point.Equals method, which overrides Object.Equals(Object), is invoked before anything else is done. Поскольку Point3D является запечатанным классом (NotInheritable в Visual Basic), проверка формы obj is Point в C# или TryCast(obj, Point) в Visual Basic является достаточной, чтобы гарантировать, что obj является объектом Point3D.Because Point3D is a sealed class (NotInheritable in Visual Basic), a check in the form obj is Point in C# or TryCast(obj, Point) in Visual Basic is adequate to ensure that obj is a Point3D object. Если это объект Point3D, он приводится к Point объекту и передается в реализацию базового класса Equals.If it is a Point3D object, it is cast to a Point object and passed to the base class implementation of Equals. Только когда наследуемый метод Point.Equals возвращает true метод сравнивает поля z экземпляра, представленные в производном классе.Only when the inherited Point.Equals method returns true does the method compare the z instance fields introduced in the derived class.

В следующем примере определяется класс Rectangle, который внутренне реализует прямоугольник как два объекта Point.The following example defines a Rectangle class that internally implements a rectangle as two Point objects. Класс Rectangle также переопределяет Object.Equals(Object), чтобы обеспечить равенство значений.The Rectangle class also overrides Object.Equals(Object) to provide for value equality.

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, поддерживают перегрузку операторов.Some languages such as C# and Visual Basic support operator overloading. Если тип перегружает оператор равенства, он также должен переопределять метод Equals(Object), чтобы обеспечить ту же функциональность.When a type overloads the equality operator, it must also override the Equals(Object) method to provide the same functionality. Обычно это достигается путем написания метода Equals(Object) в терминах перегруженного оператора равенства, как показано в следующем примере.This is typically accomplished by writing the Equals(Object) method in terms of the overloaded equality operator, as in the following example.

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 является типом значения, он не может быть производным от.Because Complex is a value type, it cannot be derived from. Поэтому методу override для Equals(Object) не требуется вызывать GetType, чтобы определить точный тип времени выполнения каждого объекта, но вместо этого можно использовать оператор is в C# или оператор TypeOf в Visual Basic, чтобы проверить тип параметра obj.Therefore, the override to Equals(Object) method need not call GetType to determine the precise run-time type of each object, but can instead use the is operator in C# or the TypeOf operator in Visual Basic to check the type of the obj parameter.

Комментарии

Тип сравнения текущего экземпляра и параметра obj зависит от того, является ли текущий экземпляр ссылочным типом или типом значения.The type of comparison between the current instance and the obj parameter depends on whether the current instance is a reference type or a value type.

  • Если текущий экземпляр является ссылочным типом, то метод Equals(Object) проверяет равенство ссылок, а вызов метода Equals(Object) эквивалентен вызову метода ReferenceEquals.If the current instance is a reference type, the Equals(Object) method tests for reference equality, and a call to the Equals(Object) method is equivalent to a call to the ReferenceEquals method. Равенство ссылок означает, что сравниваемые объектные переменные ссылаются на один и тот же объект.Reference equality means that the object variables that are compared refer to the same object. В следующем примере показан результат такого сравнения.The following example illustrates the result of such a comparison. Он определяет класс Person, который является ссылочным типом, и вызывает конструктор класса Person для создания экземпляров двух новых Person объектов, person1a и person2, имеющих одно и то же значение.It defines a Person class, which is a reference type, and calls the Person class constructor to instantiate two new Person objects, person1a and person2, which have the same value. Он также назначает person1a другой объектной переменной person1b.It also assigns person1a to another object variable, person1b. Как видно из выходных данных в примере, person1a и person1b равны, так как они ссылаются на один и тот же объект.As the output from the example shows, person1a and person1b are equal because they reference the same object. Однако person1a и person2 не равны, хотя они имеют одинаковое значение.However, person1a and person2 are not equal, although they have the same value.

    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) проверяет равенство значений.If the current instance is a value type, the Equals(Object) method tests for value equality. Равенство значений означает следующее:Value equality means the following:

    • Два объекта имеют один и тот же тип.The two objects are of the same type. Как показано в следующем примере, объект Byte со значением 12 не равен Int32 объекту со значением 12, поскольку два объекта имеют разные типы времени выполнения.As the following example shows, a Byte object that has a value of 12 does not equal an Int32 object that has a value of 12, because the two objects have different run-time types.

      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
      
    • Значения открытого и закрытого полей двух объектов равны.The values of the public and private fields of the two objects are equal. В следующем примере проверяется равенство значений.The following example tests for value equality. Он определяет структуру Person, которая является типом значения, и вызывает конструктор Person класса для создания экземпляров двух новых Person объектов, person1 и person2, имеющих одно и то же значение.It defines a Person structure, which is a value type, and calls the Person class constructor to instantiate two new Person objects, person1 and person2, which have the same value. Как видно из выходных данных примера, две объектные переменные ссылаются на разные объекты, person1 и person2 равны, так как они имеют одинаковое значение для поля Private personName.As the output from the example shows, although the two object variables refer to different objects, person1 and person2 are equal because they have the same value for the private personName field.

      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) предоставляет сравнение на равенство по умолчанию для всех остальных типов.Because the Object class is the base class for all types in the .NET Framework, the Object.Equals(Object) method provides the default equality comparison for all other types. Однако типы часто переопределяют метод Equals для реализации равенства значений.However, types often override the Equals method to implement value equality. Дополнительные сведения см. в примечаниях для вызывающих объектов и примечаний для разделов наследников.For more information, see the Notes for Callers and Notes for Inheritors sections.

Примечания для Среда выполнения WindowsWindows RuntimeNotes for the Среда выполнения WindowsWindows Runtime

При вызове перегрузки метода Equals(Object) для класса в Среда выполнения WindowsWindows Runtimeон предоставляет поведение по умолчанию для классов, которые не переопределяют Equals(Object).When you call the Equals(Object) method overload on a class in the Среда выполнения WindowsWindows Runtime, it provides the default behavior for classes that don't override Equals(Object). Это является частью поддержки, предоставляемой .NET Framework для Среда выполнения WindowsWindows Runtime (см. раздел поддержка .NET Framework для приложений Магазина Windows и среда выполнения Windows).This is part of the support that the .NET Framework provides for the Среда выполнения WindowsWindows Runtime (see .NET Framework Support for Windows Store Apps and Windows Runtime). Классы в Среда выполнения WindowsWindows Runtime не наследуют Objectи в настоящее время не реализуют метод Equals(Object).Classes in the Среда выполнения WindowsWindows Runtime don't inherit Object, and currently don't implement an Equals(Object) method. Однако они имеют методы ToString, Equals(Object)и GetHashCode, когда они используются в коде C# или Visual Basic, а .NET Framework предоставляет поведение по умолчанию для этих методов.However, they appear to have ToString, Equals(Object), and GetHashCode methods when you use them in your C# or Visual Basic code, and the .NET Framework provides the default behavior for these methods.

Примечание

Среда выполнения WindowsWindows Runtime классы, написанные на C# или Visual Basic, могут переопределять перегрузку метода Equals(Object).classes that are written in C# or Visual Basic can override the Equals(Object) method overload.

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

Производные классы часто переопределяют метод Object.Equals(Object) для реализации равенства значений.Derived classes frequently override the Object.Equals(Object) method to implement value equality. Кроме того, типы часто предоставляют дополнительную строго типизированную перегрузку методу Equals, как правило, путем реализации интерфейса IEquatable<T>.In addition, types also frequently provide an additional strongly typed overload to the Equals method, typically by implementing the IEquatable<T> interface. При вызове метода Equals для проверки на равенство следует знать, переопределяется ли текущий экземпляр Object.Equals и понять, как разрешается определенный вызов метода Equals.When you call the Equals method to test for equality, you should know whether the current instance overrides Object.Equals and understand how a particular call to an Equals method is resolved. В противном случае вы можете выполнить проверку на равенство, отличное от предполагаемого, и метод может вернуть непредвиденное значение.Otherwise, you may be performing a test for equality that is different from what you intended, and the method may return an unexpected value.

Ниже приведен пример.The following example provides an illustration. Он создает три объекта StringBuilder с одинаковыми строками, а затем выполняет четыре вызова методов Equals.It instantiates three StringBuilder objects with identical strings, and then makes four calls to Equals methods. Первый вызов метода возвращает true, а оставшиеся три возвращаемые false.The first method call returns true, and the remaining three return 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), которая проверяет равенство значений.In the first case, the strongly typed StringBuilder.Equals(StringBuilder) method overload, which tests for value equality, is called. Поскольку строки, назначенные двум StringBuilderным объектам, равны, метод возвращает true.Because the strings assigned to the two StringBuilder objects are equal, the method returns true. Однако StringBuilder не переопределяет Object.Equals(Object).However, StringBuilder does not override Object.Equals(Object). По этой причине, когда объект StringBuilder приводится к Object, когда экземпляр StringBuilder присваивается переменной типа Objectи когда метод Object.Equals(Object, Object) передает два StringBuilder объекта, вызывается метод Object.Equals(Object) по умолчанию.Because of this, when the StringBuilder object is cast to an Object, when a StringBuilder instance is assigned to a variable of type Object, and when the Object.Equals(Object, Object) method is passed two StringBuilder objects, the default Object.Equals(Object) method is called. Поскольку StringBuilder является ссылочным типом, это эквивалентно передаче двух StringBuilder объектов в метод ReferenceEquals.Because StringBuilder is a reference type, this is equivalent to passing the two StringBuilder objects to the ReferenceEquals method. Хотя все три StringBuilder объектов содержат одинаковые строки, они ссылаются на три различных объекта.Although all three StringBuilder objects contain identical strings, they refer to three distinct objects. В результате эти три вызова метода возвращают false.As a result, these three method calls return false.

Можно сравнить текущий объект с другим объектом для равенства ссылок, вызвав метод ReferenceEquals.You can compare the current object to another object for reference equality by calling the ReferenceEquals method. В Visual Basic также можно использовать ключевое слово is (например, If Me Is otherObject Then ...).In Visual Basic, you can also use the is keyword (for example, If Me Is otherObject Then ...).

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

При определении собственного типа этот тип наследует функциональность, определенную методом Equals его базового типа.When you define your own type, that type inherits the functionality defined by the Equals method of its base type. В следующей таблице приведена реализация метода Equals по умолчанию для основных категорий типов в .NET Framework.The following table lists the default implementation of the Equals method for the major categories of types in the .NET Framework.

Категория типаType category Равенство, определенноеEquality defined by CommentsComments
Класс, производный непосредственно от ObjectClass derived directly from Object Object.Equals(Object) Равенство ссылок; эквивалентно вызову Object.ReferenceEquals.Reference equality; equivalent to calling Object.ReferenceEquals.
СтруктураStructure ValueType.Equals Равенство значений; прямое побайтовое сравнение или Сравнение полей по полям с помощью отражения.Value equality; either direct byte-by-byte comparison or field-by-field comparison using reflection.
ПеречислениеEnumeration Enum.Equals Значения должны иметь одинаковый тип перечисления и одно и то же базовое значение.Values must have the same enumeration type and the same underlying value.
ДелегатDelegate MulticastDelegate.Equals Делегаты должны иметь одинаковый тип с одинаковыми списками вызовов.Delegates must have the same type with identical invocation lists.
ИнтерфейсInterface Object.Equals(Object) Равенство ссылок.Reference equality.

Для типа значения следует всегда переопределять Equals, так как тесты на равенство, основанные на отражении, имеют низкую производительность.For a value type, you should always override Equals, because tests for equality that rely on reflection offer poor performance. Можно также переопределить реализацию Equals по умолчанию для ссылочных типов, чтобы проверить равенство значений, а не равенство ссылок и определить точное значение равенства значений.You can also override the default implementation of Equals for reference types to test for value equality instead of reference equality and to define the precise meaning of value equality. Такие реализации Equals возвращают true, если два объекта имеют одинаковое значение, даже если они не являются одним и тем же экземпляром.Such implementations of Equals return true if the two objects have the same value, even if they are not the same instance. Разработчик типа принимает решение, что составляет значение объекта, но обычно это некоторые или все данные, хранящиеся в переменных экземпляра объекта.The type's implementer decides what constitutes an object's value, but it is typically some or all the data stored in the instance variables of the object. Например, значение объекта String основано на символах строки; метод String.Equals(Object) переопределяет метод Object.Equals(Object), который возвращает true для всех экземпляров строк, содержащих одни и те же символы в том же порядке.For example, the value of a String object is based on the characters of the string; the String.Equals(Object) method overrides the Object.Equals(Object) method to return true for any two string instances that contain the same characters in the same order.

В следующем примере показано, как переопределить метод Object.Equals(Object) для проверки на равенство значений.The following example shows how to override the Object.Equals(Object) method to test for value equality. Он переопределяет метод Equals для класса Person.It overrides the Equals method for the Person class. Если Person принял свою реализацию равенства базового класса, два объекта Person будут равны, только если они ссылались на один объект.If Person accepted its base class implementation of equality, two Person objects would be equal only if they referenced a single object. Однако в этом случае два объекта Person равны, если они имеют одинаковое значение для свойства Person.Id.However, in this case, two Person objects are equal if they have the same value for the Person.Id property.

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>, чтобы обеспечить строго типизированный тест на равенство.In addition to overriding Equals, you can implement the IEquatable<T> interface to provide a strongly typed test for equality.

Следующие инструкции должны быть истинными для всех реализаций метода Equals(Object).The following statements must be true for all implementations of the Equals(Object) method. В списке x, yи z представляют ссылки на объекты, которые не равны null.In the list, x, y, and z represent object references that are not null.

Реализации Equals не должны вызывать исключения. они всегда должны возвращать значение.Implementations of Equals must not throw exceptions; they should always return a value. Например, если obj null, метод Equals должен возвращать false вместо создания ArgumentNullException.For example, if obj is null, the Equals method should return false instead of throwing an ArgumentNullException.

При переопределении Equals(Object)следуйте приведенным ниже рекомендациям.Follow these guidelines when overriding Equals(Object):

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

  • Типы, переопределяющие Equals(Object), также должны переопределять GetHashCode; в противном случае хэш-таблицы могут работать неправильно.Types that override Equals(Object) must also override GetHashCode; otherwise, hash tables might not work correctly.

  • Рекомендуется реализовать интерфейс IEquatable<T> для поддержки строго типизированных тестов на равенство.You should consider implementing the IEquatable<T> interface to support strongly typed tests for equality. Реализация IEquatable<T>.Equals должна возвращать результаты, которые соответствуют Equals.Your IEquatable<T>.Equals implementation should return results that are consistent with Equals.

  • Если ваш язык программирования поддерживает перегрузку операторов и вы передаете оператор равенства для заданного типа, необходимо также переопределить Equals(Object) метод, чтобы он возвращал тот же результат, что и оператор равенства.If your programming language supports operator overloading and you overload the equality operator for a given type, you must also override the Equals(Object) method to return the same result as the equality operator. Это позволяет гарантировать, что код библиотеки классов, использующий Equals (например, ArrayList и Hashtable) ведет себя таким образом, который соответствует способу, который код приложения использует оператор равенства.This helps ensure that class library code that uses Equals (such as ArrayList and Hashtable) behaves in a manner that is consistent with the way the equality operator is used by application code.

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

Следующие рекомендации применяются для переопределения Equals(Object) для ссылочного типа:The following guidelines apply to overriding Equals(Object) for a reference type:

  • Рассмотрите возможность переопределения Equals Если семантика типа основана на том, что тип представляет некоторые значения.Consider overriding Equals if the semantics of the type are based on the fact that the type represents some value(s).

  • Большинство ссылочных типов не должны перегружать оператор равенства, даже если они переопределяют Equals.Most reference types must not overload the equality operator, even if they override Equals. Однако при реализации ссылочного типа, который должен иметь семантику значений, например тип комплексного числа, необходимо переопределить оператор равенства.However, if you are implementing a reference type that is intended to have value semantics, such as a complex number type, you must override the equality operator.

  • Не следует переопределять Equals для изменяемого ссылочного типа.You should not override Equals on a mutable reference type. Это обусловлено тем, что переопределение Equals требует также переопределения метода GetHashCode, как описано в предыдущем разделе.This is because overriding Equals requires that you also override the GetHashCode method, as discussed in the previous section. Это означает, что хэш-код экземпляра изменяемого ссылочного типа может измениться в течение своего времени существования, что может привести к потере объекта в хэш-таблице.This means that the hash code of an instance of a mutable reference type can change during its lifetime, which can cause the object to be lost in a hash table.

Рекомендации по типам значенийGuidelines for Value Types

Следующие рекомендации применяются для переопределения Equals(Object) для типа значения.The following guidelines apply to overriding Equals(Object) for a value type:

  • При определении типа значения, включающего одно или несколько полей, значения которых являются ссылочными типами, следует переопределить Equals(Object).If you are defining a value type that includes one or more fields whose values are reference types, you should override Equals(Object). Реализация Equals(Object), предоставляемая ValueType, выполняет побайтовое сравнение для типов значений, поля которых являются типами значений, но использует отражение для выполнения сравнения по полям значений, поля которых включают ссылочные типы.The Equals(Object) implementation provided by ValueType performs a byte-by-byte comparison for value types whose fields are all value types, but it uses reflection to perform a field-by-field comparison of value types whose fields include reference types.

  • Если переопределение Equals и язык разработки поддерживает перегрузку операторов, необходимо перегрузить оператор равенства.If you override Equals and your development language supports operator overloading, you must overload the equality operator.

  • Необходимо реализовать интерфейс IEquatable<T>.You should implement the IEquatable<T> interface. Вызов строго типизированного IEquatable<T>.Equals метода позволяет избежать упаковки-преобразования аргумента obj.Calling the strongly typed IEquatable<T>.Equals method avoids boxing the obj argument.

Дополнительно

Equals(Object, Object)

Определяет, считаются ли равными указанные экземпляры объектов.Determines whether the specified object instances are considered equal.

public:
 static bool Equals(System::Object ^ objA, System::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

Первый сравниваемый объект.The first object to compare.

objB
Object

Второй сравниваемый объект.The second object to compare.

Возвраты

true, если указанные объекты равны; в противном случае — false.true if the objects are considered equal; otherwise, false. Если оба параметра objA и objB имеют значение NULL, метод возвращает значение true.If both objA and objB are null, the method returns true.

Примеры

В следующем примере показан метод Equals(Object, Object) и сравнивается с методом ReferenceEquals.The following example illustrates the Equals(Object, Object) method and compares it with the ReferenceEquals method.

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.The static Equals(Object, Object) method indicates whether two objects, objA and objB, are equal. Он также позволяет тестировать объекты, значение которых равно null , для проверки на равенство.It also enables you to test objects whose value is null for equality. Он сравнивает objA и objB на равенство следующим образом:It compares objA and objB for equality as follows:

  • Он определяет, представляют ли два объекта одну и ту же ссылку на объект.It determines whether the two objects represent the same object reference. В противном случае метод возвращает true.If they do, the method returns true. Этот тест эквивалентен вызову метода ReferenceEquals.This test is equivalent to calling the ReferenceEquals method. Кроме того, если оба objA и objB имеют значение NULL, метод возвращает true.In addition, if both objA and objB are null, the method returns true.

  • Он определяет, имеет ли objA или objB значение NULL.It determines whether either objA or objB is null. Если да, то возвращается false.If so, it returns false.

  • Если два объекта не представляют одну и ту же ссылку на объект и ни один из них не имеет значения NULL, то вызывается objA.Equals(objB) и возвращает результат.If the two objects do not represent the same object reference and neither is null, it calls objA.Equals(objB) and returns the result. Это означает, что если objA переопределяет метод Object.Equals(Object), вызывается это переопределение.This means that if objA overrides the Object.Equals(Object) method, this override is called.

Дополнительно

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