Servlet 异常处理

当一个 Servlet 抛出一个异常时，Web 容器在使用了 exception-type 元素的 web.xml 中搜索与抛出异常类型相匹配的配置。

您必须在 web.xml 中使用 error-page 元素来指定对特定异常 或 HTTP 状态码 作出相应的 Servlet 调用。

web.xml 配置

假设，有一个 ErrorHandler 的 Servlet 在任何已定义的异常或错误出现时被调用。以下将是在 web.xml 中创建的项。

  1. <!-- servlet 定义 -->
  2. <servlet>
  3.         <servlet-name>ErrorHandler</servlet-name>
  4.         <servlet-class>ErrorHandler</servlet-class>
  5. </servlet>
  6. <!-- servlet 映射 -->
  7. <servlet-mapping>
  8.         <servlet-name>ErrorHandler</servlet-name>
  9.         <url-pattern>/ErrorHandler</url-pattern>
  10. </servlet-mapping>
  12. <!-- error-code 相关的错误页面 -->
  13. <error-page>
  14.     <error-code>404</error-code>
  15.     <location>/ErrorHandler</location>
  16. </error-page>
  17. <error-page>
  18.     <error-code>403</error-code>
  19.     <location>/ErrorHandler</location>
  20. </error-page>
  22. <!-- exception-type 相关的错误页面 -->
  23. <error-page>
  24.     <exception-type>
  25.           javax.servlet.ServletException
  26.     </exception-type >
  27.     <location>/ErrorHandler</location>
  28. </error-page>
  30. <error-page>
  31.     <exception-type>java.io.IOException</exception-type >
  32.     <location>/ErrorHandler</location>
  33. </error-page>

如果您想对所有的异常有一个通用的错误处理程序，那么应该定义下面的 error-page，而不是为每个异常定义单独的 error-page 元素：

  1. <error-page>
  2.     <exception-type>java.lang.Throwable</exception-type >
  3.     <location>/ErrorHandler</location>
  4. </error-page>

以下是关于上面的 web.xml 异常处理要注意的点：

  • Servlet ErrorHandler 与其他的 Servlet 的定义方式一样，且在 web.xml 中进行配置。
  • 如果有错误状态代码出现，不管为 404（Not Found 未找到）或 403（Forbidden 禁止），则会调用 ErrorHandler 的 Servlet。
  • 如果 Web 应用程序抛出 ServletException 或 IOException，那么 Web 容器会调用 ErrorHandler 的 Servlet。
  • 您可以定义不同的错误处理程序来处理不同类型的错误或异常。上面的实例是非常通用的，希望您能通过实例理解基本的概念。

请求属性 - 错误/异常

以下是错误处理的 Servlet 可以访问的请求属性列表，用来分析错误/异常的性质。

序号属性 & 描述
1javax.servlet.error.status_code该属性给出状态码，状态码可被存储，并在存储为 java.lang.Integer 数据类型后可被分析。
2javax.servlet.error.exception_type该属性给出异常类型的信息，异常类型可被存储，并在存储为 java.lang.Class 数据类型后可被分析。
3javax.servlet.error.message该属性给出确切错误消息的信息，信息可被存储，并在存储为 java.lang.String 数据类型后可被分析。
4javax.servlet.error.request_uri该属性给出有关 URL 调用 Servlet 的信息，信息可被存储，并在存储为 java.lang.String 数据类型后可被分析。
5javax.servlet.error.exception该属性给出异常产生的信息，信息可被存储，并在存储为 java.lang.Throwable 数据类型后可被分析。
6javax.servlet.error.servlet_name该属性给出 Servlet 的名称，名称可被存储，并在存储为 java.lang.String 数据类型后可被分析。

Servlet 错误处理程序实例

以下是 Servlet 实例，将应对任何您所定义的错误或异常发生时的错误处理程序。

