Partilhar via


Classe System.Exception

Este artigo fornece observações complementares à documentação de referência para esta API.

A classe Exception é a classe base para todas as exceções. Quando ocorre um erro, o sistema ou o aplicativo em execução o relata lançando uma exceção que contém informações sobre o erro. Depois que uma exceção é lançada, ela é manipulada pelo aplicativo ou pelo manipulador de exceção padrão.

Erros e exceções

Erros em tempo de execução podem ocorrer por vários motivos. No entanto, nem todos os erros devem ser tratados como exceções no seu código. Aqui estão algumas categorias de erros que podem ocorrer em tempo de execução e as maneiras apropriadas de respondê-los.

  • Erros de utilização. Um erro de uso representa um erro na lógica do programa que pode resultar em uma exceção. No entanto, o erro deve ser resolvido não através do tratamento de exceções, mas modificando o código defeituoso. Por exemplo, a substituição do método Object.Equals(Object) no exemplo a seguir pressupõe que o argumento obj sempre deve ser não-nulo.

    using System;
    
    public class Person1
    {
       private string _name;
    
       public string Name
       {
          get { return _name; }
          set { _name = value; }
       }
    
       public override int GetHashCode()
       {
          return this.Name.GetHashCode();
       }
    
       public override bool Equals(object obj)
       {
          // This implementation contains an error in program logic:
          // It assumes that the obj argument is not null.
          Person1 p = (Person1) obj;
          return this.Name.Equals(p.Name);
       }
    }
    
    public class UsageErrorsEx1
    {
       public static void Main()
       {
          Person1 p1 = new Person1();
          p1.Name = "John";
          Person1 p2 = null;
    
          // The following throws a NullReferenceException.
          Console.WriteLine($"p1 = p2: {p1.Equals(p2)}");
       }
    }
    
    // In F#, null is not a valid state for declared types 
    // without 'AllowNullLiteralAttribute'
    [<AllowNullLiteral>]
    type Person() =
        member val Name = "" with get, set
    
        override this.GetHashCode() =
            this.Name.GetHashCode()
    
        override this.Equals(obj) =
            // This implementation contains an error in program logic:
            // It assumes that the obj argument is not null.
            let p = obj :?> Person
            this.Name.Equals p.Name
    
    let p1 = Person()
    p1.Name <- "John"
    let p2: Person = null
    
    // The following throws a NullReferenceException.
    printfn $"p1 = p2: {p1.Equals p2}"
    
    Public Class Person
       Private _name As String
       
       Public Property Name As String
          Get
             Return _name
          End Get
          Set
             _name = value
          End Set
       End Property
       
       Public Overrides Function Equals(obj As Object) As Boolean
          ' This implementation contains an error in program logic:
          ' It assumes that the obj argument is not null.
          Dim p As Person = CType(obj, Person)
          Return Me.Name.Equals(p.Name)
       End Function
    End Class
    
    Module Example2
        Public Sub Main()
            Dim p1 As New Person()
            p1.Name = "John"
            Dim p2 As Person = Nothing
    
            ' The following throws a NullReferenceException.
            Console.WriteLine("p1 = p2: {0}", p1.Equals(p2))
        End Sub
    End Module
    

    A exceção NullReferenceException que resulta quando obj é null pode ser eliminada ao modificar o código-fonte para verificar explicitamente a existência de valores nulos antes de chamar a substituição de Object.Equals e, em seguida, recompilar. O exemplo a seguir contém o código-fonte corrigido que manipula um argumento null.

    using System;
    
    public class Person2
    {
        private string _name;
    
        public string Name
        {
            get { return _name; }
            set { _name = value; }
        }
    
        public override int GetHashCode()
        {
            return this.Name.GetHashCode();
        }
    
        public override bool Equals(object obj)
        {
            // This implementation handles a null obj argument.
            Person2 p = obj as Person2;
            if (p == null)
                return false;
            else
                return this.Name.Equals(p.Name);
        }
    }
    
    public class UsageErrorsEx2
    {
        public static void Main()
        {
            Person2 p1 = new Person2();
            p1.Name = "John";
            Person2 p2 = null;
    
            Console.WriteLine($"p1 = p2: {p1.Equals(p2)}");
        }
    }
    // The example displays the following output:
    //        p1 = p2: False
    
    // In F#, null is not a valid state for declared types 
    // without 'AllowNullLiteralAttribute'
    [<AllowNullLiteral>]
    type Person() =
        member val Name = "" with get, set
    
        override this.GetHashCode() =
            this.Name.GetHashCode()
    
        override this.Equals(obj) =
            // This implementation handles a null obj argument.
            match obj with
            | :? Person as p -> 
                this.Name.Equals p.Name
            | _ ->
                false
    
    let p1 = Person()
    p1.Name <- "John"
    let p2: Person = null
    
    printfn $"p1 = p2: {p1.Equals p2}"
    // The example displays the following output:
    //        p1 = p2: False
    
    Public Class Person2
        Private _name As String
    
        Public Property Name As String
            Get
                Return _name
            End Get
            Set
                _name = Value
            End Set
        End Property
    
        Public Overrides Function Equals(obj As Object) As Boolean
            ' This implementation handles a null obj argument.
            Dim p As Person2 = TryCast(obj, Person2)
            If p Is Nothing Then
                Return False
            Else
                Return Me.Name.Equals(p.Name)
            End If
        End Function
    End Class
    
    Module Example3
        Public Sub Main()
            Dim p1 As New Person2()
            p1.Name = "John"
            Dim p2 As Person2 = Nothing
    
            Console.WriteLine("p1 = p2: {0}", p1.Equals(p2))
        End Sub
    End Module
    ' The example displays the following output:
    '       p1 = p2: False
    

    Em vez de usar o tratamento de exceções para erros de uso, você pode usar o método Debug.Assert para identificar erros de uso em compilações de depuração e o método Trace.Assert para identificar erros de uso em compilações de depuração e versão. Para obter mais informações, consulte asserções no código gerenciado.

  • Erros de programa. Um erro de programa é um erro em tempo de execução que não pode ser necessariamente evitado escrevendo código livre de bugs.

    Em alguns casos, um erro de programa pode refletir uma condição de erro esperada ou de rotina. Nesse caso, você pode querer evitar o uso de manipulação de exceção para lidar com o erro do programa e, em vez disso, tente novamente a operação. Por exemplo, se se espera que o usuário insira uma data em um formato específico, você pode analisar a cadeia de caracteres de data chamando o método DateTime.TryParseExact, que retorna um valor Boolean que indica se a operação de análise foi bem-sucedida, em vez de usar o método DateTime.ParseExact, que lança uma exceção FormatException se a cadeia de caracteres de data não puder ser convertida em um valor DateTime. Da mesma forma, se um usuário tentar abrir um arquivo que não existe, você pode primeiro chamar o método File.Exists para verificar se o arquivo existe e, se não existir, perguntar ao usuário se ele deseja criá-lo.

    Em outros casos, um erro de programa reflete uma condição de erro inesperada que pode ser manipulada em seu código. Por exemplo, mesmo que você tenha verificado se um arquivo existe, ele pode ser excluído antes que você possa abri-lo ou pode estar corrompido. Nesse caso, tentar abrir o arquivo instanciando um objeto StreamReader ou chamando o método Open pode lançar uma exceção FileNotFoundException. Nesses casos, você deve usar o tratamento de exceções para se recuperar do erro.

  • Falhas do sistema. Uma falha do sistema é um erro em tempo de execução que não pode ser tratado programaticamente de forma significativa. Por exemplo, qualquer método pode lançar uma exceção OutOfMemoryException se o Common Language Runtime não conseguir alocar memória adicional. Normalmente, as falhas do sistema não são tratadas usando o tratamento de exceções. Em vez disso, você poderá usar um evento como AppDomain.UnhandledException e chamar o método Environment.FailFast para registrar informações de exceção e notificar o usuário sobre a falha antes que o aplicativo seja encerrado.

