Latest web development tutorials

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應用程序拋出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 = "本教程 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>本教程异常信息实例演示</h1>");
	   	if (throwable == null && statusCode == null){
	      	out.println("<h2>错误信息丢失</h2>");
	      	out.println("请返回 <a href=\"" + 
	        response.encodeURL("../../localhost:8080/index.html") + 
	        	"\">主页</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.w3big.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），那麼它將顯示下面的結果：