本实例让您对 Servlet 中的异常处理有基本的了解，您可以使用相同的概念编写更复杂的异常处理应用程序：

  1. //导入必需的 java 库
  2. import java.io.*;
  3. import javax.servlet.*;
  4. import javax.servlet.http.*;
  5. import java.util.*;
  7. //扩展 HttpServlet 类
  8. public class ErrorHandler extends HttpServlet {
  10.     // 处理 GET 方法请求的方法
  11.     public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
  12.     {
  13.         Throwable throwable = (Throwable)
  14.         request.getAttribute("javax.servlet.error.exception");
  15.         Integer statusCode = (Integer)
  16.         request.getAttribute("javax.servlet.error.status_code");
  17.         String servletName = (String)
  18.         request.getAttribute("javax.servlet.error.servlet_name");
  19.         if (servletName == null){
  20.             servletName = "Unknown";
  21.         }
  22.         String requestUri = (String)
  23.         request.getAttribute("javax.servlet.error.request_uri");
  24.         if (requestUri == null){
  25.             requestUri = "Unknown";
  26.         }
  27.         // 设置响应内容类型
  28.         response.setContentType("text/html;charset=UTF-8");
  30.         PrintWriter out = response.getWriter();
  31.         String title = "Servlet教程 Error/Exception 信息";
  33.         String docType = "<!DOCTYPE html>\n";
  34.         out.println(docType +
  35.             "<html>\n" +
  36.              "<head><title>" + title + "</title></head>\n" +
  37.              "<body bgcolor=\"#f0f0f0\">\n");
  38.            out.println("<h1>Servlet教程异常信息实例演示</h1>");
  39.            if (throwable == null && statusCode == null){
  40.               out.println("<h2>错误信息丢失</h2>");
  41.               out.println("请返回 <a href=\"" + 
  42.             response.encodeURL("http://localhost:8080/") + 
  43.                 "\">主页</a>。");
  44.            }else if (statusCode != null) {
  45.               out.println("错误代码 : " + statusCode);
  46.         }else{
  47.                out.println("<h2>错误信息</h2>");
  48.               out.println("Servlet Name : " + servletName + 
  49.                               "</br></br>");
  50.               out.println("异常类型 : " + 
  51.                               throwable.getClass( ).getName( ) + 
  52.                               "</br></br>");
  53.               out.println("请求 URI: " + requestUri + 
  54.                               "<br><br>");
  55.               out.println("异常信息: " + 
  56.                                   throwable.getMessage( ));
  57.            }
  58.            out.println("</body>");
  59.            out.println("</html>");
  60.     }
  61.     // 处理 POST 方法请求的方法
  62.     public void doPost(HttpServletRequest request,
  63.                       HttpServletResponse response)
  64.        throws ServletException, IOException {
  65.         doGet(request, response);
  66.     }
  67. }

以通常的方式编译 ErrorHandler.java，把您的类文件放入<Tomcat-installation-directory>/webapps/ROOT/WEB-INF/classes 中。

让我们在 web.xml 文件中添加如下配置来处理异常：

  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <web-app>  
  3. <servlet>
  4.         <servlet-name>ErrorHandler</servlet-name>
  5.         <servlet-class>com.servlet.test.ErrorHandler</servlet-class>
  6. </servlet>
  7. <!-- servlet mappings -->
  8. <servlet-mapping>
  9.         <servlet-name>ErrorHandler</servlet-name>
  10.         <url-pattern>/TomcatTest/ErrorHandler</url-pattern>
  11. </servlet-mapping>
  12. <error-page>
  13.     <error-code>404</error-code>
  14.     <location>/TomcatTest/ErrorHandler</location>
  15. </error-page>
  16. <error-page>
  17.     <exception-type>java.lang.Throwable</exception-type >
  18.     <location>/ErrorHandler</location>
  19. </error-page>
  20. </web-app>

现在，尝试使用一个会产生异常的 Servlet，或者输入一个错误的 URL，这将触发 Web 容器调用 ErrorHandler 的 Servlet，并显示适当的消息。例如，如果您输入了一个错误的 URL（如：http://localhost:8080/TomcatTest/UnKonwPage），那么它将显示下面的结果：

教程异常信息实例演示
错误代码：404