Tentar/pegar blocos

O Common Language Runtime fornece um modelo de tratamento de exceções que se baseia na representação de exceções como objetos e na separação do código do programa e do código de tratamento de exceções em blocos try e catch blocos. Pode haver um ou mais blocos catch, cada um projetado para lidar com um tipo específico de exceção, ou um bloco projetado para capturar uma exceção mais específica do que outro bloco.

Se um aplicativo manipula exceções que ocorrem durante a execução de um bloco de código de aplicativo, o código deve ser colocado dentro de uma instrução try e é chamado de bloco try. O código do aplicativo que lida com exceções lançadas por um bloco try é colocado dentro de uma instrução catch e é chamado de bloco catch. Zero ou mais blocos catch são associados a um bloco try e cada bloco catch inclui um filtro de tipo que determina os tipos de exceções que ele manipula.

Quando ocorre uma exceção em um bloco try, o sistema pesquisa os blocos de catch associados na ordem em que aparecem no código do aplicativo, até localizar um bloco catch que manipula a exceção. Um bloco catch manipula uma exceção do tipo T se o filtro de tipo do bloco de captura especificar T ou qualquer tipo do qual T deriva. O sistema para de procurar depois de encontrar o primeiro bloco catch que lida com a exceção. Por esse motivo, no código do aplicativo, um bloco catch que manipula um tipo deve ser especificado antes de um bloco catch que manipula seus tipos base, conforme demonstrado no exemplo a seguir nesta seção. Um bloco de captura que lida com System.Exception é especificado por último.

Se nenhum dos blocos de catch associados ao bloco try atual manipular a exceção, e o bloco try atual estiver aninhado dentro de outros blocos de try na chamada atual, os blocos de catch associados ao próximo bloco de try envolvente serão pesquisados. Se não for encontrado nenhum bloco catch para a exceção, o sistema procurará nos níveis de aninhamento anteriores da chamada atual. Se nenhum bloco de catch para a exceção for encontrado na chamada atual, a exceção será passada para cima na pilha de chamadas e o quadro de pilha anterior será pesquisado por um bloco de catch que manipule a exceção. A pesquisa da pilha de chamadas continua até que a exceção seja tratada ou até que não existam mais quadros na pilha de chamadas. Se a parte superior da pilha de chamadas for alcançada sem encontrar um bloco de catch que manipule a exceção, o manipulador de exceção padrão a manipulará e o aplicativo será encerrado.

F# tentar.. com expressão

F# não usa blocos catch. Em vez disso, uma exceção levantada é correspondida ao padrão usando um único bloco with. Como esta é uma expressão, em vez de uma instrução, todos os caminhos devem retornar o mesmo tipo. Para saber mais, consulte A tentativa... com Expressão.

Características de tipos de exceção

Os tipos de exceção suportam os seguintes recursos:

  • Texto legível por humanos que descreve o erro. Quando ocorre uma exceção, o tempo de execução disponibiliza uma mensagem de texto para informar o usuário sobre a natureza do erro e sugerir ações para resolver o problema. Essa mensagem de texto é mantida na propriedade Message do objeto de exceção. Durante a criação do objeto de exceção, você pode passar uma cadeia de caracteres de texto para o construtor para descrever os detalhes dessa exceção específica. Se nenhum argumento de mensagem de erro for fornecido ao construtor, a mensagem de erro padrão será usada. Para obter mais informações, consulte a propriedade Message.

  • O estado da pilha de chamadas quando a exceção foi lançada. A propriedade StackTrace carrega um rastreamento de pilha que pode ser usado para determinar onde o erro ocorre no código. O rastreamento de pilha lista todos os métodos chamados e os números de linha no arquivo de origem onde as chamadas são feitas.

