CA2231: ValueType.Equals를 재정의할 때 같음 연산자를 오버로드하십시오.

원인

값 형식은 System.Object.Equals를 재정의하지만 같음 연산자를 구현하지 않습니다.

기본적으로 이 규칙은 외부에 표시되는 형식만 확인하지만 이는 구성 가능합니다.

규칙 설명

대부분의 프로그래밍 언어에는 값 형식에 대한 같음 연산자(==)의 기본 구현이 없습니다. 프로그래밍 언어가 연산자 오버로드를 지원하는 경우 같음 연산자를 구현하는 것을 고려해야 합니다. 해당 동작은 Equals의 동작과 동일해야 합니다.

같음 연산자의 오버로드된 구현에서는 기본 같음 연산자를 사용할 수 없습니다. 사용할 경우 스택 오버플로가 발생합니다. 같음 연산자를 구현하려면 구현에서 Object.Equals 메서드를 사용합니다. 예시:

If (Object.ReferenceEquals(left, Nothing)) Then
    Return Object.ReferenceEquals(right, Nothing)
Else
    Return left.Equals(right)
End If

if (Object.ReferenceEquals(left, null))
    return Object.ReferenceEquals(right, null);
return left.Equals(right);

위반 문제를 해결하는 방법

이 규칙 위반 문제를 해결하려면 같음 연산자를 구현합니다.

경고를 표시하지 않는 경우

이 규칙에서는 경고를 표시하지 않아도 됩니다. 그러나 가능하면 같음 연산자를 제공하는 것이 좋습니다.

경고 표시 안 함

단일 위반만 표시하지 않으려면 원본 파일에 전처리기 지시문을 추가하여 규칙을 사용하지 않도록 설정한 후 다시 사용하도록 설정합니다.

#pragma warning disable CA2231
// The code that's violating the rule is on this line.
#pragma warning restore CA2231

파일, 폴더 또는 프로젝트에 대한 규칙을 사용하지 않도록 설정하려면 구성 파일에서 심각도를 none으로 설정합니다.

[*.{cs,vb}]
dotnet_diagnostic.CA2231.severity = none

자세한 내용은 방법: 코드 분석 경고 표시 안 함을 참조하세요.

분석할 코드 구성

다음 옵션을 사용하여 이 규칙이 실행될 코드베이스 부분을 구성합니다.

• 특정 API 화면 포함

이 규칙, 적용되는 모든 규칙 또는 적용되는 이 범주의 모든 규칙(사용)에 대해 이 옵션을 구성할 수 있습니다. 자세한 내용은 코드 품질 규칙 구성 옵션을 참조하세요.

특정 API 화면 포함

접근성을 기반으로 이 규칙을 실행할 코드베이스의 파트를 구성할 수 있습니다. 예를 들어 규칙이 퍼블릭이 아닌 API 표면에서만 실행되도록 지정하려면 프로젝트의 .editorconfig 파일에 다음 키-값 쌍을 추가합니다.

dotnet_code_quality.CAXXXX.api_surface = private, internal

예시

다음 예제에서는 이 규칙을 위반하는 형식을 정의합니다.

public struct PointWithoutHash
{
    private int x, y;

    public PointWithoutHash(int x, int y)
    {
        this.x = x;
        this.y = y;
    }

    public override string ToString()
    {
        return String.Format("({0},{1})", x, y);
    }

    public int X { get { return x; } }

    public int Y { get { return x; } }

    // Violates rule: OverrideGetHashCodeOnOverridingEquals.
    // Violates rule: OverrideOperatorEqualsOnOverridingValueTypeEquals.
    public override bool Equals(object? obj)
    {
        if (obj?.GetType() != typeof(PointWithoutHash))
            return false;

        PointWithoutHash p = (PointWithoutHash)obj;
        return ((this.x == p.x) && (this.y == p.y));
    }
}

관련 규칙

• CA1046: 참조 형식에 같음 연산자를 오버로드하지 마십시오.
• CA2225: 연산자 오버로드에는 명명된 대체 항목이 있습니다.
• CA2226: 연산자에는 대칭 오버로드가 있어야 합니다.

참고 항목

• System.Object.Equals