CA1032: Terapkan konstruktor pengecualian standar

Properti Nilai
ID Aturan CA1032
Judul Terapkan konstruktor pengecualian standar
Kategori Desain
Perbaikan bersifat merusak atau tidak merusak Tidak terputus
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Tipe memperluas System.Exception tetapi tidak mendeklarasikan semua konstruktor yang dibutuhkan.

Deskripsi aturan

Jenis pengecualian harus menerapkan tiga konstruktor publik berikut:

  • publik NewException()

  • publik NewException(string)

  • public NewException(string, Exception)

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

Anda dapat dengan aman menekan peringatan dari aturan ini jika 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.
    }
}

Lihat juga

CA2229: Menerapkan konstruktor serialisasi