Propriedades da classe de exceção

A classe Exception inclui várias propriedades que ajudam a identificar o local do código, o tipo, o arquivo de ajuda e o motivo da exceção: StackTrace, InnerException, Message, HelpLink, HResult, Source, TargetSitee Data.

Quando existe uma relação causal entre duas ou mais exceções, a propriedade InnerException mantém essa informação. A exceção externa é lançada em resposta a essa exceção interna. O código que manipula a exceção externa pode usar as informações da exceção interna anterior para lidar com o erro de forma mais adequada. Informações suplementares sobre a exceção podem ser armazenadas como uma coleção de pares chave/valor na propriedade Data.

A cadeia de caracteres de mensagem de erro que é passada para o construtor durante a criação do objeto de exceção deve ser localizada e pode ser fornecida a partir de um arquivo de recurso usando a classe ResourceManager. Para obter mais informações sobre recursos localizados, consulte os tópicos Criação de assemblies satélite e Empacotamento e implantação de recursos.

Para fornecer ao usuário informações abrangentes sobre por que a exceção ocorreu, a propriedade HelpLink pode conter uma URL (ou URN) para um arquivo de ajuda.

A classe Exception usa o COR_E_EXCEPTIONHRESULT , que tem o valor 0x80131500.

Para obter uma lista de valores de propriedade inicial para uma instância da classe Exception, consulte os construtores Exception.

Considerações sobre desempenho

Lançar ou manipular uma exceção consome uma quantidade significativa de recursos do sistema e tempo de execução. Lance exceções apenas para lidar com condições verdadeiramente extraordinárias, não para lidar com eventos previsíveis ou controle de fluxo. Por exemplo, em alguns casos, como quando você está desenvolvendo uma biblioteca de classes, é razoável lançar uma exceção se um argumento de método for inválido, porque você espera que seu método seja chamado com parâmetros válidos. Um argumento de método inválido, se não for o resultado de um erro de uso, significa que algo extraordinário ocorreu. Por outro lado, não lance uma exceção se a entrada do usuário for inválida, porque você pode esperar que os usuários ocasionalmente insiram dados inválidos. Em vez disso, forneça um mecanismo de repetição para que os usuários possam inserir entradas válidas. Também não deve usar exceções para lidar com erros de uso. Em vez disso, use asserções para identificar e corrigir erros de uso.

Além disso, não lance uma exceção quando um código de retorno for suficiente; não converta um código de retorno numa exceção; e não capture rotineiramente uma exceção, ignore-a e, em seguida, continue o processamento.

Relançar uma exceção

Em muitos casos, um manipulador de exceção simplesmente deseja passar a exceção para o chamador. Isto ocorre mais frequentemente em:

  • Uma biblioteca de classes que, por sua vez, encapsula chamadas para métodos na biblioteca de classes .NET ou outras bibliotecas de classes.

  • Um aplicativo ou biblioteca que encontra uma exceção fatal. O manipulador de exceções pode registrar a exceção e, em seguida, relançá-la.

A maneira recomendada de relançar uma exceção é simplesmente usar a instrução throw em C#, a função reraise em F# e a instrução Throw no Visual Basic sem incluir uma expressão. Isso garante que todas as informações da pilha de chamadas sejam preservadas quando a exceção for propagada para o chamador. O exemplo a seguir ilustra isso. Um método de extensão de cadeia de caracteres, FindOccurrences, encapsula uma ou mais chamadas para String.IndexOf(String, Int32) sem validar seus argumentos previamente.

using System;
using System.Collections.Generic;

public static class Library1
{
    public static int[] FindOccurrences(this String s, String f)
    {
        var indexes = new List<int>();
        int currentIndex = 0;
        try
        {
            while (currentIndex >= 0 && currentIndex < s.Length)
            {
                currentIndex = s.IndexOf(f, currentIndex);
                if (currentIndex >= 0)
                {
                    indexes.Add(currentIndex);
                    currentIndex++;
                }
            }
        }
        catch (ArgumentNullException)
        {
            // Perform some action here, such as logging this exception.

            throw;
        }
        return indexes.ToArray();
    }
}
open System

module Library = 
    let findOccurrences (s: string) (f: string) =
        let indexes = ResizeArray()
        let mutable currentIndex = 0
        try
            while currentIndex >= 0 && currentIndex < s.Length do
                currentIndex <- s.IndexOf(f, currentIndex)
                if currentIndex >= 0 then
                    indexes.Add currentIndex
                    currentIndex <- currentIndex + 1
        with :? ArgumentNullException ->
            // Perform some action here, such as logging this exception.
            reraise ()
        indexes.ToArray()
Imports System.Collections.Generic
Imports System.Runtime.CompilerServices

Public Module Library
    <Extension()>
    Public Function FindOccurrences1(s As String, f As String) As Integer()
        Dim indexes As New List(Of Integer)
        Dim currentIndex As Integer = 0
        Try
            Do While currentIndex >= 0 And currentIndex < s.Length
                currentIndex = s.IndexOf(f, currentIndex)
                If currentIndex >= 0 Then
                    indexes.Add(currentIndex)
                    currentIndex += 1
                End If
            Loop
        Catch e As ArgumentNullException
            ' Perform some action here, such as logging this exception.

            Throw
        End Try
        Return indexes.ToArray()
    End Function
End Module

Em seguida, um chamador liga duas vezes para o FindOccurrences. Na segunda chamada para FindOccurrences, o chamador passa um null como a cadeia de caracteres de pesquisa, o que faz com que o método String.IndexOf(String, Int32) lance uma exceção ArgumentNullException. Essa exceção é tratada pelo método FindOccurrences e passada de volta para o chamador. Como a instrução throw é usada sem expressão, a saída do exemplo mostra que a pilha de chamadas é preservada.

