Servlet的异常处理

2024-02-05 08:19:29

以下内容引用自http://wiki.jikexueyuan.com/project/servlet/exception-handling.html：

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

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

一、web.xml配置

考虑这种情况，有一个ErrorHandler Servelt，当任何已定义的异常或错误出现时就会被调用。以下是要在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>

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

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

以下是异常处理中有关上述web.xml需要注意的点：

Servelt ErrorHandler与其他的Servelt的定义方式一样，且在web.xml中配置。
如果状态码有任何错误出现，不管是404（未找到）还是403（禁止），那么ErrorHandler Servlet会被调用。
如果Web应用程序抛出ServletException或IOException，那么Web容器就会调用ErrorHandler Servlet。
可以定义不同的错误处理程序来处理不同类型的错误或异常。

二、请求属性-错误/异常

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

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

三、Servlet错误处理程序实例

以下是Servlet实例，用于任何定义的Servlet出现任何错误或异常时的情况。

// 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);
  }
}

以常用的方式编译ErrorHandler.java并把类文件放入/webapps/ROOT/WEB-INF/classes中（注意：POM和Eclipse项目忽略这一步）。

将下述配置添加到web.xml文件中来处理异常：

<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>

现在，尝试使用一个会产生任何异常的Servlet或者输入一个错误的URL，这将触发Web容器调用ErrorHandler Servlet并显示适当的消息。例如，如果输入了一个错误的URL，那么它将显示如下所示的结果：

上述代码在一些Web浏览器中可能无法工作。因此请尝试使用Mozilla和Safari浏览器，这样上述代码应该能正常工作。

测试工程：https://github.com/easonjim/5_java_example/tree/master/servletbasics/test7

码农公寓

相关文章