Servlet 異常處理

當一個 Servlet 拋出一個異常時，Web 容器在使用了 exception-type 元素的 web.xml 中搜索與拋出異常類型相匹配的配置。

您必須在 web.xml 中使用 error-page 元素來指定對特定異常 或 HTTP 狀態碼 作出相應的 Servlet 調用。

web.xml 配置

假設，有一個 ErrorHandler 的 Servlet 在任何已定義的異常或錯誤出現時被調用。以下將是在 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>

如果您想對所有的異常有一個通用的錯誤處理程式，那麼應該定義下麵的 error-page，而不是為每個異常定義單獨的 error-page 元素：

<error-page>
    <exception-type>java.lang.Throwable</exception-type >
    <location>/ErrorHandler</location>
</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 中的異常處理有基本的瞭解，您可以使用相同的概念編寫更複雜的異常處理應用程式：

//導入必需的 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 = "IT研修 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>IT研修異常資訊實例演示</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);
    }
}

以通常的方式編譯 ErrorHandler.java，把您的類檔放入<Tomcat-installation-directory>/webapps/ROOT/WEB-INF/classes 中。

讓我們在 web.xml 檔中添加如下配置來處理異常：

<?xml version="1.0" encoding="UTF-8"?>
<web-app>
<servlet>
        <servlet-name>ErrorHandler</servlet-name>
        <servlet-class>com.zaixian.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>

現在，嘗試使用一個會產生異常的 Servlet，或者輸入一個錯誤的 URL，這將觸發 Web 容器調用 ErrorHandler 的 Servlet，並顯示適當的消息。例如，如果您輸入了一個錯誤的 URL（如：http://localhost:8080/TomcatTest/UnKonwPage），那麼它將顯示下麵的結果：