Servlets - Tratamento de exceções

Quando um servlet lança uma exceção, o contêiner da web procura as configurações em web.xml que usam o elemento de tipo de exceção para uma correspondência com o tipo de exceção lançada.

Você teria que usar o error-page elemento em web.xml para especificar a invocação de servlets em resposta a certos exceptions ou HTTP status codes.

Configuração web.xml

Considere que você tem um servlet ErrorHandler que seria chamado sempre que houvesse qualquer exceção ou erro definido. A seguir está a entrada criada em web.xml.

<!-- servlet definition -->
<servlet>
   <servlet-name>ErrorHandler</servlet-name>
   <servlet-class>ErrorHandler</servlet-class>
</servlet>

<!-- servlet mappings -->
<servlet-mapping>
   <servlet-name>ErrorHandler</servlet-name>
   <url-pattern>/ErrorHandler</url-pattern>
</servlet-mapping>

<!-- error-code related error pages -->
<error-page>
   <error-code>404</error-code>
   <location>/ErrorHandler</location>
</error-page>

<error-page>
   <error-code>403</error-code>
   <location>/ErrorHandler</location>
</error-page>

<!-- exception-type related error pages -->
<error-page>
   <exception-type>
      javax.servlet.ServletException
   </exception-type >
   <location>/ErrorHandler</location>
</error-page>

<error-page>
   <exception-type>java.io.IOException</exception-type >
   <location>/ErrorHandler</location>
</error-page>

Se você deseja ter um manipulador de erro genérico para todas as exceções, você deve definir a seguinte página de erro em vez de definir elementos de página de erro separados para cada exceção -

<error-page>
   <exception-type>java.lang.Throwable</exception-type >
   <location>/ErrorHandler</location>
</error-page>

A seguir estão os pontos a serem observados sobre o web.xml acima para Tratamento de Exceções -

  • O servlet ErrorHandler é definido da maneira usual como qualquer outro servlet e configurado em web.xml.

  • Se houver algum erro com o código de status 404 (Não encontrado) ou 403 (Proibido), o servlet ErrorHandler será chamado.

  • Se o aplicativo da web lançar ServletException ou IOException, o contêiner da web invocará o servlet / ErrorHandler.

  • Você pode definir diferentes Manipuladores de Erro para lidar com diferentes tipos de erros ou exceções. O exemplo acima é muito genérico e espero que sirva ao propósito de explicar o conceito básico.

Solicitar Atributos - Erros / Exceções

A seguir está a lista de atributos de solicitação que um servlet de tratamento de erros pode acessar para analisar a natureza do erro / exceção.

Sr. Não. Atributo e descrição
1

javax.servlet.error.status_code

Este atributo fornece código de status que pode ser armazenado e analisado após o armazenamento em um tipo de dados java.lang.Integer.
2

javax.servlet.error.exception_type

Este atributo fornece informações sobre o tipo de exceção que pode ser armazenado e analisado após o armazenamento em um tipo de dados java.lang.Class.
3

javax.servlet.error.message

Este atributo fornece informações de mensagem de erro exata que podem ser armazenadas e analisadas após o armazenamento em um tipo de dados java.lang.String.
4

javax.servlet.error.request_uri

Este atributo fornece informações sobre a URL que chama o servlet e pode ser armazenado e analisado após o armazenamento em um tipo de dados java.lang.String.
5

javax.servlet.error.exception

Este atributo fornece informações sobre a exceção levantada, que pode ser armazenada e analisada.
6

javax.servlet.error.servlet_name

Este atributo fornece o nome do servlet que pode ser armazenado e analisado após o armazenamento em um tipo de dados java.lang.String.

Exemplo de servlet manipulador de erros

Este exemplo daria a você uma compreensão básica do Tratamento de Exceções no Servlet, mas você pode escrever aplicativos de filtro mais sofisticados usando o mesmo conceito -

// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// Extend HttpServlet class
public class ErrorHandler extends HttpServlet {
 
   // Method to handle GET method request.
   public void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
         
      // Analyze the servlet exception       
      Throwable throwable = (Throwable)
      request.getAttribute("javax.servlet.error.exception");
      Integer statusCode = (Integer)
      request.getAttribute("javax.servlet.error.status_code");
      String servletName = (String)
      request.getAttribute("javax.servlet.error.servlet_name");
         
      if (servletName == null) {
         servletName = "Unknown";
      }
      String requestUri = (String)
      request.getAttribute("javax.servlet.error.request_uri");
      
      if (requestUri == null) {
         requestUri = "Unknown";
      }

      // Set response content type
      response.setContentType("text/html");

      PrintWriter out = response.getWriter();
      String title = "Error/Exception Information";
      String docType =
         "<!doctype html public \"-//w3c//dtd html 4.0 " +
         "transitional//en\">\n";
         
      out.println(docType +
         "<html>\n" +
         "<head><title>" + title + "</title></head>\n" +
         "<body bgcolor = \"#f0f0f0\">\n");

      if (throwable == null && statusCode == null) {
         out.println("<h2>Error information is missing</h2>");
         out.println("Please return to the <a href=\"" + 
            response.encodeURL("http://localhost:8080/") + 
            "\">Home Page</a>.");
      } else if (statusCode != null) {
         out.println("The status code : " + statusCode);
      } else {
         out.println("<h2>Error information</h2>");
         out.println("Servlet Name : " + servletName + "</br></br>");
         out.println("Exception Type : " + throwable.getClass( ).getName( ) + "</br></br>");
         out.println("The request URI: " + requestUri + "<br><br>");
         out.println("The exception message: " + throwable.getMessage( ));
      }
      out.println("</body>");
      out.println("</html>");
   }
   
   // Method to handle POST method request.
   public void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
      
      doGet(request, response);
   }
}

Compilar ErrorHandler.java da maneira usual e coloque seu arquivo de classe em / webapps / ROOT / WEB-INF / classes.

Vamos adicionar a seguinte configuração em web.xml para lidar com exceções -

<servlet>
   <servlet-name>ErrorHandler</servlet-name>
   <servlet-class>ErrorHandler</servlet-class>
</servlet>

<!-- servlet mappings -->
<servlet-mapping>
   <servlet-name>ErrorHandler</servlet-name>
   <url-pattern>/ErrorHandler</url-pattern>
</servlet-mapping>

<error-page>
   <error-code>404</error-code>
   <location>/ErrorHandler</location>
</error-page>

<error-page>
   <exception-type>java.lang.Throwable</exception-type >
   <location>/ErrorHandler</location>
</error-page>

Agora tente usar um servlet que gera qualquer exceção ou digite uma URL errada, isso acionaria o Web Container para chamar ErrorHandlerservlet e exibir uma mensagem apropriada conforme programado. Por exemplo, se você digitar um URL errado, ele exibirá o seguinte resultado -

The status code : 404

O código acima pode não funcionar com alguns navegadores da web. Então tente com Mozilla e Safari e deve funcionar.