CA1032: Implementar constructores de excepción estándar

Artículo
09/07/2023

Propiedad	Value
Identificador de la regla	CA1032
Título	Implementar constructores de excepción estándar
Categoría	Diseño
La corrección es problemática o no problemática	Poco problemático
Habilitado de forma predeterminada en .NET 8	No

Causa

Un tipo extiende System.Exception, pero no declara todos los constructores necesarios.

Descripción de la regla

Los tipos de excepción deben implementar los tres constructores públicos siguientes:

public NewException()
public NewException(string)
public NewException(string, Exception)

El error al proporcionar el conjunto completo de constructores puede dificultar el control correcto de las excepciones. Por ejemplo, el constructor que tiene la firma NewException(string, Exception) se usa para crear excepciones provocadas por otras excepciones. Sin este constructor, no se puede crear y producir una instancia de la excepción personalizada que contiene una excepción interna (anidada), que es lo que debe hacer el código administrado en esta situación.

Para obtener información adicional, consulte CA2229: Implementar constructores de serialización.

Cómo corregir infracciones

Para corregir una infracción de esta regla, agregue los constructores que faltan a la excepción y asegúrese de que tienen la accesibilidad correcta.

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia de esta regla cuando la infracción se produce mediante el uso de un nivel de acceso diferente para los constructores públicos.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Ejemplo

El ejemplo siguiente contiene un tipo de excepción que infringe esta regla y un tipo de excepción que se ha implementado correctamente.

// 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.
    }
}

Consulte también

CA2229: Implementar constructores de serialización