Código-Limpo Parte 5. Tratamento Adequado de Erros

Introdução

O tratamento adequado de erros é um componente essencial para a construção de software robusto e confiável. Quando os erros são tratados de forma eficaz, o código se torna mais previsível e seguro, e os desenvolvedores podem identificar e resolver problemas rapidamente. Este artigo explora a importância do tratamento adequado de erros, as práticas recomendadas e como implementá-las no desenvolvimento de software.

A Importância do Tratamento Adequado de Erros

Erros são inevitáveis em qualquer aplicação de software, mas a maneira como eles são tratados pode fazer uma grande diferença na qualidade do software. Um tratamento de erros eficaz:

Previne Falhas Catastróficas: Um bom tratamento de erros pode impedir que pequenos problemas se transformem em falhas graves que possam comprometer todo o sistema.
Melhora a Experiência do Usuário: Quando erros são gerenciados corretamente, os usuários recebem feedback adequado, permitindo uma experiência mais suave e menos frustrante.
Facilita a Depuração e a Manutenção: Erros bem tratados fornecem informações valiosas para a depuração e manutenção do código, tornando mais fácil para os desenvolvedores identificar e corrigir problemas.

Práticas Recomendadas para o Tratamento de Erros

Utilizar Exceções de Forma Adequada: Em Delphi, como em muitas outras linguagens, as exceções são usadas para sinalizar condições de erro. As exceções devem ser usadas para situações excepcionais e não para o fluxo normal de controle.
Fornecer Mensagens de Erro Claras e Informativas: Mensagens de erro devem ser claras e fornecer informações suficientes para que os desenvolvedores possam entender o problema e resolvê-lo rapidamente.
Evitar Silenciamento de Erros: Evite capturar exceções sem tomar alguma ação significativa. Silenciar erros pode mascarar problemas maiores e dificultar a depuração.
Usar Estruturas de Tratamento de Erros Apropriadas: Estruturas como try...except e try...finally em Delphi ajudam a garantir que os recursos sejam liberados corretamente e que os erros sejam tratados de forma adequada.
Registrar Erros de Forma Eficaz: Implementar um sistema de registro de erros pode ajudar a monitorar e analisar problemas em produção, facilitando a correção de bugs.

Try…Except e Try…Finally

No Delphi, o uso de try...except e try...finally são estruturas fundamentais para o tratamento de erros e a gestão de recursos. Cada uma tem um propósito específico e deve ser usada em situações adequadas para garantir a robustez e a manutenção do código.

Try…Except

O bloco try...except é usado para capturar e tratar exceções que ocorrem dentro do bloco try. Isso permite que o programa lide com erros de forma controlada, sem interromper abruptamente a execução. É útil para capturar erros previsíveis e fornecer feedback ao usuário ou registrar informações de erro para depuração.


try
  // Código que pode gerar uma exceção
except
  on E: Exception do
    ShowMessage('Ocorreu um erro: ' + E.Message);
end;

try

// Código que pode gerar uma exceção

except

on E: Exception do

ShowMessage('Ocorreu um erro: ' + E.Message);

end;

Quando Usar:

Quando você deseja capturar exceções específicas e tomar ações corretivas ou de registro.
Quando você quer evitar que a aplicação termine abruptamente ao encontrar um erro.

Try…Finally

O bloco try...finally é usado para garantir que o código dentro do bloco finally seja executado, independentemente de uma exceção ter ocorrido ou não. Isso é crucial para liberar recursos, como arquivos ou conexões de banco de dados, que precisam ser fechados adequadamente para evitar vazamentos de memória ou outros problemas.

Exemplo:


try
  // Código que pode gerar uma exceção
finally
  // Código que sempre será executado, ocorrendo ou não uma exceção
end;

try

// Código que pode gerar uma exceção

finally

// Código que sempre será executado, ocorrendo ou não uma exceção

end;

Quando Usar:

Quando você precisa garantir a liberação de recursos (por exemplo, fechar arquivos ou conexões).
Quando você quer executar limpeza ou qualquer ação final após a execução do bloco try, independentemente do sucesso ou falha do código.

