CA1506: Hindari penggabungan kelas yang berlebihan

Artikel
09/06/2023

Properti	Nilai
ID Aturan	CA1506
Judul	Hindari konektor kelas yang berlebihan
Golongan	Kemampu
Perbaikan bersifat disruptif atau non-disruptif	Merusak
Ambang default	Jenis: 95 Simbol lainnya: 40
Diaktifkan secara default di .NET 8	Tidak

Penyebab

Jenis, metode, bidang, properti, atau peristiwa digabungkan dengan banyak jenis lainnya. Jenis yang dihasilkan kompilator dikecualikan dari metrik ini.

Deskripsi aturan

Aturan ini mengukur kopling kelas dengan menghitung jumlah referensi jenis unik yang dimuat jenis, metode, bidang, properti, atau peristiwa. Ambang kopling default adalah 95 untuk jenis dan 40 untuk jenis simbol lainnya, dan ambang batas dapat dikonfigurasi.

Jenis, metode, dan simbol lain yang memiliki tingkat kopling kelas yang tinggi bisa sulit dipertahankan. Ini adalah praktik yang baik untuk memiliki jenis, metode, dan simbol lain yang menunjukkan kopling rendah dan kohesi tinggi.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran ini, coba desain ulang jenis atau metode untuk mengurangi jumlah jenis yang digabungkan.

Kapan harus menekan peringatan

Anda dapat menekan peringatan ini ketika jenis atau metode dianggap dapat dipertahankan meskipun banyak dependensi pada jenis lain.

Catatan

Anda mungkin melihat peringatan positif palsu dari aturan ini jika semua hal berikut ini berlaku:

Anda menggunakan Visual Studio 2022 versi 17.5 atau yang lebih baru dengan versi .NET SDK yang lebih lama, yaitu, .NET 6 atau yang lebih lama.
Anda menggunakan penganalisis dari .NET 6 SDK atau versi paket penganalisis yang lebih lama, seperti Microsoft.CodeAnalysis.FxCopAnalyzers.

Positif palsu disebabkan oleh perubahan yang melanggar dalam pengkompilasi C#. Pertimbangkan untuk menggunakan penganalisis yang lebih baru yang berisi perbaikan untuk peringatan positif palsu. Tingkatkan ke Microsoft.CodeAnalysis.NetAnalyzers versi 7.0.0-preview1.22464.1 atau yang lebih baru atau gunakan penganalisis dari .NET 7 SDK.

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

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Mengonfigurasi ambang batas

Anda dapat mengonfigurasi ambang di mana aturan ini diaktifkan dan jenis simbol untuk dianalisis. Jenis simbol yang diizinkan adalah:

Assembly
Namespace
Type
Method
Field
Event
Property

Buat file teks bernama CodeMetricsConfig.txt.
Tambahkan ambang yang diinginkan ke file teks dalam format berikut:
```
CA1506(Method): 60
CA1506(Type): 120
```
Dalam contoh ini, aturan dikonfigurasi untuk diaktifkan ketika metode memiliki lebih dari 60 referensi jenis unik atau jenis memiliki lebih dari 120 referensi jenis unik. Dengan file konfigurasi ini, aturan akan terus menandai bidang, properti, dan peristiwa yang kopling kelasnya lebih besar dari ambang default (40).
Dalam file proyek, tandai tindakan build file konfigurasi sebagai AdditionalFiles. Contohnya:
```
<ItemGroup>
  <AdditionalFiles Include="CodeMetricsConfig.txt" />
</ItemGroup>
```

Bagikan melalui