CA1815: Ganti sama dengan dan sama dengan operator pada jenis nilai

Penyebab

Jenis nilai tidak mengambil alih System.Object.Equals atau tidak mengimplementasikan operator kesetaraan (==). Aturan ini tidak memeriksa enumerasi.

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

Deskripsi aturan

Untuk jenis nilai yang tidak dapat di-blittable , implementasi Equals yang diwariskan menggunakan System.Reflection pustaka untuk membandingkan konten semua bidang. Refleksi memerlukan biaya komputasi yang mahal, dan membandingkan setiap bidang untuk kesetaraan mungkin tidak perlu. Jika Anda mengharapkan pengguna membandingkan atau mengurutkan instans, atau menggunakannya sebagai kunci tabel hash, jenis nilai Anda harus menerapkan Equals. Jika bahasa pemrograman Anda mendukung kelebihan beban operator, Anda juga harus menyediakan implementasi operator kesetaraan dan ketidaksetaraan.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, berikan implementasi .Equals Jika bisa, terapkan operator kesetaraan.

Kapan harus menekan peringatan

Aman untuk menekan peringatan dari aturan ini jika instans jenis nilai tidak akan dibandingkan satu sama lain.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1815.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.

• Menyertakan permukaan API tertentu

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

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian basis kode mana yang akan dijalankan aturan ini, berdasarkan aksesibilitasnya, dengan mengatur opsi api_surface. 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

Kode berikut menunjukkan struktur (jenis nilai) yang melanggar aturan ini:

// Violates this rule
public struct Point
{
    public Point(int x, int y)
    {
        X = x;
        Y = y;
    }

    public int X { get; }

    public int Y { get; }
}

Kode berikut memperbaiki pelanggaran sebelumnya dengan mengambil alih System.ValueType.Equals dan menerapkan operator kesetaraan (== dan !=):

public struct Point : IEquatable<Point>
{
    public Point(int x, int y)
    {
        X = x;
        Y = y;
    }

    public int X { get; }

    public int Y { get; }

    public override int GetHashCode()
    {
        return X ^ Y;
    }

    public override bool Equals(object? obj)
    {
        if (!(obj is Point))
            return false;

        return Equals((Point)obj);
    }

    public bool Equals(Point other)
    {
        if (X != other.X)
            return false;

        return Y == other.Y;
    }

    public static bool operator ==(Point point1, Point point2)
    {
        return point1.Equals(point2);
    }

    public static bool operator !=(Point point1, Point point2)
    {
        return !point1.Equals(point2);
    }
}

Aturan terkait

• CA2231: Sama dengan operator overload dalam mengganti ValueType.Equals
• CA2226: Operator harus memiliki overload simetris

Lihat juga

• System.Object.Equals