Combinação de try…except e try…finally

Frequentemente, é útil combinar ambas as estruturas para capturar exceções e garantir a liberação de recursos de forma segura.

Exemplo Combinado:


try
  // Código que pode gerar uma exceção
  try
    // Código que também pode gerar uma exceção
  except
    on E: Exception do
      ShowMessage('Erro interno: ' + E.Message);
  end;
finally
  // Código que sempre será executado, ocorrendo ou não uma exceção
end;

try

// Código que pode gerar uma exceção

try

// Código que também pode gerar uma exceção

except

on E: Exception do

ShowMessage('Erro interno: ' + E.Message);

end;

finally

// Código que sempre será executado, ocorrendo ou não uma exceção

end;

Diferenças e Uso Adequado

try…except: Use quando você precisa capturar e tratar erros específicos, tomar ações corretivas ou registrar informações de erro.
try…finally: Use quando você precisa garantir que os recursos sejam sempre liberados ou que ações de limpeza sejam executadas, independentemente de ocorrerem erros.

Ambas as estruturas são essenciais para escrever código robusto e confiável, permitindo um tratamento de erros eficaz e uma gestão adequada dos recursos.

Capturando Exceções Específicas

No Delphi, é possível capturar e tratar exceções específicas usando a estrutura try...except. Isso permite que você lide com diferentes tipos de erros de maneiras distintas, proporcionando um tratamento de erro mais granulado e apropriado. A capacidade de capturar exceções específicas ajuda a fornecer feedback preciso ao usuário e a realizar ações corretivas específicas para cada tipo de erro.

Capturando Exceções Específicas

A estrutura try...except permite que você capture exceções específicas usando a cláusula on para diferenciar os tipos de exceção e tomar ações apropriadas para cada uma.

Exemplo:


try
  // Código que pode gerar várias exceções
  var num := StrToInt('abc'); // Isso gerará uma exceção EConvertError
except
  on E: EConvertError do
    ShowMessage('Erro de conversão: ' + E.Message);
  on E: EDivByZero do
    ShowMessage('Erro de divisão por zero: ' + E.Message);
  on E: Exception do
    ShowMessage('Erro desconhecido: ' + E.Message);
end;

try

// Código que pode gerar várias exceções

var num := StrToInt('abc'); // Isso gerará uma exceção EConvertError

except

on E: EConvertError do

ShowMessage('Erro de conversão: ' + E.Message);

on E: EDivByZero do

ShowMessage('Erro de divisão por zero: ' + E.Message);

on E: Exception do

ShowMessage('Erro desconhecido: ' + E.Message);

end;

Explicação:

EConvertError: Captura erros de conversão, como tentar converter uma string que não representa um número válido.
EDivByZero: Captura erros de divisão por zero.
Exception: Captura qualquer outra exceção não específica. Isso é útil para garantir que nenhum erro passe despercebido.

Exemplos de Tratamento Específico

Manipulação de Arquivos


procedure TForm1.CarregarArquivo(const NomeArquivo: string);
var
  Arquivo: TextFile;
  Linha: string;
begin
  try
    AssignFile(Arquivo, NomeArquivo);
    Reset(Arquivo);
    while not Eof(Arquivo) do
    begin
      Readln(Arquivo, Linha);
      // Processar linha
    end;
  except
    on E: EInOutError do
      ShowMessage('Erro de E/S ao abrir o arquivo: ' + E.Message);
    on E: EFileNotFoundException do
      ShowMessage('Arquivo não encontrado: ' + E.Message);
    on E: Exception do
      ShowMessage('Erro desconhecido ao abrir o arquivo: ' + E.Message);
  finally
    if FileExists(NomeArquivo) then
      CloseFile(Arquivo);
  end;
end;

procedure TForm1.CarregarArquivo(const NomeArquivo: string);

var

Arquivo: TextFile;

Linha: string;

begin

try

AssignFile(Arquivo, NomeArquivo);

Reset(Arquivo);

while not Eof(Arquivo) do

begin

Readln(Arquivo, Linha);

// Processar linha

end;

except

on E: EInOutError do

ShowMessage('Erro de E/S ao abrir o arquivo: ' + E.Message);

