CA1064: Las excepciones deben ser públicas

Artículo
06/05/2023

Propiedad	Value
Identificador de la regla	CA1064
Título	Las excepciones deben ser públicas
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

Una excepción no pública deriva directamente de Exception, SystemException o ApplicationException.

Descripción de la regla

Una excepción interna solo es visible dentro de su propio ámbito interno. Cuando la excepción esté fuera del ámbito interno, sólo se podrá usar la excepción base para detectarla. Si la excepción interna se hereda de Exception, SystemException o ApplicationException, el código externo no tendrá información suficiente para saber qué hacer con la excepción.

Aun así, si el código tiene una excepción pública que se usa después como base para una excepción interna, es razonable dar por supuesto que más adelante el código podrá hacer algo inteligente con la excepción base. La excepción pública tendrá más información de la que proporciona Exception, SystemException o ApplicationException.

Cómo corregir infracciones

Haga que la excepción sea pública o derive la excepción interna de una excepción pública que no sea Exception, SystemException o ApplicationException.

Cuándo suprimir las advertencias

Suprima un mensaje de esta regla si está seguro en todos los casos de que la excepción privada se detectará dentro de su propio ámbito interno.

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

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.CA1064.severity = none

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

Ejemplo

Esta regla se desencadena en el primer método de ejemplo (FirstCustomException) porque la clase de excepción deriva directamente de Exception y es interna. La regla no se desencadena en la clase SecondCustomException porque, aunque la clase también deriva directamente de Exception, la clase se declara pública. La tercera clase tampoco desencadena la regla porque no deriva directamente de System.Exception, System.SystemException o System.ApplicationException.

// Violates this rule
[Serializable]
internal class FirstCustomException : Exception
{
    internal FirstCustomException()
    {
    }

    internal FirstCustomException(string message)
        : base(message)
    {
    }

    internal FirstCustomException(string message, Exception innerException)
        : base(message, innerException)
    {
    }

    protected FirstCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
    }
}

// Does not violate this rule because
// SecondCustomException is public
[Serializable]
public class SecondCustomException : Exception
{
    public SecondCustomException()
    {
    }

    public SecondCustomException(string message)
        : base(message)
    {

    }

    public SecondCustomException(string message, Exception innerException)
        : base(message, innerException)
    {
    }

    protected SecondCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
    }
}

// Does not violate this rule because
// ThirdCustomException it does not derive directly from
// Exception, SystemException, or ApplicationException
[Serializable]
internal class ThirdCustomException : SecondCustomException
{
    internal ThirdCustomException()
    {
    }

    internal ThirdCustomException(string message)
        : base(message)
    {
    }

    internal ThirdCustomException(string message, Exception innerException)
        : base(message, innerException)
    {
    }


    protected ThirdCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
    }
}

Compartir vía