public class RethrowEx1
{
    public static void Main()
    {
        String s = "It was a cold day when...";
        int[] indexes = s.FindOccurrences("a");
        ShowOccurrences(s, "a", indexes);
        Console.WriteLine();

        String toFind = null;
        try
        {
            indexes = s.FindOccurrences(toFind);
            ShowOccurrences(s, toFind, indexes);
        }
        catch (ArgumentNullException e)
        {
            Console.WriteLine($"An exception ({e.GetType().Name}) occurred.");
            Console.WriteLine($"Message:{Environment.NewLine}   {e.Message}{Environment.NewLine}");
            Console.WriteLine($"Stack Trace:{Environment.NewLine}   {e.StackTrace}{Environment.NewLine}");
        }
    }

    private static void ShowOccurrences(String s, String toFind, int[] indexes)
    {
        Console.Write("'{0}' occurs at the following character positions: ",
                      toFind);
        for (int ctr = 0; ctr < indexes.Length; ctr++)
            Console.Write("{0}{1}", indexes[ctr],
                          ctr == indexes.Length - 1 ? "" : ", ");

        Console.WriteLine();
    }
}
// The example displays the following output:
//    'a' occurs at the following character positions: 4, 7, 15
//
//    An exception (ArgumentNullException) occurred.
//    Message:
//       Value cannot be null.
//    Parameter name: value
//
//    Stack Trace:
//          at System.String.IndexOf(String value, Int32 startIndex, Int32 count, Stri
//    ngComparison comparisonType)
//       at Library.FindOccurrences(String s, String f)
//       at Example.Main()
open Library

let showOccurrences toFind (indexes: int[]) =
    printf $"'{toFind}' occurs at the following character positions: "
    for i = 0 to indexes.Length - 1 do
        printf $"""{indexes[i]}{if i = indexes.Length - 1 then "" else ", "}"""
    printfn ""

let s = "It was a cold day when..."
let indexes = findOccurrences s "a"
showOccurrences "a" indexes
printfn ""

let toFind: string = null
try
    let indexes = findOccurrences s toFind
    showOccurrences toFind indexes

with :? ArgumentNullException as e ->
    printfn $"An exception ({e.GetType().Name}) occurred."
    printfn $"Message:\n   {e.Message}\n"
    printfn $"Stack Trace:\n   {e.StackTrace}\n"

// The example displays the following output:
//    'a' occurs at the following character positions: 4, 7, 15
//
//    An exception (ArgumentNullException) occurred.
//    Message:
//       Value cannot be null. (Parameter 'value')
//
//    Stack Trace:
//          at System.String.IndexOf(String value, Int32 startIndex, Int32 count, Stri
//    ngComparison comparisonType)
//       at Library.findOccurrences(String s, String f)
//       at <StartupCode$fs>.main@()
Module Example1
    Public Sub Main()
        Dim s As String = "It was a cold day when..."
        Dim indexes() As Integer = s.FindOccurrences1("a")
        ShowOccurrences(s, "a", indexes)
        Console.WriteLine()

        Dim toFind As String = Nothing
        Try
            indexes = s.FindOccurrences1(toFind)
            ShowOccurrences(s, toFind, indexes)
        Catch e As ArgumentNullException
            Console.WriteLine("An exception ({0}) occurred.",
                           e.GetType().Name)
            Console.WriteLine("Message:{0}   {1}{0}", vbCrLf, e.Message)
            Console.WriteLine("Stack Trace:{0}   {1}{0}", vbCrLf, e.StackTrace)
        End Try
    End Sub

    Private Sub ShowOccurrences(s As String, toFind As String, indexes As Integer())
        Console.Write("'{0}' occurs at the following character positions: ",
                    toFind)
        For ctr As Integer = 0 To indexes.Length - 1
            Console.Write("{0}{1}", indexes(ctr),
                       If(ctr = indexes.Length - 1, "", ", "))
        Next
        Console.WriteLine()
    End Sub
End Module
' The example displays the following output:
'    'a' occurs at the following character positions: 4, 7, 15
'
'    An exception (ArgumentNullException) occurred.
'    Message:
'       Value cannot be null.
'    Parameter name: value
'
'    Stack Trace:
'          at System.String.IndexOf(String value, Int32 startIndex, Int32 count, Stri
'    ngComparison comparisonType)
'       at Library.FindOccurrences(String s, String f)
'       at Example.Main()

Em contraste, se a exceção for relançada usando esta instrução:

throw e;
Throw e
raise e

... Em seguida, a pilha de chamadas completa não é preservada e o exemplo geraria a seguinte saída:

'a' occurs at the following character positions: 4, 7, 15

An exception (ArgumentNullException) occurred.
Message:
   Value cannot be null.
Parameter name: value

Stack Trace:
      at Library.FindOccurrences(String s, String f)
   at Example.Main()

Uma alternativa um pouco mais complicada é lançar uma nova exceção e preservar as informações da pilha de chamadas da exceção original em uma exceção interna. O chamador pode então usar a propriedade InnerException da nova exceção para recuperar o quadro da pilha e outras informações sobre a exceção original. Neste caso, a instrução throw é:

throw new ArgumentNullException("You must supply a search string.", e);
raise (ArgumentNullException("You must supply a search string.", e) )
Throw New ArgumentNullException("You must supply a search string.",
                             e)

O código de usuário que manipula a exceção precisa saber que a propriedade InnerException contém informações sobre a exceção original, como ilustra o manipulador de exceções a seguir.

