방법: 형식의 값 일치 정의(C# 프로그래밍 가이드)
클래스 또는 구조체를 정의할 경우 해당 형식의 값 일치 또는 동등성에 대한 사용자 지정 정의를 만드는 것이 의미 있는지 여부를 결정하게 됩니다. 일반적으로는 해당 형식의 개체가 특정 유형의 컬렉션에 추가될 것으로 예상되거나 해당 형식의 주 용도가 필드 또는 속성 집합을 저장하는 데 있으면 값 일치를 구현합니다. 값 일치의 정의는 해당 형식의 모든 필드 및 속성에 대한 비교를 기준으로 하거나 하위 집합에 대한 정의를 기반으로 할 수 있습니다. 그러나 어느 경우이든 클래스 및 구조체에 대한 동등성을 구현하려면 다음 5가지 사항이 준수되어야 합니다.
x.Equals(x)는 true를 반환합니다. 이를 반사 속성이라고 합니다.
x.Equals(y)와 y.Equals(x)의 반환 값은 같습니다. 이를 대칭 속성이라고 합니다.
(x.Equals(y) && y.Equals(z))가 true를 반환하는 경우 x.Equals(z)도 true를 반환합니다. 이를 전이 속성이라고 합니다.
x 및 y가 참조하는 개체가 수정되지 않는 한 x.Equals(y)를 계속 호출해도 같은 값이 반환됩니다.
x.Equals(null)에서 false를 반환합니다. 그러나 null.Equals(null)의 경우는 위의 2번째 규칙에 위배되므로 예외가 throw됩니다.
사용자가 정의한 모든 구조체에는 Object.Equals(Object) 메서드의 System.ValueType 재정의에서 상속한 값 일치의 기본 구현이 있습니다. 이 구현에서는 리플렉션을 사용하여 해당 형식의 모든 public 필드와 속성 및 public이 아닌 필드와 속성을 검사합니다. 이 구현을 통해 올바른 결과를 얻을 수 있기는 하지만 해당 형식에 맞게 직접 작성한 사용자 지정 구현에 비해 느리다는 단점이 있습니다.
값 일치에 대한 기본적 구현은 클래스와 구조체에서 서로 다릅니다. 그러나 값 일치를 구현하기 위한 기본적 단계는 클래스와 구조체에서 동일합니다.
가상 메서드 Object.Equals(Object)를 재정합니다. 대부분의 경우 bool Equals( object obj ) 구현에서는 각 형식에 맞게 System.IEquatable<T> 인터페이스를 구현한 Equals 메서드를 호출하게 됩니다. 2단계를 참조하십시오.
형식에 맞는 Equals 메서드를 제공하여 System.IEquatable<T> 인터페이스를 구현합니다. 실질적인 동등성 비교는 이 메서드에서 수행됩니다. 예를 들어, 형식의 필드를 한 개만 비교하거나 두 개 비교하여 일치 여부를 결정하도록 정의할 수 있습니다. Equals에서 예외를 throw하지 마십시오. 클래스의 경우에는 해당 클래스에 선언되어 있는 필드만 이 메서드에서 검사해야 합니다. 기본 클래스에 있는 필드를 검사하려면 base.Equals를 호출해야 합니다. 형식이 Object에서 직접 상속되는 경우에는 이렇게 호출하지 마십시오. Object.Equals(Object)의 Object 구현에서는 참조 일치 검사를 수행합니다.
값이 일치하는 두 개체에서 동일한 해시 코드를 생성하도록 Object.GetHashCode를 재정의합니다.
"보다 큼" 또는 "보다 작음"의 정의를 지원하려면 형식에 맞게 IComparable<T> 인터페이스를 구현하고 <= 및 >= 연산자를 오버로드합니다. 이 단계는 선택적입니다.
다음의 첫 번째 예제에서는 클래스 구현을 보여 주고, 두 번째 예제에서는 구조체 구현을 보여 줍니다.
예제
다음 예제에서는 클래스(참조 형식)의 값 일치를 구현하는 방법을 보여 줍니다.
namespace ValueEquality
{
using System;
class TwoDPoint : IEquatable<TwoDPoint>
{
// Readonly auto-implemented properties.
public int X { get; private set; }
public int Y { get; private set; }
// Set the properties in the constructor.
public TwoDPoint(int x, int y)
{
if ((x < 1) || (x > 2000) || (y < 1) || (y > 2000))
throw new System.ArgumentException("Point must be in range 1 - 2000");
this.X = x;
this.Y = y;
}
public override bool Equals(object obj)
{
return this.Equals(obj as TwoDPoint);
}
public bool Equals(TwoDPoint p)
{
// If parameter is null, return false.
if (Object.ReferenceEquals(p, null))
{
return false;
}
// Optimization for a common success case.
if (Object.ReferenceEquals(this, p))
{
return true;
}
// If run-time types are not exactly the same, return false.
if (this.GetType() != p.GetType())
return false;
// Return true if the fields match.
// Note that the base class is not invoked because it is
// System.Object, which defines Equals as reference equality.
return (X == p.X) && (Y == p.Y);
}
public override int GetHashCode()
{
return X * 0x00010000 + Y;
}
public static bool operator ==(TwoDPoint lhs, TwoDPoint rhs)
{
// Check for null on left side.
if (Object.ReferenceEquals(lhs, null))
{
if (Object.ReferenceEquals(rhs, null))
{
// null == null = true.
return true;
}
// Only the left side is null.
return false;
}
// Equals handles case of null on right side.
return lhs.Equals(rhs);
}
public static bool operator !=(TwoDPoint lhs, TwoDPoint rhs)
{
return !(lhs == rhs);
}
}
// For the sake of simplicity, assume a ThreeDPoint IS a TwoDPoint.
class ThreeDPoint : TwoDPoint, IEquatable<ThreeDPoint>
{
public int Z { get; private set; }
public ThreeDPoint(int x, int y, int z)
: base(x, y)
{
if ((z < 1) || (z > 2000))
throw new System.ArgumentException("Point must be in range 1 - 2000");
this.Z = z;
}
public override bool Equals(object obj)
{
return this.Equals(obj as ThreeDPoint);
}
public bool Equals(ThreeDPoint p)
{
// If parameter is null, return false.
if (Object.ReferenceEquals(p, null))
{
return false;
}
// Optimization for a common success case.
if (Object.ReferenceEquals(this, p))
{
return true;
}
// Check properties that this class declares.
if (Z == p.Z)
{
// Let base class check its own fields
// and do the run-time type comparison.
return base.Equals((TwoDPoint)p);
}
else
return false;
}
public override int GetHashCode()
{
return (X * 0x100000) + (Y * 0x1000) + Z;
}
public static bool operator ==(ThreeDPoint lhs, ThreeDPoint rhs)
{
// Check for null.
if (Object.ReferenceEquals(lhs, null))
{
if (Object.ReferenceEquals(lhs, null))
{
// null == null = true.
return true;
}
// Only the left side is null.
return false;
}
// Equals handles the case of null on right side.
return lhs.Equals(rhs);
}
public static bool operator !=(ThreeDPoint lhs, ThreeDPoint rhs)
{
return !(lhs == rhs);
}
}
class Program
{
static void Main(string[] args)
{
ThreeDPoint pointA = new ThreeDPoint(3, 4, 5);
ThreeDPoint pointB = new ThreeDPoint(3, 4, 5);
ThreeDPoint pointC = null;
int i = 5;
Console.WriteLine("pointA.Equals(pointB) = {0}", pointA.Equals(pointB));
Console.WriteLine("pointA == pointB = {0}", pointA == pointB);
Console.WriteLine("null comparison = {0}", pointA.Equals(pointC));
Console.WriteLine("Compare to some other type = {0}", pointA.Equals(i));
TwoDPoint pointD = null;
TwoDPoint pointE = null;
Console.WriteLine("Two null TwoDPoints are equal: {0}", pointD == pointE);
pointE = new TwoDPoint(3, 4);
Console.WriteLine("(pointE == pointA) = {0}", pointE == pointA);
Console.WriteLine("(pointA == pointE) = {0}", pointA == pointE);
Console.WriteLine("(pointA != pointE) = {0}", pointA != pointE);
System.Collections.ArrayList list = new System.Collections.ArrayList();
list.Add(new ThreeDPoint(3, 4, 5));
Console.WriteLine("pointE.Equals(list[0]): {0}", pointE.Equals(list[0]));
// Keep the console window open in debug mode.
System.Console.WriteLine("Press any key to exit.");
System.Console.ReadKey();
}
}
/* Output:
pointA.Equals(pointB) = True
pointA == pointB = True
null comparison = False
Compare to some other type = False
Two null TwoDPoints are equal: True
(pointE == pointA) = False
(pointA == pointE) = False
(pointA != pointE) = True
pointE.Equals(list[0]): False
*/
}
클래스(참조 형식)의 경우 두 Object.Equals(Object) 메서드의 기본 구현에서 값 일치 검사가 아니라 참조 일치 비교를 수행합니다. 구현자가 가상 메서드를 재정의하는 목적은 해당 메서드에 값 일치 구문을 지정하는 데 있습니다.
== 및 != 연산자는 클래스에서 재정의하지 않은 경우에도 해당 클래스와 함께 사용될 수 있습니다. 그러나 기본 동작은 참조 일치 검사를 수행하는 것입니다. 클래스에서 Equals 메서드를 재정의한 경우 == 및 != 연산자를 오버로드하는 것이 좋지만 오버로드가 반드시 필요한 것은 아닙니다.
다음 예제에서는 구조체(값 형식)의 값 일치를 구현하는 방법을 보여 줍니다.
struct TwoDPoint : IEquatable<TwoDPoint>
{
// Read/write auto-implemented properties.
public int X { get; private set; }
public int Y { get; private set; }
public TwoDPoint(int x, int y)
: this()
{
X = x;
Y = x;
}
public override bool Equals(object obj)
{
if (obj is TwoDPoint)
{
return this.Equals((TwoDPoint)obj);
}
return false;
}
public bool Equals(TwoDPoint p)
{
return (X == p.X) && (Y == p.Y);
}
public override int GetHashCode()
{
return X ^ Y;
}
public static bool operator ==(TwoDPoint lhs, TwoDPoint rhs)
{
return lhs.Equals(rhs);
}
public static bool operator !=(TwoDPoint lhs, TwoDPoint rhs)
{
return !(lhs.Equals(rhs));
}
}
class Program
{
static void Main(string[] args)
{
TwoDPoint pointA = new TwoDPoint(3, 4);
TwoDPoint pointB = new TwoDPoint(3, 4);
int i = 5;
// Compare using virtual Equals, static Equals, and == and != operators.
// True:
Console.WriteLine("pointA.Equals(pointB) = {0}", pointA.Equals(pointB));
// True:
Console.WriteLine("pointA == pointB = {0}", pointA == pointB);
// True:
Console.WriteLine("Object.Equals(pointA, pointB) = {0}", Object.Equals(pointA, pointB));
// False:
Console.WriteLine("pointA.Equals(null) = {0}", pointA.Equals(null));
// False:
Console.WriteLine("(pointA == null) = {0}", pointA == null);
// True:
Console.WriteLine("(pointA != null) = {0}", pointA != null);
// False:
Console.WriteLine("pointA.Equals(i) = {0}", pointA.Equals(i));
// CS0019:
// Console.WriteLine("pointA == i = {0}", pointA == i);
// Compare unboxed to boxed.
System.Collections.ArrayList list = new System.Collections.ArrayList();
list.Add(new TwoDPoint(3, 4));
// True:
Console.WriteLine("pointE.Equals(list[0]): {0}", pointA.Equals(list[0]));
// Compare nullable to nullable and to non-nullable.
TwoDPoint? pointC = null;
TwoDPoint? pointD = null;
// False:
Console.WriteLine("pointA == (pointC = null) = {0}", pointA == pointC);
// True:
Console.WriteLine("pointC == pointD = {0}", pointC == pointD);
TwoDPoint temp = new TwoDPoint(3, 4);
pointC = temp;
// True:
Console.WriteLine("pointA == (pointC = 3,4) = {0}", pointA == pointC);
pointD = temp;
// True:
Console.WriteLine("pointD == (pointC = 3,4) = {0}", pointD == pointC);
// Keep the console window open in debug mode.
System.Console.WriteLine("Press any key to exit.");
System.Console.ReadKey();
}
}
/* Output:
pointA.Equals(pointB) = True
pointA == pointB = True
Object.Equals(pointA, pointB) = True
pointA.Equals(null) = False
(pointA == null) = False
(pointA != null) = True
pointA.Equals(i) = False
pointE.Equals(list[0]): True
pointA == (pointC = null) = False
pointC == pointD = True
pointA == (pointC = 3,4) = True
pointD == (pointC = 3,4) = True
*/
}
구조체의 경우 Object.Equals(Object)의 기본 구현(System.ValueType에서 재정의한 버전)에서는 해당 형식의 모든 필드 값을 비교하는 데 리플렉션을 사용하여 값 일치 검사를 수행합니다. 구현자가 구조체에서 가상 메서드 Equals를 재정의하는 목적은 값 일치 검사를 수행할 수 있는 보다 효율적인 수단을 제공하고 추가적으로 비교의 기준을 구조체의 필드 또는 속성 하위 집합에 두려는 데 있습니다.
== 및 != 연산자는 구조체에서 명시적으로 오버로드하지 않는 한 구조체에 대해 연산을 수행할 수 없습니다.