CA1066: Eşittir'i geçersiz kılırken IEquatable uygulama

  • Makale
Özellik Değer
Kural Kimliği CA1066
Başlık Equals’ı geçersiz kılarken IEquatable uygulayın
Kategori Tasarım
Hataya neden olan veya bozulmayan düzeltme Hataya neden olmayan
.NET 8'de varsayılan olarak etkin Hayır

Neden

Bir değer türü (yapı) yöntemini geçersiz kılar Equals , ancak uygulamaz IEquatable<T>.

Kural açıklaması

Geçersiz kılma Equals yöntemi, değer eşitliği için türün iki örneğini karşılaştırmayı desteklediğini gösterir. Eşitlik için kesin olarak belirlenmiş testleri desteklemek için arabirimini uygulamayı IEquatable<T> göz önünde bulundurun. Bu, eşitlik denetimleri gerçekleştiren çağıranların kesin olarak yazılan System.IEquatable<T>.Equals yöntemi çağırmasını ve bağımsız değişkeni kutulamaktan kaçınarak performansı geliştirmesini sağlar. Daha fazla bilgi için buraya bakın.

Uygulamanız System.IEquatable<T>.Equals ile Equalstutarlı sonuçlar döndürmelidir.

İhlalleri düzeltme

Bir ihlali düzeltmek için bu uygulanan yöntemi çağırmak için geçersiz kılmayı uygulayın IEquatable<T> ve güncelleştirin Equals . Örneğin, aşağıdaki iki kod parçacığı kuralın ihlalini ve nasıl düzeltileceğini gösterir:

public struct S
{
    private readonly int _value;
    public S(int f)
    {
        _value = f;
    }

    public override int GetHashCode()
        => _value.GetHashCode();

    public override bool Equals(object other)
        => other is S otherS && _value == otherS._value;
}

using System;

public struct S : IEquatable<S>
{
    private readonly int _value;
    public S(int f)
    {
        _value = f;
    }

    public override int GetHashCode()
        => _value.GetHashCode();

    public override bool Equals(object other)
        => other is S otherS && Equals(otherS);

    public bool Equals(S other)
        => _value == other._value;
}

Uyarıların ne zaman bastırılması gerekiyor?

Arabirimin uygulanmasından elde edilir tasarım ve performans avantajları kritik değilse, bu kuraldaki ihlalleri engellemek güvenlidir.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Ayrıca bkz.