try
{
    indexes = s.FindOccurrences(toFind);
    ShowOccurrences(s, toFind, indexes);
}
catch (ArgumentNullException e)
{
    Console.WriteLine($"An exception ({e.GetType().Name}) occurred.");
    Console.WriteLine($"   Message:{Environment.NewLine}{e.Message}");
    Console.WriteLine($"   Stack Trace:{Environment.NewLine}   {e.StackTrace}");
    Exception ie = e.InnerException;
    if (ie != null)
    {
        Console.WriteLine("   The Inner Exception:");
        Console.WriteLine($"      Exception Name: {ie.GetType().Name}");
        Console.WriteLine($"      Message: {ie.Message}{Environment.NewLine}");
        Console.WriteLine($"      Stack Trace:{Environment.NewLine}   {ie.StackTrace}{Environment.NewLine}");
    }
}
// The example displays the following output:
//    'a' occurs at the following character positions: 4, 7, 15
//
//    An exception (ArgumentNullException) occurred.
//       Message: You must supply a search string.
//
//       Stack Trace:
//          at Library.FindOccurrences(String s, String f)
//       at Example.Main()
//
//       The Inner Exception:
//          Exception Name: ArgumentNullException
//          Message: Value cannot be null.
//    Parameter name: value
//
//          Stack Trace:
//          at System.String.IndexOf(String value, Int32 startIndex, Int32 count, Stri
//    ngComparison comparisonType)
//       at Library.FindOccurrences(String s, String f)
try
    let indexes = findOccurrences s toFind
    showOccurrences toFind indexes
with :? ArgumentNullException as e ->
    printfn $"An exception ({e.GetType().Name}) occurred."
    printfn $"   Message:\n{e.Message}"
    printfn $"   Stack Trace:\n   {e.StackTrace}"
    let ie = e.InnerException
    if ie <> null then
        printfn "   The Inner Exception:"
        printfn $"      Exception Name: {ie.GetType().Name}"
        printfn $"      Message: {ie.Message}\n"
        printfn $"      Stack Trace:\n   {ie.StackTrace}\n"
// The example displays the following output:
//    'a' occurs at the following character positions: 4, 7, 15
//
//    An exception (ArgumentNullException) occurred.
//       Message: You must supply a search string.
//
//       Stack Trace:
//          at Library.FindOccurrences(String s, String f)
//       at Example.Main()
//
//       The Inner Exception:
//          Exception Name: ArgumentNullException
//          Message: Value cannot be null.
//    Parameter name: value
//
//          Stack Trace:
//          at System.String.IndexOf(String value, Int32 startIndex, Int32 count, Stri
//    ngComparison comparisonType)
//       at Library.FindOccurrences(String s, String f)
Try
    indexes = s.FindOccurrences(toFind)
    ShowOccurrences(s, toFind, indexes)
Catch e As ArgumentNullException
    Console.WriteLine("An exception ({0}) occurred.",
                   e.GetType().Name)
    Console.WriteLine("   Message: {1}{0}", vbCrLf, e.Message)
    Console.WriteLine("   Stack Trace:{0}   {1}{0}", vbCrLf, e.StackTrace)
    Dim ie As Exception = e.InnerException
    If ie IsNot Nothing Then
        Console.WriteLine("   The Inner Exception:")
        Console.WriteLine("      Exception Name: {0}", ie.GetType().Name)
        Console.WriteLine("      Message: {1}{0}", vbCrLf, ie.Message)
        Console.WriteLine("      Stack Trace:{0}   {1}{0}", vbCrLf, ie.StackTrace)
    End If
End Try
' The example displays the following output:
'       'a' occurs at the following character positions: 4, 7, 15
'
'       An exception (ArgumentNullException) occurred.
'          Message: You must supply a search string.
'
'          Stack Trace:
'             at Library.FindOccurrences(String s, String f)
'          at Example.Main()
'
'          The Inner Exception:
'             Exception Name: ArgumentNullException
'             Message: Value cannot be null.
'       Parameter name: value
'
'             Stack Trace:
'             at System.String.IndexOf(String value, Int32 startIndex, Int32 count, Stri
'       ngComparison comparisonType)
'          at Library.FindOccurrences(String s, String f)

Escolha exceções padrão

Quando você tem que lançar uma exceção, muitas vezes você pode usar um tipo de exceção existente no .NET em vez de implementar uma exceção personalizada. Você deve usar um tipo de exceção padrão nestas duas condições:

  • Você está lançando uma exceção que é causada por um erro de uso (ou seja, por um erro na lógica do programa feito pelo desenvolvedor que está chamando seu método). Normalmente, você lançaria uma exceção como ArgumentException, ArgumentNullException, InvalidOperationExceptionou NotSupportedException. A cadeia de caracteres que você fornece ao construtor do objeto exception ao instanciar o objeto exception deve descrever o erro para que o desenvolvedor possa corrigi-lo. Para obter mais informações, consulte a propriedade Message.

  • Está a tratar de um erro que pode ser comunicado ao chamador através de uma exceção .NET existente. Você deve lançar a exceção mais derivada possível. Por exemplo, se um método requer que um argumento seja um membro válido de um tipo de enumeração, você deve lançar um InvalidEnumArgumentException (a classe mais derivada) em vez de um ArgumentException.

A tabela a seguir lista os tipos de exceção comuns e as condições sob as quais você os lançaria.

Exceção Condição
ArgumentException Um argumento não nulo que é passado para um método é inválido.
ArgumentNullException Um argumento que é passado para um método é null.
ArgumentOutOfRangeException Um argumento está fora do intervalo de valores válidos.
DirectoryNotFoundException Parte de um caminho de diretório não é válida.
DivideByZeroException O denominador em uma operação de divisão inteira ou Decimal é zero.
DriveNotFoundException Uma unidade não está disponível ou não existe.
FileNotFoundException Um ficheiro não existe.
FormatException Um valor não está em um formato apropriado para ser convertido de uma cadeia de caracteres por um método de conversão como Parse.
IndexOutOfRangeException Um índice está fora dos limites de uma matriz ou coleção.
InvalidOperationException Uma chamada de método é inválida no estado atual de um objeto.
KeyNotFoundException A chave especificada para acessar um membro em uma coleção não pode ser encontrada.
NotImplementedException Um método ou operação não é implementado.
NotSupportedException Não há suporte para um método ou operação.
ObjectDisposedException Uma operação é executada em um objeto que foi descartado.
OverflowException Uma operação aritmética, de casting ou de conversão resulta em um overflow.
PathTooLongException Um caminho ou nome de arquivo excede o comprimento máximo definido pelo sistema.
PlatformNotSupportedException A operação não é suportada na plataforma atual.
RankException Uma matriz com o número errado de dimensões é passada para um método.
TimeoutException O intervalo de tempo atribuído a uma operação expirou.
UriFormatException Um URI (Uniform Resource Identifier) inválido é usado.

