Servlet 例外處理


當一個 Servlet 拋出一個例外時,Web 容器在使用了 exception-type 元素的 web.xml 中搜尋與拋出例外類型相符的設定。

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

web.xml 配置

假設,有一個 ErrorHandler 的 Servelt 在任何已定義的例外狀況或錯誤出現時被呼叫。以下將是在 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 例外處理要注意的點:

  • Servelt ErrorHandler 與其他的Servelt 的定義方式一樣,且在web.xml 中進行設定。

  • 如果有錯誤狀態碼出現,不管為 404(Not Found 找不到)或 403(Forbidden 禁止),則會呼叫 ErrorHandler 的 Servlet。

  • 如果 Web 應用程式拋出 ServletExceptionIOException,那麼 Web 容器會呼叫 ErrorHandler 的 Servlet。

  • 您可以定義不同的錯誤處理程序來處理不同類型的錯誤或例外。上面的實例是非常通用的,希望您能透過實例理解基本的概念。

請求屬性 - 錯誤/異常

以下是錯誤處理的 Servlet 可以存取的請求屬性列表,用來分析錯誤/異常的性質。

23456

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
  {
      // 分析 Servlet 异常       
      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");
 
      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>");
  }
  // 处理 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 檔案中加入以下設定來處理例外:

<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,那麼它將顯示下面的結果:

The status code : 404

上面的程式碼在某些 Web 瀏覽器中可能無法正常運作。因此,請盡量嘗試使用 Mozilla 和 Safari 瀏覽器,在這兩種瀏覽器中它們應該能夠正常運作。

序號#屬性& 描述
#1##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 資料型別後可分析。