Compartir a través de


CA1064: Las excepciones deben ser públicas

TypeName

ExceptionsShouldBePublic

Identificador de comprobación

CA1064

Categoría

Microsoft.Design

Cambio problemático

No

Motivo

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

Descripción de la regla

Una excepción interna sólo se ve 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 ella.

Sin embargo, si el código tiene una excepción pública que después se utiliza como base para una excepción interna, es razonable suponer que el código que está fuera del ámbito podría hacer algo inteligente con la excepción base.La excepción pública tendrá más información que T:System.Exception, T:System.SystemException o T:System.ApplicationException.

Cómo corregir infracciones

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

Cuándo suprimir advertencias

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

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 está declarada como pública.La tercera clase tampoco desencadena la regla porque no deriva directamente de Exception, SystemException o ApplicationException.

using System;
using System.Runtime.Serialization;

namespace Samples
{
    // 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)
        {
        }
    }
}