Baca dalam bahasa Inggris

Bagikan melalui

CA1030: Gunakan peristiwa jika perlu

  • Artikel
Properti Nilai
ID Aturan CA1030
Judul Gunakan peristiwa jika sesuai
Golongan Desain
Perbaikan bersifat disruptif atau non-disruptif Non-disruptif
Diaktifkan secara default di .NET 9 No

Penyebab

Nama metode dimulai dengan salah satu hal berikut:

  • AddOn
  • RemoveOn
  • Kebakaran
  • Naikkan

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

Deskripsi aturan

Aturan ini mendeteksi metode yang memiliki nama yang biasanya akan digunakan untuk peristiwa. Peristiwa mengikuti pola desain Observer atau Publish-Subscribe; mereka digunakan ketika perubahan status dalam satu objek harus dikomunikasikan ke objek lain. Jika metode dipanggil sebagai respons terhadap perubahan status yang ditentukan dengan jelas, metode harus dipanggil oleh penanganan aktivitas. Objek yang memanggil metode harus memunculkan peristiwa, bukan memanggil metode secara langsung.

Beberapa contoh umum peristiwa ditemukan di aplikasi antarmuka pengguna di mana tindakan pengguna seperti mengklik tombol menyebabkan segmen kode dijalankan. Model peristiwa .NET tidak terbatas pada antarmuka pengguna. Ini harus digunakan di mana saja Anda harus mengkomunikasikan perubahan status ke satu atau beberapa objek.

Cara memperbaiki pelanggaran

Jika metode dipanggil ketika status objek berubah, pertimbangkan untuk mengubah desain untuk menggunakan model peristiwa .NET.

Kapan harus menekan peringatan

Tekan peringatan dari aturan ini jika metode tidak berfungsi dengan model peristiwa .NET.

Menyembunyikan peringatan

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

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

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

ini 
[*.{cs,vb}]
dotnet_diagnostic.CA1030.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 (Desain) yang berlaku untuk aturan ini. 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:

ini 
dotnet_code_quality.CAXXXX.api_surface = private, internal

Catatan

Ganti bagian XXXXCAXXXX dengan ID aturan yang berlaku.