Метод System.Object.Equals
В этой статье приводятся дополнительные замечания к справочной документации по этому API.
Эта статья относится к методу Object.Equals(Object) .
Тип сравнения между текущим экземпляром и obj
параметром зависит от того, является ли текущий экземпляр ссылочным типом или типом значения.
Если текущий экземпляр является ссылочным типом, Equals(Object) метод проверяет равенство ссылок, а вызов метода эквивалентен вызову Equals(Object)ReferenceEquals метода. Равенство ссылок означает, что переменные объекта, сравниваемые с тем же объектом. В следующем примере показан результат такого сравнения. Он определяет
Person
класс, являющийся ссылочным типом, и вызываетPerson
конструктор классов для создания экземпляров двух новыхPerson
объектовperson1a
иperson2
того же значения. Он также назначаетсяperson1a
другой переменной объекта.person1b
Как показано в примере выходные данные иperson1b
равны,person1a
так как они ссылаются на тот же объект. Однако иperson2
не равны,person1a
хотя они имеют то же значение.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 Example1 { 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. type Person(name) = override _.ToString() = name let person1a = Person "John" let person1b = person1a let person2 = Person(string person1a) printfn "Calling Equals:" printfn $"person1a and person1b: {person1a.Equals person1b}" printfn $"person1a and person2: {person1a.Equals person2}" printfn "\nCasting to an Object and calling Equals:" printfn $"person1a and person1b: {(person1a :> obj).Equals(person1b :> obj)}" printfn $"person1a and person2: {(person1a :> obj).Equals(person2 :> obj)}" // 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 Person1 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 Example0 Public Sub Main() Dim person1a As New Person1("John") Dim person1b As Person1 = person1a Dim person2 As New Person1(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
let value1 = 12uy let value2 = 12 let object1 = value1 :> obj let object2 = value2 :> obj printfn $"{object1} ({object1.GetType().Name}) = {object2} ({object2.GetType().Name}): {object1.Equals object2}" // The example displays the following output: // 12 (Byte) = 12 (Int32): False
Module Example2 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 Person3 { private string personName; public Person3(string name) { this.personName = name; } public override string ToString() { return this.personName; } } public struct Example3 { public static void Main() { Person3 person1 = new Person3("John"); Person3 person2 = new Person3("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. [<Struct>] type Person(personName: string) = override _.ToString() = personName let person1 = Person "John" let person2 = Person "John" printfn "Calling Equals:" printfn $"{person1.Equals person2}" printfn $"\nCasting to an Object and calling Equals:" printfn $"{(person1 :> obj).Equals(person2 :> obj)}" // 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 Person4 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 Example4 Public Sub Main() Dim p1 As New Person4("John") Dim p2 As New Person4("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, Object.Equals(Object) метод предоставляет сравнение равенства по умолчанию для всех других типов. Однако типы часто переопределяют Equals метод для реализации равенства значений. Дополнительные сведения см. в разделах "Заметки для вызывающих абонентов" и "Заметки для наследующих".
Заметки о среда выполнения Windows
При вызове перегрузки Equals(Object) метода в классе в среда выполнения Windows он предоставляет поведение по умолчанию для классов, которые не переопределяютсяEquals(Object). Это часть поддержки, которую предоставляет .NET для среда выполнения Windows (см. раздел о поддержке .NET для приложений Магазина Windows и среда выполнения Windows). Классы в среда выполнения Windows не наследуются Objectи в настоящее время не реализуют Equals(Object) метод. Однако они, как представляется, имеют ToStringEquals(Object)методы и GetHashCode методы при их использовании в коде C# или Visual Basic, а .NET обеспечивает поведение по умолчанию для этих методов.
Примечание.
среда выполнения 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 Example5
{
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
open System
open System.Text
let sb1 = StringBuilder "building a string..."
let sb2 = StringBuilder "building a string..."
printfn $"sb1.Equals(sb2): {sb1.Equals sb2}"
printfn $"((Object) sb1).Equals(sb2): {(sb1 :> obj).Equals sb2}"
printfn $"Object.Equals(sb1, sb2): {Object.Equals(sb1, sb2)}"
let sb3 = StringBuilder "building a string..."
printfn $"\nsb3.Equals(sb2): {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 Example5
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 приведение объекта к ObjectStringBuilder переменной типа ObjectObject.Equals(Object, Object) экземпляра и при передаче двух StringBuilder объектов вызывается метод по умолчаниюObject.Equals(Object). Так как StringBuilder это ссылочный тип, это эквивалентно передаче двух StringBuilder объектов в ReferenceEquals метод. Хотя все три StringBuilder объекта содержат одинаковые строки, они ссылаются на три отдельных объекта. В результате эти три вызова метода возвращаются false
.
Текущий объект можно сравнить с другим объектом для равенства ссылок, вызвав ReferenceEquals метод. В Visual Basic можно также использовать is
ключевое слово (например, If Me Is otherObject Then ...
).
Заметки для наследутелей
При определении собственного типа этот тип наследует функциональные возможности, определенные методом Equals
базового типа. В следующей таблице перечислены реализации Equals
метода по умолчанию для основных категорий типов в .NET.
Категория типа | Равенство, определенное | Комментарии |
---|---|---|
Класс, производный непосредственно от Object | Object.Equals(Object) | Равенство ссылок; эквивалент вызова Object.ReferenceEquals. |
Структура | 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 Person6
{
private string idNumber;
private string personName;
public Person6(string name, string id)
{
this.personName = name;
this.idNumber = id;
}
public override bool Equals(Object obj)
{
Person6 personObj = obj as Person6;
if (personObj == null)
return false;
else
return idNumber.Equals(personObj.idNumber);
}
public override int GetHashCode()
{
return this.idNumber.GetHashCode();
}
}
public class Example6
{
public static void Main()
{
Person6 p1 = new Person6("John", "63412895");
Person6 p2 = new Person6("Jack", "63412895");
Console.WriteLine(p1.Equals(p2));
Console.WriteLine(Object.Equals(p1, p2));
}
}
// The example displays the following output:
// True
// True
open System
type Person(name, id) =
member _.Name = name
member _.Id = id
override _.Equals(obj) =
match obj with
| :? Person as personObj ->
id.Equals personObj.Id
| _ ->
false
override _.GetHashCode() =
id.GetHashCode()
let p1 = Person("John", "63412895")
let p2 = Person("Jack", "63412895")
printfn $"{p1.Equals p2}"
printfn $"{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 Example6
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> для обеспечения строго типизированного теста на равенство.
Следующие инструкции должны иметь значение true для всех реализаций Equals(Object) метода. В списке x
, y
а также z
представляют ссылки на объекты, которые не имеют значения NULL.
x.Equals(x)
возвращаетtrue
.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
это так, Equals метод должен возвращать false
вместо того, чтобы вызывать ArgumentNullExceptionnull
объект.
Следуйте этим рекомендациям при переопределении Equals(Object):
Типы, реализующие IComparable , должны переопределяться Equals(Object).
Типы, которые переопределяются, также должны переопределяться Equals(Object)GetHashCode; в противном случае хэш-таблицы могут работать неправильно.
Следует рассмотреть возможность реализации IEquatable<T> интерфейса для поддержки строго типизированных тестов для равенства. Ваша реализация IEquatable<T>.Equals должна возвращать результаты, которые соответствуют Equals.
Если язык программирования поддерживает перегрузку операторов и перегружает оператор равенства для заданного типа, необходимо также переопределить Equals(Object) метод, чтобы вернуть тот же результат, что и оператор равенства. Это помогает гарантировать, что код библиотеки классов, который использует Equals (например ArrayList , и Hashtable) ведет себя таким образом, что соответствует тому, как оператор равенства используется кодом приложения.
Рекомендации по ссылочным типам
Следующие рекомендации применяются к переопределении Equals(Object) для ссылочного типа:
Рекомендуется переопределить Equals , если семантика типа основана на том, что тип представляет некоторые значения.
Большинство ссылочных типов не должны перегружать оператор равенства, даже если они переопределяются Equals. Однако если вы реализуете ссылочный тип, предназначенный для семантики значений, например сложного типа числа, необходимо переопределить оператор равенства.
Переопределение не следует переопределять Equals в изменяемом типе ссылок. Это связано с тем, что переопределение требует переопределения EqualsGetHashCode метода, как описано в предыдущем разделе. Это означает, что хэш-код экземпляра изменяемого ссылочного типа может измениться во время его существования, что может привести к потере объекта в хэш-таблице.
Рекомендации по типам значений
Следующие рекомендации применяются к переопределении Equals(Object) для типа значения:
Если вы определяете тип значения, включающий одно или несколько полей, значения которых являются ссылочными типами, следует переопределить Equals(Object). Реализация, Equals(Object) предоставляемая ValueType путем сравнения байтов по байтам для типов значений, поля которых являются всеми типами значений, но использует отражение для выполнения сравнения типов значений по полю, поля которых включают ссылочные типы.
Если вы переопределяете и язык разработки Equals поддерживает перегрузку операторов, необходимо перегрузить оператор равенства.
Необходимо реализовать IEquatable<T> интерфейс. Вызов строго типизированного IEquatable<T>.Equals метода позволяет избежать поля аргумента
obj
.
Примеры
В следующем примере показан Point
класс, который переопределяет Equals метод для обеспечения равенства значений и Point3D
класса, производный от Point
. Так как Point
переопределяется Object.Equals(Object) для проверки равенства значений, Object.Equals(Object) метод не вызывается. Однако вызовы Point.Equals
Object.Equals(Object), Point3D.Equals
поскольку Point
реализуются таким образом, чтобы обеспечить равенство значений.
using System;
class Point2
{
protected int x, y;
public Point2() : this(0, 0)
{ }
public Point2(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
{
Point2 p = (Point2)obj;
return (x == p.x) && (y == p.y);
}
}
public override int GetHashCode()
{
return (x << 2) ^ y;
}
public override string ToString()
{
return String.Format("Point2({0}, {1})", x, y);
}
}
sealed class Point3D : Point2
{
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((Point2)obj) && z == pt3.z;
}
public override int GetHashCode()
{
return (base.GetHashCode() << 2) ^ z;
}
public override String ToString()
{
return String.Format("Point2({0}, {1}, {2})", x, y, z);
}
}
class Example7
{
public static void Main()
{
Point2 point2D = new Point2(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:
// Point2(5, 5) = Point2(5, 5, 2): False
// Point2(5, 5) = Point2(5, 5, 2): False
// Point2(5, 5, 2) = Point2(5, 5, 2): True
// Point2(5, 5, 2) = Point2(5, 5, -1): False
type Point(x, y) =
new () = Point(0, 0)
member _.X = x
member _.Y = y
override _.Equals(obj) =
//Check for null and compare run-time types.
match obj with
| :? Point as p ->
x = p.X && y = p.Y
| _ ->
false
override _.GetHashCode() =
(x <<< 2) ^^^ y
override _.ToString() =
$"Point({x}, {y})"
type Point3D(x, y, z) =
inherit Point(x, y)
member _.Z = z
override _.Equals(obj) =
match obj with
| :? Point3D as pt3 ->
base.Equals(pt3 :> Point) && z = pt3.Z
| _ ->
false
override _.GetHashCode() =
(base.GetHashCode() <<< 2) ^^^ z
override _.ToString() =
$"Point({x}, {y}, {z})"
let point2D = Point(5, 5)
let point3Da = Point3D(5, 5, 2)
let point3Db = Point3D(5, 5, 2)
let point3Dc = Point3D(5, 5, -1)
printfn $"{point2D} = {point3Da}: {point2D.Equals point3Da}"
printfn $"{point2D} = {point3Db}: {point2D.Equals point3Db}"
printfn $"{point3Da} = {point3Db}: {point3Da.Equals point3Db}"
printfn $"{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 Point1
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 Point1 = DirectCast(obj, Point1)
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("Point1({0}, {1})", x, y)
End Function
End Class
Class Point3D : Inherits Point1
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, Point1)) 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("Point1({0}, {1}, {2})", x, y, z)
End Function
End Class
Module Example1
Public Sub Main()
Dim point2D As New Point1(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
' Point1(5, 5) = Point1(5, 5, 2): False
' Point1(5, 5) = Point1(5, 5, 2): False
' Point1(5, 5, 2) = Point1(5, 5, 2): True
' Point1(5, 5, 2) = Point1(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
type Point(x, y) =
member _.X = x
member _.Y = y
override _.Equals(obj) =
// Performs an equality check on two points (integer pairs).
match obj with
| :? Point as p ->
x = p.X && y = p.Y
| _ ->
false
override _.GetHashCode() =
(x, y).GetHashCode()
type Rectangle(upLeftX, upLeftY, downRightX, downRightY) =
let a = Point(upLeftX, upLeftY)
let b = Point(downRightX, downRightY)
member _.UpLeft = a
member _.DownRight = b
override _.Equals(obj) =
// Perform an equality check on two rectangles (Point object pairs).
match obj with
| :? Rectangle as r ->
a.Equals(r.UpLeft) && b.Equals(r.DownRight)
| _ ->
false
override _.GetHashCode() =
(a, b).GetHashCode()
override _.ToString() =
$"Rectangle({a.X}, {a.Y}, {b.X}, {b.Y})"
let r1 = Rectangle(0, 0, 100, 200)
let r2 = Rectangle(0, 0, 100, 200)
let r3 = Rectangle(0, 0, 150, 200)
printfn $"{r1} = {r2}: {r1.Equals r2}"
printfn $"{r1} = {r3}: {r1.Equals r3}"
printfn $"{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
[<Struct; CustomEquality; NoComparison>]
type Complex =
val mutable re: double
val mutable im: double
override this.Equals(obj) =
match obj with
| :? Complex as c when c = this -> true
| _ -> false
override this.GetHashCode() =
(this.re, this.im).GetHashCode()
override this.ToString() =
$"({this.re}, {this.im})"
static member op_Equality (x: Complex, y: Complex) =
x.re = y.re && x.im = y.im
static member op_Inequality (x: Complex, y: Complex) =
x = y |> not
let mutable cmplx1 = Complex()
let mutable cmplx2 = Complex()
cmplx1.re <- 4.0
cmplx1.im <- 1.0
cmplx2.re <- 2.0
cmplx2.im <- 1.0
printfn $"{cmplx1} <> {cmplx2}: {cmplx1 <> cmplx2}"
printfn $"{cmplx1} = {cmplx2}: {cmplx1.Equals cmplx2}"
cmplx2.re <- 4.0
printfn $"{cmplx1} = {cmplx2}: {cmplx1 = cmplx2}"
printfn $"{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 Example8
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 для определения точного типа времени выполнения каждого объекта, но вместо этого obj
можно использовать is
оператор в C# или TypeOf
оператор в Visual Basic, чтобы проверка тип параметра.