CA1802: Gunakan Harfiah Jika Sesuai

Artikel
09/06/2023

Properti	Nilai
ID Aturan	CA1802
Judul	Gunakan Literal Jika Sesuai
Golongan	Performa
Perbaikan bersifat disruptif atau non-disruptif	Non-disruptif
Diaktifkan secara default di .NET 8	Tidak

Penyebab

Bidang dideklarasikan static dan readonly (Shared dan ReadOnly di Visual Basic), serta diinisialisasi dengan nilai yang dapat dihitung pada waktu kompilasi.

Secara default, aturan ini hanya melihat bidang yang terlihat secara eksternal, statik, baca-saja, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Nilai bidang static readonly dihitung pada run-time ketika konstruktor statik untuk jenis deklarasi dipanggil. Jika bidang static readonly diinisialisasi ketika dideklarasikan dan konstruktor statik tidak dideklarasikan secara eksplisit, pengompilasi memancarkan konstruktor statik untuk menginisialisasi bidang.

Nilai const bidang dihitung pada waktu kompilasi dan disimpan dalam metadata, yang meningkatkan performa run-time ketika dibandingkan static readonly dengan bidang.

Karena nilai yang ditetapkan ke bidang yang ditargetkan dapat dihitung pada waktu kompilasi, ubah deklarasi ke bidang const sehingga nilai dihitung pada waktu kompilasi, bukan saat run-time.

Cara memperbaiki pelanggaran

Untuk memperbaiki aturan ini, ganti pengubah static dan readonly dengan pengubah const.

Catatan

Penggunaan pengubah const tidak disarankan untuk semua skenario.

Kapan harus menekan peringatan

Aman untuk menyembunyikan peringatan dari aturan ini, atau menonaktifkan aturan, jika performa tidak menjadi perhatian.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1802.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
Pengubah yang diperlukan

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Performa) yang berlaku untuknya. 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

Pengubah yang diperlukan

Anda dapat mengonfigurasi aturan ini untuk mengambil alih pengubah bidang yang diperlukan. Secara default, static dan readonly keduanya merupakan pengubah yang diperlukan untuk bidang yang dianalisis. Anda dapat mengambil alih ini ke daftar yang dipisahkan koma yang tercantum dari salah satu atau beberapa nilai pengubah dari tabel di bawah:

Nilai Opsi	Ringkasan
`none`	Tidak ada persyaratan pengubah.
`static` atau `Shared`	Harus dideklarasikan sebagai 'static' ('Dibagikan' di Visual Basic).
`const`	Harus dideklarasikan sebagai 'const'.
`readonly`	Harus dideklarasikan sebagai 'readonly'.

Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada bidang instans dan statik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CA1802.required_modifiers = none

Contoh

Contoh berikut menunjukkan jenis, UseReadOnly, yang melanggar aturan dan jenis, UseConstant, yang mematuhi aturan.

Imports System

Namespace ca1802

    ' This class violates the rule.
    Public Class UseReadOnly

        Shared ReadOnly x As Integer = 3
        Shared ReadOnly y As Double = x + 2.1
        Shared ReadOnly s As String = "readonly"

    End Class

    ' This class satisfies the rule.
    Public Class UseConstant

        Const x As Integer = 3
        Const y As Double = x + 2.1
        Const s As String = "const"

    End Class

End Namespace

// This class violates the rule.
public class UseReadOnly
{
    static readonly int x = 3;
    static readonly double y = x + 2.1;
    static readonly string s = "readonly";

    public void Print()
    {
        Console.WriteLine(s);
    }
}

// This class satisfies the rule.
public class UseConstant
{
    const int x = 3;
    const double y = x + 2.1;
    const string s = "const";
}

Bagikan melalui