Bagikan melalui

CA2231: Sama dengan operator overload dalam mengganti ValueType.Equals

  • Artikel
Properti Nilai
ID Aturan CA2231
Judul Operator kelebihan beban sama dengan menimpa ValueType.Equals
Golongan Penggunaan
Perbaikan bersifat disruptif atau non-disruptif Non-disruptif
Diaktifkan secara default di .NET 8 Sebagai saran

Penyebab

Jenis nilai mengambil System.Object.Equals alih tetapi tidak mengimplementasikan operator kesetaraan.

Secara default, aturan ini hanya melihat jenis yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Dalam sebagian besar bahasa pemrograman, tidak ada implementasi default operator kesetaraan (==) untuk jenis nilai. Jika bahasa pemrograman Anda mendukung kelebihan beban operator, Anda harus mempertimbangkan untuk menerapkan operator kesetaraan. Perilakunya harus identik dengan Equals.

Anda tidak dapat menggunakan operator kesetaraan default dalam penerapan operator kesetaraan yang kelebihan beban. Melakukannya akan menyebabkan luapan tumpukan. Untuk menerapkan operator kesetaraan, gunakan metode Object.Equals dalam penerapan Anda. Misalnya:

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

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, terapkan operator kesetaraan.

Kapan harus menekan peringatan

Aman untuk menekan peringatan dari aturan ini; namun, kami sarankan Anda menyediakan operator kesetaraan jika memungkinkan.

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 CA2231
// The code that's violating the rule is on this line.
#pragma warning restore CA2231

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Mengonfigurasi kode yang akan dianalisis

Gunakan opsi berikut untuk mengonfigurasi bagian mana dari codebase Anda yang akan menjalankan aturan ini.

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Penggunaan) yang diterapkannya. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian mana dari basis kode yang akan menjalankan aturan ini, berdasarkan aksesibilitasnya. Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Contoh

Contoh berikut mendefinisikan jenis yang melanggar aturan ini:

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

Baca juga