Implementar exceções personalizadas

Nos seguintes casos, usar uma exceção .NET existente para manipular uma condição de erro não é adequado:

  • Quando a exceção reflete um erro de programa exclusivo que não pode ser mapeado para uma exceção .NET existente.

  • Quando a exceção requer manipulação diferente da manipulação apropriada para uma exceção .NET existente, ou a exceção deve ser desambiguada de uma exceção semelhante. Por exemplo, se você lançar uma exceção ArgumentOutOfRangeException ao analisar a representação numérica de uma cadeia de caracteres que está fora do intervalo do tipo integral de destino, você não gostaria de usar a mesma exceção para um erro que resulta do chamador não fornecer os valores restritos apropriados ao chamar o método.

A classe Exception é a classe base de todas as exceções no .NET. Muitas classes derivadas dependem do comportamento herdado dos membros da classe Exception; não se sobrepõem aos membros da Exception, nem definem quaisquer membros únicos.

Para definir sua própria classe de exceção:

  1. Defina uma classe que herda de Exception. Se necessário, defina os membros exclusivos necessários para sua classe para fornecer informações adicionais sobre a exceção. Por exemplo, a classe ArgumentException inclui uma propriedade ParamName que especifica o nome do parâmetro cujo argumento causou a exceção e a propriedade RegexMatchTimeoutException inclui uma propriedade MatchTimeout que indica o intervalo de tempo limite.

  2. Se necessário, substitua todos os membros herdados cuja funcionalidade você deseja alterar ou modificar. Observe que a maioria das classes derivadas de Exception existentes não substituem o comportamento dos membros herdados.

  3. Determine se o objeto de exceção personalizado é serializável. A serialização permite que você salve informações sobre a exceção e permite que as informações de exceção sejam compartilhadas por um servidor e um proxy de cliente em um contexto remoto. Para tornar o objeto de exceção serializável, marque-o com o atributo SerializableAttribute.

  4. Defina os construtores de sua classe de exceção. Normalmente, as classes de exceção têm um ou mais dos seguintes construtores:

    • Exception(), que usa valores padrão para inicializar as propriedades de um novo objeto de exceção.

    • Exception(String), que inicializa um novo objeto de exceção com uma mensagem de erro especificada.

    • Exception(String, Exception), que inicializa um novo objeto de exceção com uma mensagem de erro especificada e uma exceção interna.

    • Exception(SerializationInfo, StreamingContext), que é um construtor protected que inicializa um novo objeto de exceção a partir de dados serializados. Você deve implementar esse construtor se tiver optado por tornar seu objeto de exceção serializável.

O exemplo a seguir ilustra o uso de uma classe de exceção personalizada. Ele define uma exceção NotPrimeException que é lançada quando um cliente tenta recuperar uma sequência de números primos especificando um número inicial que não é primo. A exceção define uma nova propriedade, NonPrime, que retorna o número não primo que causou a exceção. Além de implementar um construtor sem parâmetros protegido e um construtor com parâmetros SerializationInfo e StreamingContext para serialização, a classe NotPrimeException define três construtores adicionais para suportar a propriedade NonPrime. Cada construtor chama um construtor de classe base, além de preservar o valor do número não-primo. A classe NotPrimeException também é marcada com o atributo SerializableAttribute.

using System;
using System.Runtime.Serialization;

[Serializable()]
public class NotPrimeException : Exception
{
   private int notAPrime;

   protected NotPrimeException()
      : base()
   { }

   public NotPrimeException(int value) :
      base(String.Format("{0} is not a prime number.", value))
   {
      notAPrime = value;
   }

   public NotPrimeException(int value, string message)
      : base(message)
   {
      notAPrime = value;
   }

   public NotPrimeException(int value, string message, Exception innerException) :
      base(message, innerException)
   {
      notAPrime = value;
   }

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

   public int NonPrime
   { get { return notAPrime; } }
}
namespace global

open System
open System.Runtime.Serialization

[<Serializable>]
type NotPrimeException = 
    inherit Exception
    val notAPrime: int

    member this.NonPrime =
        this.notAPrime

    new (value) =
        { inherit Exception($"%i{value} is not a prime number."); notAPrime = value }

    new (value, message) =
        { inherit Exception(message); notAPrime = value }

    new (value, message, innerException: Exception) =
        { inherit Exception(message, innerException); notAPrime = value }

    // F# does not support protected members
    new () = 
        { inherit Exception(); notAPrime = 0 }

    new (info: SerializationInfo, context: StreamingContext) =
        { inherit Exception(info, context); notAPrime = 0 }
Imports System.Runtime.Serialization

<Serializable()> _
Public Class NotPrimeException : Inherits Exception
   Private notAPrime As Integer

   Protected Sub New()
      MyBase.New()
   End Sub

   Public Sub New(value As Integer)
      MyBase.New(String.Format("{0} is not a prime number.", value))
      notAPrime = value
   End Sub

   Public Sub New(value As Integer, message As String)
      MyBase.New(message)
      notAPrime = value
   End Sub

   Public Sub New(value As Integer, message As String, innerException As Exception)
      MyBase.New(message, innerException)
      notAPrime = value
   End Sub

   Protected Sub New(info As SerializationInfo,
                     context As StreamingContext)
      MyBase.New(info, context)
   End Sub

   Public ReadOnly Property NonPrime As Integer
      Get
         Return notAPrime
      End Get
   End Property