on E: EFileNotFoundException do

ShowMessage('Arquivo não encontrado: ' + E.Message);

on E: Exception do

ShowMessage('Erro desconhecido ao abrir o arquivo: ' + E.Message);

finally

if FileExists(NomeArquivo) then

CloseFile(Arquivo);

end;

2. Conexão com Banco de Dados


procedure TForm1.ConectarBancoDeDados;
begin
  try
    DatabaseConnection.Connect;
    ShowMessage('Conexão estabelecida com sucesso');
  except
    on E: EDatabaseError do
      ShowMessage('Erro no banco de dados: ' + E.Message);
    on E: EConnectionError do
      ShowMessage('Erro de conexão: ' + E.Message);
    on E: Exception do
      ShowMessage('Erro desconhecido ao conectar ao banco de dados: ' + E.Message);
  end;
end;

procedure TForm1.ConectarBancoDeDados;

begin

try

DatabaseConnection.Connect;

ShowMessage('Conexão estabelecida com sucesso');

except

on E: EDatabaseError do

ShowMessage('Erro no banco de dados: ' + E.Message);

on E: EConnectionError do

ShowMessage('Erro de conexão: ' + E.Message);

on E: Exception do

ShowMessage('Erro desconhecido ao conectar ao banco de dados: ' + E.Message);

end;

3. Operações Matemáticas


procedure TForm1.CalcularDivisao(a, b: Integer);
var
  Resultado: Double;
begin
  try
    Resultado := a / b;
    ShowMessage('Resultado: ' + FloatToStr(Resultado));
  except
    on E: EDivByZero do
      ShowMessage('Erro: Divisão por zero');
    on E: Exception do
      ShowMessage('Erro desconhecido: ' + E.Message);
  end;
end;

procedure TForm1.CalcularDivisao(a, b: Integer);

var

Resultado: Double;

begin

try

Resultado := a / b;

ShowMessage('Resultado: ' + FloatToStr(Resultado));

except

on E: EDivByZero do

ShowMessage('Erro: Divisão por zero');

on E: Exception do

ShowMessage('Erro desconhecido: ' + E.Message);

end;

Capturar exceções específicas permite um tratamento de erro mais preciso e eficaz. Isso ajuda a melhorar a robustez e a usabilidade do software, fornecendo feedback claro e ações corretivas apropriadas para cada tipo de erro. Ao implementar essas práticas no Delphi, você pode criar aplicações mais resilientes e de alta qualidade.

Criando Suas Próprias Classes de Erro

No Delphi, você pode criar suas próprias classes de erro para fornecer uma maneira mais específica e personalizada de tratar erros em sua aplicação. Isso permite que você capture e trate exceções específicas para diferentes situações, oferecendo mensagens de erro mais detalhadas e melhor controle sobre o fluxo de execução.

Criando Classes de Erro Personalizadas

Para criar uma classe de erro personalizada, você deve herdar da classe base Exception ou de uma de suas subclasses. Aqui está um exemplo de como fazer isso:

Exemplo de Criação de Classe de Erro:


type
  EArquivoNaoEncontrado = class(Exception)
  public
    constructor Create(const NomeArquivo: string);
  end;

  EPermissaoNegada = class(Exception)
  public
    constructor Create(const NomeArquivo: string);
  end;

constructor EArquivoNaoEncontrado.Create(const NomeArquivo: string);
begin
  inherited Create('Arquivo não encontrado: ' + NomeArquivo);
end;

constructor EPermissaoNegada.Create(const NomeArquivo: string);
begin
  inherited Create('Permissão negada ao acessar: ' + NomeArquivo);
end;

type

EArquivoNaoEncontrado = class(Exception)

public

constructor Create(const NomeArquivo: string);

end;

EPermissaoNegada = class(Exception)

public

constructor Create(const NomeArquivo: string);

end;

constructor EArquivoNaoEncontrado.Create(const NomeArquivo: string);

begin

inherited Create('Arquivo não encontrado: ' + NomeArquivo);

end;

constructor EPermissaoNegada.Create(const NomeArquivo: string);

begin

