Servlet 例外処理

web.xml 構成

仮に、あるErrorHandlerServlet が定義された例外またはエラー発生時に呼び出されるとします。以下は 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 がアクセスできるリクエスト属性のリストは次のとおりです。これらはエラー/例外の性質を分析するために使用されます。

番号	属性 & 説明
1	javax.servlet.error.status_code この属性はステータスコードを示します。ステータスコードは保存され、java.lang.Integer データ型として保存された後で分析できます。
2	javax.servlet.error.exception_type この属性は例外タイプの情報を示します。例外タイプは保存され、java.lang.Class データ型として保存された後で分析できます。
3	javax.servlet.error.message この属性は正確なエラーメッセージの情報を示します。情報は保存され、java.lang.String データ型として保存された後で分析できます。
4	javax.servlet.error.request_uri この属性は URL が Servlet を呼び出す際の情報を示します。情報は保存され、java.lang.String データ型として保存された後で分析できます。
5	javax.servlet.error.exception この属性は発生した例外に関する情報を示します。情報は保存され、java.lang.Throwable データ型として保存された後で分析できます。
6	javax.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("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.サンプル.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）を入力した場合、次の結果が表示されます：

その他の拡張