End Class

A classe PrimeNumberGenerator mostrada no exemplo a seguir utiliza o crivo de Eratóstenes para calcular a sequência de números primos de 2 até um limite especificado pelo utilizador na chamada ao seu construtor de classe. O método GetPrimesFrom retorna todos os números primos que são maiores ou iguais a um limite inferior especificado, mas lança um NotPrimeException se esse limite inferior não for um número primo.

using System;
using System.Collections.Generic;

[Serializable]
public class PrimeNumberGenerator
{
   private const int START = 2;
   private int maxUpperBound = 10000000;
   private int upperBound;
   private bool[] primeTable;
   private List<int> primes = new List<int>();

   public PrimeNumberGenerator(int upperBound)
   {
      if (upperBound > maxUpperBound)
      {
         string message = String.Format(
                           "{0} exceeds the maximum upper bound of {1}.",
                           upperBound, maxUpperBound);
         throw new ArgumentOutOfRangeException(message);
      }
      this.upperBound = upperBound;
      // Create array and mark 0, 1 as not prime (True).
      primeTable = new bool[upperBound + 1];
      primeTable[0] = true;
      primeTable[1] = true;

      // Use Sieve of Eratosthenes to determine prime numbers.
      for (int ctr = START; ctr <= (int)Math.Ceiling(Math.Sqrt(upperBound));
            ctr++)
      {
         if (primeTable[ctr]) continue;

         for (int multiplier = ctr; multiplier <= upperBound / ctr; multiplier++)
            if (ctr * multiplier <= upperBound) primeTable[ctr * multiplier] = true;
      }
      // Populate array with prime number information.
      int index = START;
      while (index != -1)
      {
         index = Array.FindIndex(primeTable, index, (flag) => !flag);
         if (index >= 1)
         {
            primes.Add(index);
            index++;
         }
      }
   }

   public int[] GetAllPrimes()
   {
      return primes.ToArray();
   }

   public int[] GetPrimesFrom(int prime)
   {
      int start = primes.FindIndex((value) => value == prime);
      if (start < 0)
         throw new NotPrimeException(prime, String.Format("{0} is not a prime number.", prime));
      else
         return primes.FindAll((value) => value >= prime).ToArray();
   }
}
namespace global

open System

[<Serializable>]
type PrimeNumberGenerator(upperBound) =
    let start = 2
    let maxUpperBound = 10000000
    let primes = ResizeArray()
    let primeTable = 
        upperBound + 1
        |> Array.zeroCreate<bool>

    do
        if upperBound > maxUpperBound then
            let message = $"{upperBound} exceeds the maximum upper bound of {maxUpperBound}."
            raise (ArgumentOutOfRangeException message)
        
        // Create array and mark 0, 1 as not prime (True).
        primeTable[0] <- true
        primeTable[1] <- true

        // Use Sieve of Eratosthenes to determine prime numbers.
        for i = start to float upperBound |> sqrt |> ceil |> int do
            if not primeTable[i] then
                for multiplier = i to upperBound / i do
                    if i * multiplier <= upperBound then
                        primeTable[i * multiplier] <- true
        
        // Populate array with prime number information.
        let mutable index = start
        while index <> -1 do
            index <- Array.FindIndex(primeTable, index, fun flag -> not flag)
            if index >= 1 then
                primes.Add index
                index <- index + 1

    member _.GetAllPrimes() =
        primes.ToArray()

    member _.GetPrimesFrom(prime) =
        let start = 
            Seq.findIndex ((=) prime) primes
        
        if start < 0 then
            raise (NotPrimeException(prime, $"{prime} is not a prime number.") )
        else
            Seq.filter ((>=) prime) primes
            |> Seq.toArray
Imports System.Collections.Generic

<Serializable()> Public Class PrimeNumberGenerator
   Private Const START As Integer = 2
   Private maxUpperBound As Integer = 10000000
   Private upperBound As Integer
   Private primeTable() As Boolean
   Private primes As New List(Of Integer)

   Public Sub New(upperBound As Integer)
      If upperBound > maxUpperBound Then
         Dim message As String = String.Format(
             "{0} exceeds the maximum upper bound of {1}.",
             upperBound, maxUpperBound)
         Throw New ArgumentOutOfRangeException(message)
      End If
      Me.upperBound = upperBound
      ' Create array and mark 0, 1 as not prime (True).
      ReDim primeTable(upperBound)
      primeTable(0) = True
      primeTable(1) = True

      ' Use Sieve of Eratosthenes to determine prime numbers.
      For ctr As Integer = START To CInt(Math.Ceiling(Math.Sqrt(upperBound)))
         If primeTable(ctr) Then Continue For

         For multiplier As Integer = ctr To CInt(upperBound \ ctr)
            If ctr * multiplier <= upperBound Then primeTable(ctr * multiplier) = True
         Next
      Next
      ' Populate array with prime number information.
      Dim index As Integer = START
      Do While index <> -1
         index = Array.FindIndex(primeTable, index, Function(flag)
                                                       Return Not flag
                                                    End Function)
         If index >= 1 Then
            primes.Add(index)
            index += 1
         End If
      Loop
   End Sub

   Public Function GetAllPrimes() As Integer()
      Return primes.ToArray()
   End Function

   Public Function GetPrimesFrom(prime As Integer) As Integer()
      Dim start As Integer = primes.FindIndex(Function(value)
                                                 Return value = prime
                                              End Function)
      If start < 0 Then
         Throw New NotPrimeException(prime, String.Format("{0} is not a prime number.", prime))
      Else
         Return primes.FindAll(Function(value)
                                  Return value >= prime
                               End Function).ToArray()
      End If
   End Function
End Class