inherited Create('Permissão negada ao acessar: ' + NomeArquivo);

end;

Usando Classes de Erro Personalizadas

Depois de criar suas classes de erro, você pode utilizá-las em seu código para lançar e capturar essas exceções específicas.

Exemplo de Uso:


procedure TForm1.CarregarArquivo(const NomeArquivo: string);
var
  Arquivo: TextFile;
  Linha: string;
begin
  try
    if not FileExists(NomeArquivo) then
      raise EArquivoNaoEncontrado.Create(NomeArquivo);

    AssignFile(Arquivo, NomeArquivo);
    Reset(Arquivo);
    while not Eof(Arquivo) do
    begin
      Readln(Arquivo, Linha);
      // Processar linha
    end;
  except
    on E: EArquivoNaoEncontrado do
      ShowMessage(E.Message);
    on E: EPermissaoNegada do
      ShowMessage(E.Message);
    on E: EInOutError do
      ShowMessage('Erro de E/S ao abrir o arquivo: ' + E.Message);
    on E: Exception do
      ShowMessage('Erro desconhecido ao abrir o arquivo: ' + E.Message);
  finally
    if FileExists(NomeArquivo) then
      CloseFile(Arquivo);
  end;
end;

procedure TForm1.CarregarArquivo(const NomeArquivo: string);

var

Arquivo: TextFile;

Linha: string;

begin

try

if not FileExists(NomeArquivo) then

raise EArquivoNaoEncontrado.Create(NomeArquivo);

AssignFile(Arquivo, NomeArquivo);

Reset(Arquivo);

while not Eof(Arquivo) do

begin

Readln(Arquivo, Linha);

// Processar linha

end;

except

on E: EArquivoNaoEncontrado do

ShowMessage(E.Message);

on E: EPermissaoNegada do

ShowMessage(E.Message);

on E: EInOutError do

ShowMessage('Erro de E/S ao abrir o arquivo: ' + E.Message);

on E: Exception do

ShowMessage('Erro desconhecido ao abrir o arquivo: ' + E.Message);

finally

if FileExists(NomeArquivo) then

CloseFile(Arquivo);

end;

Vantagens de Usar Classes de Erro Personalizadas

Especificidade: Permite capturar e tratar erros específicos com mais precisão.
Mensagens Claras: Fornece mensagens de erro mais detalhadas e informativas.
Controle: Oferece melhor controle sobre o fluxo de execução ao lidar com diferentes tipos de erros de maneira distinta.

Criar suas próprias classes de erro e utilizá-las em seu código ajuda a tornar suas aplicações mais robustas e fáceis de manter, proporcionando uma melhor experiência tanto para os desenvolvedores quanto para os usuários finais.

Implementação de Tratamento Adequado de Erros em Delphi

Entrando novamente no tema do nosso artigo, eis abaixo exemplo de como melhorar o tratamento de erros em seu software.

Exemplo de Código com Tratamento de Erros:

Antes:


procedure TForm1.CarregarArquivo(const NomeArquivo: string);
var
  Arquivo: TextFile;
  Linha: string;
begin
  AssignFile(Arquivo, NomeArquivo);
  Reset(Arquivo);
  while not Eof(Arquivo) do
  begin
    Readln(Arquivo, Linha);
    // Processar linha
  end;
  CloseFile(Arquivo);
end;

procedure TForm1.CarregarArquivo(const NomeArquivo: string);

var

Arquivo: TextFile;

Linha: string;

begin

AssignFile(Arquivo, NomeArquivo);

Reset(Arquivo);

while not Eof(Arquivo) do

begin

Readln(Arquivo, Linha);

// Processar linha

end;

CloseFile(Arquivo);

end;

Depois


procedure TForm1.CarregarArquivo(const NomeArquivo: string);
var
  Arquivo: TextFile;
  Linha: string;
begin
  try
    AssignFile(Arquivo, NomeArquivo);
    Reset(Arquivo);
    while not Eof(Arquivo) do
    begin
      Readln(Arquivo, Linha);
      // Processar linha
    end;
  except
    on E: EInOutError do
    begin
      ShowMessage('Erro ao abrir o arquivo: ' + E.Message);
      // Registro do erro para análise posterior
    end;
  finally
    if FileExists(NomeArquivo) then
      CloseFile(Arquivo);
  end;
