Bagikan melalui

CA1066: Menerapkan IEquatable saat mengganti Sama Dengan

  • Artikel
Properti Nilai
ID Aturan CA1066
Judul Terapkan IEquatable saat mengambil alih Sama dengan
Golongan Desain
Perbaikan bersifat disruptif atau non-disruptif Non-disruptif
Diaktifkan secara default di .NET 8 Tidak

Penyebab

Metode penimpaan Equals jenis nilai (struct), tetapi tidak mengimplementasikan IEquatable<T>.

Deskripsi aturan

Metode penimpaan Equals jenis nilai menunjukkan bahwa metode ini mendukung perbandingan dua instans jenis untuk kesetaraan nilai. Pertimbangkan untuk mengimplementasikan IEquatable<T> antarmuka untuk mendukung pengujian yang sangat di ketik untuk kesetaraan. Ini memastikan bahwa penelepon yang melakukan pemeriksaan kesetaraan memanggil metode yang diketik System.IEquatable<T>.Equals dengan kuat dan menghindari tinju argumen, meningkatkan performa. Untuk informasi selengkapnya, lihat di sini.

Implementasi Anda System.IEquatable<T>.Equals harus mengembalikan hasil yang konsisten dengan Equals.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran, terapkan IEquatable<T> dan perbarui Equals penimpaan untuk memanggil metode yang diterapkan ini. Misalnya, dua cuplikan kode berikut menunjukkan pelanggaran aturan dan cara memperbaikinya:

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;
}

Kapan harus menekan peringatan

Aman untuk menekan pelanggaran dari aturan ini jika desain dan keuntungan performa dari menerapkan antarmuka tidak penting.

Menyembunyikan peringatan

Jika Anda hanya ingin menyembunyikan satu pelanggaran, tambahkan arahan praprosedur ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturannya.

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

Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Baca juga