CA1051: Jangan nyatakan bidang instans yang terlihat

Properti Nilai
ID Aturan CA1051
Judul Jangan nyatakan bidang instans yang terlihat
Kategori Desain
Perbaikan bersifat merusak atau tidak merusak Merusak
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Jenis memiliki bidang instans non-privat.

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

Deskripsi aturan

Penggunaan utama dari suatu field harus sebagai detail implementasi. Bidang harus private atau internal dan harus ditampilkan dengan menggunakan properti. Sangat mudah untuk mengakses properti seperti halnya mengakses bidang, dan kode di aksesor properti dapat berubah saat fitur jenis diperluas tanpa memperkenalkan perubahan yang melanggar.

Properti yang hanya mengembalikan nilai dari bidang privat atau internal dioptimalkan agar setara dengan mengakses bidang; keuntungan performa dari menggunakan bidang yang terlihat secara eksternal dibandingkan dengan properti sangat minimal. Terlihat dari luar mengacu pada tingkat aksesibilitas public, protected, dan protected internal (Public, Protected, dan Protected Friend di Visual Basic).

Selain itu, bidang publik tidak dapat dilindungi oleh permintaan link. (Permintaan tautan tidak berlaku untuk aplikasi .NET Core.)

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, buat bidang private atau internal dan ekspos dengan menggunakan properti yang terlihat secara eksternal.

Kapan harus menekan peringatan

Hanya tekan peringatan ini jika Anda yakin bahwa konsumen memerlukan akses langsung ke lapangan. Untuk sebagian besar aplikasi, bidang yang diekspos tidak memberikan keuntungan performa atau ketahanan atas properti.

Konsumen mungkin memerlukan akses lapangan dalam situasi berikut:

  • Di kontrol isi ASP.NET Web Forms.
  • Ketika platform target memanfaatkan ref untuk memodifikasi field, seperti kerangka kerja model-view-viewmodel (MVVM) untuk WPF dan UWP.

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

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Menyertakan atau mengecualikan API

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, atau untuk semua aturan dalam kategori ini (Desain) 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

Nota

Ganti bagian XXXXCAXXXX dengan ID aturan yang berlaku.

Mengecualikan struct

Anda dapat mengecualikan struct bidang (Structure di Visual Basic) agar tidak dianalisis.

dotnet_code_quality.ca1051.exclude_structs = true

Contoh

Contoh berikut menunjukkan jenis (BadPublicInstanceFields) yang melanggar aturan ini. GoodPublicInstanceFields menunjukkan kode yang dikoreksi.

public class BadPublicInstanceFields
{
    // Violates rule DoNotDeclareVisibleInstanceFields.
    public int instanceData = 32;
}

public class GoodPublicInstanceFields
{
    public int InstanceData { get; set; } = 32;
}

Lihat juga

  • Last updated on