Servlet Gestion des exceptions

Lorsqu'un Servlet lance une exception, le conteneur Web, dans le [web.xml] qui utilise l'élément exception-type,web.xmlrecherche une configuration correspondant au type d'exception lancée.

Vous devez utiliser dans web.xml l'élémenterror-pagepour spécifier que pour uneexceptionou un code de statut HTTP,l'appel Servlet correspondant doit être effectué.

Configuration web.xml

Supposons qu'il y ait unErrorHandlerServlet qui est invoqué lorsqu'une exception ou erreur définie se produit. Voici l'entrée qui sera créée dans web.xml.

<!-- servlet 定义 -->
<servlet>
        <servlet-name>ErrorHandler</servlet-name>
        <servlet-class>ErrorHandler</servlet-class>
</servlet>
<!-- servlet 映射 -->
<servlet-mapping>
        <servlet-name>ErrorHandler</servlet-name>
        <url-pattern>/ErrorHandler</url-pattern>
</servlet-mapping>

<!-- error-code 相关的错误页面 -->
<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 相关的错误页面 -->
<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>

Si vous souhaitez un gestionnaire d'erreurs générique pour toutes les exceptions, vous devez définir la page d'erreur suivante au lieu de définir un élément error-page distinct pour chaque exception :

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

Voici les points à noter concernant la gestion des exceptions dans web.xml ci-dessus :

  • Le Servlet ErrorHandler est défini de la même manière que les autres Servlets, et est configuré dans web.xml.
  • Si un code d'état d'erreur se produit, qu'il s'agisse de 404 (Not Found) ou de 403 (Forbidden), le Servlet ErrorHandler sera invoqué.
  • Si l'application Web lèveServletExceptionouIOException, alors le conteneur Web invoquera le Servlet ErrorHandler.
  • Vous pouvez définir différents gestionnaires d'erreurs pour traiter différents types d'erreurs ou d'exceptions. L'exemple ci-dessus est très générique ; nous espérons que vous pourrez comprendre les concepts de base à travers l'exemple.

Attributs de requête - Erreur/Exception

Voici une liste d'attributs de requête auxquels le Servlet de gestion des erreurs peut accéder, utilisés pour analyser la nature de l'erreur/de l'exception.

Non.Attribut & Description
1javax.servlet.error.status_code
Cet attribut donne le code d'état, qui peut être stocké et analysé après avoir été stocké en tant que type de données java.lang.Integer.
2javax.servlet.error.exception_type
Cet attribut fournit des informations sur le type d'exception, qui peuvent être stockées et analysées après avoir été stockées en tant que type de données java.lang.Class.
3javax.servlet.error.message
Cet attribut fournit des informations sur le message d'erreur exact, qui peuvent être stockées et analysées après avoir été stockées en tant que type de données java.lang.String.
4javax.servlet.error.request_uri
Cet attribut fournit des informations sur l'URL qui a appelé le Servlet, qui peuvent être stockées et analysées après avoir été stockées en tant que type de données java.lang.String.
5javax.servlet.error.exception
Cet attribut fournit des informations sur l'exception qui a été levée, qui peuvent être stockées et analysées après avoir été stockées en tant que type de données java.lang.Throwable.
6javax.servlet.error.servlet_name
Cet attribut donne le nom du Servlet, qui peut être stocké et analysé après avoir été stocké en tant que type de données java.lang.String.

Exemple de gestionnaire d'erreurs de Servlet

Ce qui suit est une instance de Servlet qui agira comme gestionnaire d'erreurs pour toutes les erreurs ou exceptions que vous définissez.

Cet exemple vous donne une compréhension de base de la gestion des exceptions dans les Servlets, et vous pouvez utiliser les mêmes concepts pour écrire des applications de gestion des exceptions plus complexes :

//导入必需的 java 库
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

//扩展 HttpServlet 类
public class ErrorHandler extends HttpServlet {

    // 处理 GET 方法请求的方法
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        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";
        }
        // 设置响应内容类型
        response.setContentType("text/html;charset=UTF-8");
    
        PrintWriter out = response.getWriter();
        String title = "Example Error/Exception 信息";
       
        String docType = "<!DOCTYPE html>\n";
        out.println(docType +
            "<html>\n" +
             "<head><title>" + title + "</title></head>\n" +
             "<body bgcolor=\"#F0F0F0\">\n");
           out.println("<h1>Example异常信息实例演示</h1>");
           if (throwable == null && statusCode == null){
              out.println("<h2>错误信息丢失</h2>");
              out.println("请返回 <a href=\"" + 
            response.encodeURL("http://localhost:8080/") + 
                "\">主页</a>。");
           }else if (statusCode != null) {
              out.println("错误代码 : " + statusCode);
        }else{
               out.println("<h2>错误信息</h2>");
              out.println("Servlet Name : " + servletName + 
                              "</br></br>");
              out.println("异常类型 : " + 
                              throwable.getClass( ).getName( ) + 
                              "</br></br>");
              out.println("请求 URI: " + requestUri + 
                              "<br><br>");
              out.println("异常信息: " + 
                                  throwable.getMessage( ));
           }
           out.println("</body>");
           out.println("</html>");
    }
    // 处理 POST 方法请求的方法
    public void doPost(HttpServletRequest request,
                      HttpServletResponse response)
       throws ServletException, IOException {
        doGet(request, response);
    }
}

Compilez de la manière habituelleErrorHandler.java, placez vos fichiers de classe dans <Tomcat-installation-directory>/webapps/ROOT/WEB-INF/classes.

Ajoutons la configuration suivante à web.xml pour gérer les exceptions :

<?xml version="1.0" encoding="UTF-8"?>  
<web-app>  
<servlet>
        <servlet-name>ErrorHandler</servlet-name>
        <servlet-class>com.example.test.ErrorHandler</servlet-class>
</servlet>
<!-- servlet mappings -->
<servlet-mapping>
        <servlet-name>ErrorHandler</servlet-name>
        <url-pattern>/TomcatTest/ErrorHandler</url-pattern>
</servlet-mapping>
<error-page>
    <error-code>404</error-code>
    <location>/TomcatTest/ErrorHandler</location>
</error-page>
<error-page>
    <exception-type>java.lang.Throwable</exception-type >
    <location>/ErrorHandler</location>
</error-page>
</web-app>  

Maintenant, essayez d'utiliser une Servlet qui lèvera une exception, ou saisissez une URL incorrecte, ce qui déclenchera l'invocation par le conteneur Web de la ServletErrorHandler, et affichera un message approprié. Par exemple, si vous saisissez une URL incorrecte (par exemple, http://localhost:8080/TomcatTest/UnKonwPage), cela affichera le résultat suivant :

Autres extensions