end;

procedure TForm1.CarregarArquivo(const NomeArquivo: string);

var

Arquivo: TextFile;

Linha: string;

begin

try

AssignFile(Arquivo, NomeArquivo);

Reset(Arquivo);

while not Eof(Arquivo) do

begin

Readln(Arquivo, Linha);

// Processar linha

end;

except

on E: EInOutError do

begin

ShowMessage('Erro ao abrir o arquivo: ' + E.Message);

// Registro do erro para análise posterior

end;

finally

if FileExists(NomeArquivo) then

CloseFile(Arquivo);

end;

Detalhamento das Melhorias:

Uso de try...except: Envolvemos o código em um bloco try...except para capturar exceções do tipo EInOutError, que são comuns ao trabalhar com arquivos.
Mensagens de Erro Claras: A mensagem de erro informa o usuário sobre o problema específico que ocorreu, tornando mais fácil entender e corrigir o problema.
Uso de finally: Garantimos que o arquivo seja fechado no bloco finally, mesmo que ocorra uma exceção, evitando vazamento de recursos.

Conclusão

O tratamento adequado de erros é crucial para a construção de software robusto e confiável. Em Delphi, utilizar try...except e try...finally permite capturar e gerenciar exceções eficientemente, garantindo a liberação adequada de recursos e o tratamento correto dos erros. Além disso, criar classes de erro personalizadas oferece um controle maior sobre o gerenciamento de exceções específicas, melhorando a clareza e a manutenção do código. Implementar essas práticas resulta em um software mais seguro, confiável e fácil de manter, proporcionando uma melhor experiência para os desenvolvedores e usuários.

Comunidade no Telegram

🚀Comente no campo abaixo 👇👇👇 o que achou e qual sua dúvida.

Te vejo na próxima

Adriano Santos

Demais Artigos:

Parte 1: Nomes Significativos
Parte 2: Funções Pequenas
Parte 3: Comentários Eficientes
Parrte 4: Formatação Consistente
Parte 5: Tratamento de Erros
Parte 6: Estrutura de Classes
Parte 7: Testes Automatizados
Parte 8: Refatoração Contínua
Parte 9: Código Simples e Direto
Parte 10: SOLID

3 thoughts on “Código-Limpo Parte 5. Tratamento Adequado de Erros”

Rafael F. S. Mota disse:

17 de julho de 2024 às 17:25

Excelente artigo.

Responder
Victor Lopes Belo disse:

9 de setembro de 2024 às 16:10

Simplesmente F-A-N-T-Á-S-T-I-C-O!!!!

Responder
1. Adriano Santos disse:
  
  9 de setembro de 2024 às 16:17
  
  Obrigado, vamos juntos.
  
  Responder

Código-Limpo Parte 5. Tratamento Adequado de Erros

Introdução

A Importância do Tratamento Adequado de Erros

Práticas Recomendadas para o Tratamento de Erros

Try…Except e Try…Finally

Try…Except

Try…Finally

Combinação de try…except e try…finally

Diferenças e Uso Adequado

Capturando Exceções Específicas

Capturando Exceções Específicas

Exemplos de Tratamento Específico

Criando Suas Próprias Classes de Erro

Criando Classes de Erro Personalizadas

Usando Classes de Erro Personalizadas

Vantagens de Usar Classes de Erro Personalizadas

Implementação de Tratamento Adequado de Erros em Delphi

Conclusão

3 thoughts on “Código-Limpo Parte 5. Tratamento Adequado de Erros”

Deixe sua resposta Cancelar resposta

Posts Relacionados

As 10 ferramentas e bibliotecas que uso na construção de aplicativos.As 10 ferramentas e bibliotecas que uso na construção de aplicativos.

Como criar métodos encadeados com Fluent Interface?Como criar métodos encadeados com Fluent Interface?

Nomenclatura e Estrutura de Classes e MétodosNomenclatura e Estrutura de Classes e Métodos