Exception Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Representa erros que ocorrem durante a execução do aplicativo.
public ref class Exception
public ref class Exception : System::Runtime::Serialization::ISerializable
public ref class Exception : System::Runtime::InteropServices::_Exception, System::Runtime::Serialization::ISerializable
public class Exception
public class Exception : System.Runtime.Serialization.ISerializable
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDual)]
[System.Serializable]
public class Exception : System.Runtime.Serialization.ISerializable
[System.Serializable]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComVisible(true)]
public class Exception : System.Runtime.InteropServices._Exception, System.Runtime.Serialization.ISerializable
[System.Serializable]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComVisible(true)]
public class Exception : System.Runtime.Serialization.ISerializable
type Exception = class
type Exception = class
interface ISerializable
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDual)>]
[<System.Serializable>]
type Exception = class
interface ISerializable
[<System.Serializable>]
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type Exception = class
interface ISerializable
interface _Exception
[<System.Serializable>]
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type Exception = class
interface ISerializable
Public Class Exception
Public Class Exception
Implements ISerializable
Public Class Exception
Implements _Exception, ISerializable
- Herança
-
Exception
- Derivado
- Atributos
- Implementações
Exemplos
O exemplo a seguir demonstra um catch
bloco (with
em F#) definido para lidar com ArithmeticException erros. Esse catch
bloco também captura DivideByZeroException erros, pois DivideByZeroException deriva de ArithmeticException e não há nenhum catch
bloco definido explicitamente para DivideByZeroException erros.
using namespace System;
int main()
{
int x = 0;
try
{
int y = 100 / x;
}
catch ( ArithmeticException^ e )
{
Console::WriteLine( "ArithmeticException Handler: {0}", e );
}
catch ( Exception^ e )
{
Console::WriteLine( "Generic Exception Handler: {0}", e );
}
}
/*
This code example produces the following results:
ArithmeticException Handler: System.DivideByZeroException: Attempted to divide by zero.
at main()
*/
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()
'
Comentários
Essa classe é 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 é gerada, ela é manipulada pelo aplicativo ou pelo manipulador de exceção padrão.
Nesta seção:
Erros e exceções
Blocos try/catch
Recursos do tipo de exceção
Propriedades da classe de exceção
Considerações sobre desempenho
Como gerar novamente uma exceção
Escolhendo exceções padrão
Implementando exceções personalizadas
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 em seu código. Aqui estão algumas categorias de erros que podem ocorrer em tempo de execução e as maneiras apropriadas de responder a eles.
Erros de uso. 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 por meio do tratamento de exceções, mas modificando o código defeituoso. Por exemplo, a substituição do Object.Equals(Object) método no exemplo a seguir pressupõe que o
obj
argumento sempre deve ser não nulo.using System; public class Person { 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. Person p = (Person) obj; return this.Name.Equals(p.Name); } } public class Example { public static void Main() { Person p1 = new Person(); p1.Name = "John"; Person p2 = null; // The following throws a NullReferenceException. Console.WriteLine("p1 = p2: {0}", 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 Example 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 NullReferenceException exceção que resulta quando
obj
énull
pode ser eliminada modificando o código-fonte para testar explicitamente para nulo antes de chamar a Object.Equals substituição e, em seguida, compilar novamente. O exemplo a seguir contém o código-fonte corrigido que manipula umnull
argumento .using System; public class Person { 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. Person p = obj as Person; if (p == null) return false; else return this.Name.Equals(p.Name); } } public class Example { public static void Main() { Person p1 = new Person(); p1.Name = "John"; Person p2 = null; Console.WriteLine("p1 = p2: {0}", 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 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 handles a null obj argument. Dim p As Person = TryCast(obj, Person) If p Is Nothing Then Return False Else Return Me.Name.Equals(p.Name) End If End Function End Class Module Example Public Sub Main() Dim p1 As New Person() p1.Name = "John" Dim p2 As Person = 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ção para erros de uso, você pode usar o Debug.Assert método para identificar erros de uso em builds de depuração e o Trace.Assert método para identificar erros de uso em builds de depuração e versão. Para obter mais informações, confira Asserções em código gerenciado.
Erros de programa. Um erro de programa é um erro em tempo de execução que não pode necessariamente ser evitado escrevendo código sem bugs.
Em alguns casos, um erro de programa pode refletir uma condição de erro esperada ou de rotina. Nesse caso, talvez você queira evitar usar o tratamento de exceção para lidar com o erro do programa e tentar novamente a operação. Por exemplo, se espera-se que o usuário insira uma data em um formato específico, você poderá analisar a cadeia de caracteres de data chamando o DateTime.TryParseExact método , que retorna um Boolean valor que indica se a operação de análise foi bem-sucedida, em vez de usar o método , o DateTime.ParseExact que gerará uma FormatException exceção se a cadeia de caracteres de data não puder ser convertida em um DateTime valor. Da mesma forma, se um usuário tentar abrir um arquivo que não existe, você poderá primeiro chamar o File.Exists método para marcar se o arquivo existe e, se não existir, avisar o usuário se ele deseja criá-lo.
Em outros casos, um erro de programa reflete uma condição de erro inesperada que pode ser tratada em seu código. Por exemplo, mesmo que você tenha verificado se um arquivo existe, ele pode ser excluído antes de abri-lo ou ele pode estar corrompido. Nesse caso, tentar abrir o arquivo instanciando um StreamReader objeto ou chamando o Open método pode gerar uma FileNotFoundException exceção. Nesses casos, você deve usar o tratamento de exceção 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 maneira significativa. Por exemplo, qualquer método poderá gerar uma exceção OutOfMemoryException se o Common Language Runtime não puder alocar memória adicional. Normalmente, as falhas do sistema não são tratadas usando o tratamento de exceção. Em vez disso, você pode usar um evento como AppDomain.UnhandledException e chamar o Environment.FailFast método para registrar informações de exceção e notificar o usuário sobre a falha antes que o aplicativo seja encerrado.
Blocos try/catch
O Common Language Runtime fornece um modelo de tratamento de exceção baseado 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ção em try
blocos e catch
blocos. Pode haver um ou mais catch
blocos, 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 manipular exceções que ocorrem durante a execução de um bloco de código do aplicativo, o código deverá ser colocado dentro de uma try
instrução e é chamado de try
bloco. O código do aplicativo que manipula exceções geradas por um try
bloco é colocado dentro de uma catch
instrução e é chamado de catch
bloco. Zero ou mais catch
blocos são associados a um try
bloco e cada catch
bloco inclui um filtro de tipo que determina os tipos de exceções que ele manipula.
Quando ocorre uma exceção em um try
bloco, o sistema pesquisa os blocos associados catch
na ordem em que aparecem no código do aplicativo, até localizar um catch
bloco que manipula a exceção. Um catch
bloco manipulará uma exceção do tipo T
se o filtro de tipo do bloco catch especificar T
ou qualquer tipo do qual T
deriva. O sistema para de pesquisar depois de localizar o primeiro catch
bloco que manipula a exceção. Por esse motivo, no código do aplicativo, um catch
bloco que manipula um tipo deve ser especificado antes de um catch
bloco que manipula seus tipos base, conforme demonstrado no exemplo que segue esta seção. Um bloco catch que manipula System.Exception
é especificado por último.
Se nenhum dos catch
blocos associados ao bloco atual try
manipular a exceção e o bloco atual try
estiver aninhado em outros try
blocos na chamada atual, os catch
blocos associados ao próximo bloco delimitado try
serão pesquisados. Se nenhum catch
bloco para a exceção for encontrado, o sistema pesquisa os níveis de aninhamento anteriores na chamada atual. Se nenhum catch
bloco para a exceção for encontrado na chamada atual, a exceção será passada para cima da pilha de chamadas e o quadro de pilha anterior será pesquisado por um catch
bloco que manipula 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 atingida sem encontrar um catch
bloco que manipule a exceção, o manipulador de exceção padrão o manipulará e o aplicativo será encerrado.
F# try.. com Expressão
O F# não usa catch
blocos. Em vez disso, uma exceção gerada é correspondente ao padrão usando um único with
bloco. Como essa é uma expressão, em vez de uma instrução, todos os caminhos devem retornar o mesmo tipo. Para saber mais, confira A tentativa... com Expressão.
Recursos do tipo de exceção
Os tipos de exceção dão suporte aos seguintes recursos:
Texto legível por humanos que descreve o erro. Quando ocorre uma exceção, o runtime disponibiliza uma mensagem de texto para informar o usuário sobre a natureza do erro e sugerir ação para resolve o problema. Essa mensagem de texto é mantida na Message propriedade 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 StackTrace propriedade 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 em que as chamadas são feitas.
Propriedades da classe de exceção
A Exception classe 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, , MessageInnerException, , HResultHelpLink, Source, TargetSitee Data.
Quando existe uma relação causal entre duas ou mais exceções, a InnerException propriedade mantém essas informações. A exceção externa é gerada 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 complementares sobre a exceção podem ser armazenadas como uma coleção de pares chave/valor na Data propriedade .
A cadeia de caracteres de mensagem de erro passada para o construtor durante a criação do objeto de exceção deve ser localizada e pode ser fornecida de um arquivo de recurso usando a ResourceManager classe . Para obter mais informações sobre recursos localizados, consulte os tópicos Criando assemblies satélites e empacotando e implantando recursos .
Para fornecer ao usuário informações abrangentes sobre por que a exceção ocorreu, a HelpLink propriedade pode manter uma URL (ou URN) em um arquivo de ajuda.
A Exception classe usa o COR_E_EXCEPTION HRESULT, que tem o valor 0x80131500.
Para obter uma lista de valores de propriedade iniciais para uma instância da Exception classe , consulte os Exception construtores.
Considerações sobre o desempenho
Gerar ou manipular uma exceção consome uma quantidade significativa de recursos do sistema e tempo de execução. Gere exceções apenas para lidar com condições realmente 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 gerar uma exceção se um argumento de método for inválido, pois 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 gere uma exceção se a entrada do usuário for inválida, pois 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 uma entrada válida. Você 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 gere uma exceção quando um código de retorno for suficiente; não converta um código de retorno em uma exceção; e não capturam uma exceção rotineiramente, ignoram-na e, em seguida, continuam processando.
Como gerar novamente uma exceção
Em muitos casos, um manipulador de exceção simplesmente deseja passar a exceção para o chamador. Isso ocorre com mais frequência em:
Uma biblioteca de classes que, por sua vez, encapsula chamadas para métodos na biblioteca de classes .NET Framework ou em outras bibliotecas de classes.
Um aplicativo ou biblioteca que encontra uma exceção fatal. O manipulador de exceção pode registrar a exceção e, em seguida, relançar a exceção.
A maneira recomendada de relançar uma exceção é simplesmente usar a instrução throw em C#, a função de nova geração 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 isto. 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 com antecedência.
using System;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
public static class Library
{
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 e) {
// 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 FindOccurrences(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
Um chamador então chama FindOccurrences
duas vezes. Na segunda chamada para FindOccurrences
, o chamador passa um null
como a cadeia de caracteres de pesquisa, o que faz com que o String.IndexOf(String, Int32) método gere uma exceção ArgumentNullException . Essa exceção é tratada pelo FindOccurrences
método 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 Example
{
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 ({0}) occurred.",
e.GetType().Name);
Console.WriteLine("Message:\n {0}\n", e.Message);
Console.WriteLine("Stack Trace:\n {0}\n", e.StackTrace);
}
}
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 Example
Public Sub Main()
Dim s As String = "It was a cold day when..."
Dim indexes() As Integer = s.FindOccurrences("a")
ShowOccurrences(s, "a", indexes)
Console.WriteLine()
Dim toFind As String = Nothing
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:{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()
Por outro lado, se a exceção for lançada novamente usando o
throw e;
Throw e
raise e
instrução , 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 de pilha de chamadas da exceção original em uma exceção interna. Em seguida, o chamador pode usar a propriedade da InnerException nova exceção para recuperar o quadro de pilha e outras informações sobre a exceção original. Nesse 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 do usuário que manipula a exceção precisa saber que a InnerException propriedade contém informações sobre a exceção original, como ilustra o manipulador de exceção a seguir.
try {
indexes = s.FindOccurrences(toFind);
ShowOccurrences(s, toFind, indexes);
}
catch (ArgumentNullException e) {
Console.WriteLine("An exception ({0}) occurred.",
e.GetType().Name);
Console.WriteLine(" Message:\n{0}", e.Message);
Console.WriteLine(" Stack Trace:\n {0}", e.StackTrace);
Exception ie = e.InnerException;
if (ie != null) {
Console.WriteLine(" The Inner Exception:");
Console.WriteLine(" Exception Name: {0}", ie.GetType().Name);
Console.WriteLine(" Message: {0}\n", ie.Message);
Console.WriteLine(" Stack Trace:\n {0}\n", ie.StackTrace);
}
}
// 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)
Escolhendo exceções padrão
Quando você precisa lançar uma exceção, geralmente você pode usar um tipo de exceção existente no .NET Framework em vez de implementar uma exceção personalizada. Você deve usar um tipo de exceção padrão nessas duas condições:
Você está lançando uma exceção causada por um erro de uso (ou seja, por um erro na lógica do programa feita pelo desenvolvedor que está chamando seu método). Normalmente, você geraria uma exceção como ArgumentException, ArgumentNullException, InvalidOperationExceptionou NotSupportedException. A cadeia de caracteres que você fornece ao construtor do objeto de exceção ao instanciar o objeto de exceção deve descrever o erro para que o desenvolvedor possa corrigi-lo. Para obter mais informações, consulte a propriedade Message.
Você está tratando um erro que pode ser comunicado ao chamador com uma exceção .NET Framework existente. Você deve gerar a exceção mais derivada possível. Por exemplo, se um método exigir que um argumento seja um membro válido de um tipo de enumeração, você deverá 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 um inteiro ou Decimal operação de divisão é zero. |
DriveNotFoundException | Uma unidade não está disponível ou não existe. |
FileNotFoundException | Um arquivo 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 conversão ou de conversão resulta em um estouro. |
PathTooLongException | Um caminho ou nome de arquivo excede o comprimento máximo definido pelo sistema. |
PlatformNotSupportedException | Não há suporte para a operação na plataforma atual. |
RankException | Uma matriz com o número errado de dimensões é passada para um método . |
TimeoutException | O intervalo de tempo alocado para uma operação expirou. |
UriFormatException | Um URI (Uniform Resource Identifier) inválido é usado. |
Implementando exceções personalizadas
Nos casos a seguir, o uso de uma exceção .NET Framework existente para lidar com 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 Framework existente.
Quando a exceção requer tratamento diferente do tratamento apropriado para uma exceção .NET Framework existente, ou a exceção deve ser desambiguada de uma exceção semelhante. Por exemplo, se você lançar uma ArgumentOutOfRangeException exceção ao analisar a representação numérica de uma cadeia de caracteres fora do intervalo do tipo integral de destino, não desejará 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 Exception classe é a classe base de todas as exceções no .NET Framework. Muitas classes derivadas dependem do comportamento herdado dos membros da Exception classe; elas não substituem os membros de Exception, nem definem membros exclusivos.
Para definir sua própria classe de exceção:
Defina uma classe que herda de Exception. Se necessário, defina todos os membros exclusivos necessários para sua classe para fornecer informações adicionais sobre a exceção. Por exemplo, a ArgumentException classe inclui uma ParamName propriedade que especifica o nome do parâmetro cujo argumento causou a exceção e a RegexMatchTimeoutException propriedade inclui uma MatchTimeout propriedade que indica o intervalo de tempo limite.
Se necessário, substitua todos os membros herdados cuja funcionalidade você deseja alterar ou modificar. Observe que a maioria das classes derivadas existentes de Exception não substitui o comportamento de membros herdados.
Determine se o objeto de exceção personalizado é serializável. A serialização permite salvar 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 de comunicação remota. Para tornar o objeto de exceção serializável, marque-o com o SerializableAttribute atributo .
Defina os construtores da 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
protected
construtor que inicializa um novo objeto de exceção de dados serializados. Você deverá implementar esse construtor se tiver escolhido 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 NotPrimeException
exceção gerada 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 SerializationInfo parâmetros e StreamingContext para serialização, a NotPrimeException
classe define três construtores adicionais para dar suporte à NonPrime
propriedade. Cada construtor chama um construtor de classe base, além de preservar o valor do número não primo. A NotPrimeException
classe também é marcada com o SerializableAttribute atributo .
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 PrimeNumberGenerator
classe mostrada no exemplo a seguir usa a Sieve de Eratosthenes para calcular a sequência de números primos de 2 para um limite especificado pelo cliente na chamada ao construtor de classe. O GetPrimesFrom
método retorna todos os números primos 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 GetPrimesFrom
método com números não primos, uma das quais ultrapassa os limites de domínio do aplicativo. Em ambos os casos, a exceção é gerada e tratada com êxito no código do cliente.
using System;
using System.Reflection;
class Example
{
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 {0} prime numbers from {1} to {2}",
start, limit);
}
catch (NotPrimeException e)
{
Console.WriteLine("{0} is not prime", e.NonPrime);
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("{0} is not prime", e.NonPrime);
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()
' --------
Windows Runtime e .NET Framework 4.5.1
No .NET para aplicativos da Windows 8.x Store para Windows 8, algumas informações de exceção normalmente são perdidas quando uma exceção é propagada por meio de quadros de pilha não .NET Framework. Começando com o .NET Framework 4.5.1 e Windows 8.1, o Common Language Runtime continua a usar o objeto original Exception que foi lançado, a menos que essa exceção tenha sido modificada em um quadro de pilha não .NET Framework.
Construtores
Exception() |
Inicializa uma nova instância da classe Exception. |
Exception(SerializationInfo, StreamingContext) |
Obsoleto.
Inicializa uma nova instância da classe Exception com dados serializados. |
Exception(String) |
Inicializa uma nova instância da classe Exception com uma mensagem de erro especificada. |
Exception(String, Exception) |
Inicializa uma nova instância da classe Exception com uma mensagem de erro especificada e uma referência à exceção interna que é a causa da exceção. |
Propriedades
Data |
Obtém uma coleção de pares de chave/valor que fornecem informações definidas pelo usuário adicionais sobre a exceção. |
HelpLink |
Obtém ou define um link para o arquivo de ajuda associado a essa exceção. |
HResult |
Obtém ou define HRESULT, um valor numérico codificado que é atribuído a uma exceção específica. |
InnerException |
Obtém a instância Exception que causou a exceção atual. |
Message |
Obtém uma mensagem que descreve a exceção atual. |
Source |
Obtém ou define o nome do aplicativo ou objeto que causa o erro. |
StackTrace |
Obtém uma representação de cadeia de caracteres de quadros imediatos na pilha de chamadas. |
TargetSite |
Obtém o método que gerou a exceção atual. |
Métodos
Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
GetBaseException() |
Quando substituído em uma classe derivada, retorna a Exception que é a causa raiz de uma ou mais exceções subsequentes. |
GetHashCode() |
Serve como a função de hash padrão. (Herdado de Object) |
GetObjectData(SerializationInfo, StreamingContext) |
Obsoleto.
Quando substituído em uma classe derivada, define o SerializationInfo com informações sobre a exceção. |
GetType() |
Obtém o tipo de runtime da instância atual. |
GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
MemberwiseClone() |
Cria uma cópia superficial do Object atual. (Herdado de Object) |
ToString() |
Cria e retorna uma representação de cadeia de caracteres da exceção atual. |
Eventos
SerializeObjectState |
Obsoleto.
Ocorre quando uma exceção é serializada para criar um objeto de estado de exceção que contém dados serializados sobre a exceção. |