CA1032: Terapkan konstruktor pengecualian standar

Artikel
11/14/2023

Properti	Nilai
ID Aturan	CA1032
Judul	Terapkan konstruktor pengecualian standar
Golongan	Desain
Perbaikan bersifat disruptif atau non-disruptif	Non-disruptif
Diaktifkan secara default di .NET 8	Tidak

Penyebab

Jenis diperluas System.Exception tetapi tidak mendeklarasikan semua konstruktor yang diperlukan.

Deskripsi aturan

Jenis pengecualian harus menerapkan tiga konstruktor publik berikut:

NewException publik()
newexception publik(string)
NewException publik(string, Pengecualian)

Kegagalan untuk menyediakan kumpulan lengkap konstruktor dapat mempersulit dalam menangani pengecualian dengan benar. Misalnya, konstruktor yang memiliki tanda tangan NewException(string, Exception) digunakan untuk membuat pengecualian yang disebabkan oleh pengecualian lain. Tanpa konstruktor ini, Anda tidak dapat membuat dan melempar instans pengecualian kustom Anda yang berisi pengecualian dalam (berlapis), yang merupakan apa yang harus dilakukan kode terkelola dalam situasi seperti itu.

Untuk informasi selengkapnya, lihat CA2229: Menerapkan konstruktor serialisasi.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, tambahkan konstruktor yang hilang ke pengecualian, dan pastikan mereka memiliki aksesibilitas yang benar.

Kapan harus menekan peringatan

Aman untuk menekan peringatan dari aturan ini ketika pelanggaran disebabkan oleh penggunaan tingkat akses yang berbeda untuk konstruktor publik.

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

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Contoh

Contoh berikut berisi jenis pengecualian yang melanggar aturan ini dan jenis pengecualian yang diimplementasikan dengan benar.

// Violates rule ImplementStandardExceptionConstructors.
public class BadException : Exception
{
    public BadException()
    {
        // Add any type-specific logic, and supply the default message.
    }
}

[Serializable()]
public class GoodException : Exception
{
    public GoodException()
    {
        // Add any type-specific logic, and supply the default message.
    }

    public GoodException(string message) : base(message)
    {
        // Add any type-specific logic.
    }

    public GoodException(string message, Exception innerException) :
       base(message, innerException)
    {
        // Add any type-specific logic for inner exceptions.
    }
}

Bagikan melalui