O exemplo a seguir faz duas chamadas para o método GetPrimesFrom com números não primos, um dos quais cruza os limites do domínio do aplicativo. Em ambos os casos, a exceção é lançada e tratada com êxito no código do cliente.

using System;
using System.Reflection;

class Example1
{
    public static void Main()
    {
        int limit = 10000000;
        PrimeNumberGenerator primes = new PrimeNumberGenerator(limit);
        int start = 1000001;
        try
        {
            int[] values = primes.GetPrimesFrom(start);
            Console.WriteLine($"There are {start} prime numbers from {limit} to {2}");
        }
        catch (NotPrimeException e)
        {
            Console.WriteLine($"{e.NonPrime} is not prime");
            Console.WriteLine(e);
            Console.WriteLine("--------");
        }

        AppDomain domain = AppDomain.CreateDomain("Domain2");
        PrimeNumberGenerator gen = (PrimeNumberGenerator)domain.CreateInstanceAndUnwrap(
                                          typeof(Example).Assembly.FullName,
                                          "PrimeNumberGenerator", true,
                                          BindingFlags.Default, null,
                                          new object[] { 1000000 }, null, null);
        try
        {
            start = 100;
            Console.WriteLine(gen.GetPrimesFrom(start));
        }
        catch (NotPrimeException e)
        {
            Console.WriteLine($"{e.NonPrime} is not prime");
            Console.WriteLine(e);
            Console.WriteLine("--------");
        }
    }
}
open System
open System.Reflection

let limit = 10000000
let primes = PrimeNumberGenerator limit
let start = 1000001
try
    let values = primes.GetPrimesFrom start
    printfn $"There are {values.Length} prime numbers from {start} to {limit}"
with :? NotPrimeException as e ->
    printfn $"{e.NonPrime} is not prime"
    printfn $"{e}"
    printfn "--------"

let domain = AppDomain.CreateDomain "Domain2"
let gen = 
    domain.CreateInstanceAndUnwrap(
        typeof<PrimeNumberGenerator>.Assembly.FullName,
        "PrimeNumberGenerator", true,
        BindingFlags.Default, null,
        [| box 1000000 |], null, null)
    :?> PrimeNumberGenerator
try
    let start = 100
    printfn $"{gen.GetPrimesFrom start}"
with :? NotPrimeException as e ->
    printfn $"{e.NonPrime} is not prime"
    printfn $"{e}"
    printfn "--------"
Imports System.Reflection

Module Example
   Sub Main()
      Dim limit As Integer = 10000000
      Dim primes As New PrimeNumberGenerator(limit)
      Dim start As Integer = 1000001
      Try
         Dim values() As Integer = primes.GetPrimesFrom(start)
         Console.WriteLine("There are {0} prime numbers from {1} to {2}",
                           start, limit)
      Catch e As NotPrimeException
         Console.WriteLine("{0} is not prime", e.NonPrime)
         Console.WriteLine(e)
         Console.WriteLine("--------")
      End Try

      Dim domain As AppDomain = AppDomain.CreateDomain("Domain2")
      Dim gen As PrimeNumberGenerator = domain.CreateInstanceAndUnwrap(
                                        GetType(Example).Assembly.FullName,
                                        "PrimeNumberGenerator", True,
                                        BindingFlags.Default, Nothing,
                                        {1000000}, Nothing, Nothing)
      Try
         start = 100
         Console.WriteLine(gen.GetPrimesFrom(start))
      Catch e As NotPrimeException
         Console.WriteLine("{0} is not prime", e.NonPrime)
         Console.WriteLine(e)
         Console.WriteLine("--------")
      End Try
   End Sub
End Module
' The example displays the following output:
'      1000001 is not prime
'      NotPrimeException: 1000001 is not a prime number.
'         at PrimeNumberGenerator.GetPrimesFrom(Int32 prime)
'         at Example.Main()
'      --------
'      100 is not prime
'      NotPrimeException: 100 is not a prime number.
'         at PrimeNumberGenerator.GetPrimesFrom(Int32 prime)
'         at Example.Main()
'      --------

Exemplos

O exemplo a seguir demonstra um bloco catch (with em F#) que é definido para manipular erros ArithmeticException. Este bloco catch também deteta erros DivideByZeroException, porque DivideByZeroException deriva de ArithmeticException e não há nenhum bloco catch explicitamente definido para erros DivideByZeroException.

using System;

class ExceptionTestClass
{
   public static void Main()
   {
      int x = 0;
      try
      {
         int y = 100 / x;
      }
      catch (ArithmeticException e)
      {
         Console.WriteLine($"ArithmeticException Handler: {e}");
      }
      catch (Exception e)
      {
         Console.WriteLine($"Generic Exception Handler: {e}");
      }
   }	
}
/*
This code example produces the following results:

ArithmeticException Handler: System.DivideByZeroException: Attempted to divide by zero.
   at ExceptionTestClass.Main()

*/
module ExceptionTestModule

open System

let x = 0
try
    let y = 100 / x
    ()
with
| :? ArithmeticException as e ->
    printfn $"ArithmeticException Handler: {e}"
| e ->
    printfn $"Generic Exception Handler: {e}"

// This code example produces the following results:
//     ArithmeticException Handler: System.DivideByZeroException: Attempted to divide by zero.
//        at <StartupCode$fs>.$ExceptionTestModule.main@()
Class ExceptionTestClass
   
   Public Shared Sub Main()
      Dim x As Integer = 0
      Try
         Dim y As Integer = 100 / x
      Catch e As ArithmeticException
         Console.WriteLine("ArithmeticException Handler: {0}", e.ToString())
      Catch e As Exception
         Console.WriteLine("Generic Exception Handler: {0}", e.ToString())
      End Try
   End Sub
End Class
'
'This code example produces the following results:
'
'ArithmeticException Handler: System.OverflowException: Arithmetic operation resulted in an overflow.
'   at ExceptionTestClass.Main()
'