Servlet 3.1 异常处理 - Servlet 基础教程

当一个 Servlet 抛出一个异常时，Web 容器会在 web.xml 中的 <exception-type> 内搜索与抛出异常类型相匹配的配置

我们必须自 web.xml 中使用 <error-page> 元素来指定对特定异常或 HTTP 状态码 作出相应的 Servlet 调用

web.xml 配置

假设，有一个 cn.twle.demo.ErrorHandlerServlet 的 Servlet 在任何已定义的异常或错误出现时被调用

那么 web.xml 的配置如下

<!-- error-code 相关的错误页面 -->
<error-page>
    <error-code>404</error-code>
    <location>/error</location>
</error-page>
<error-page>
    <error-code>403</error-code>
    <location>/error</location>
</error-page>

<!-- exception-type 相关的错误页面 -->
<error-page>
    <exception-type>
          javax.servlet.ServletException
    </exception-type >
    <location>/error</location>
</error-page>

<error-page>
    <exception-type>java.io.IOException</exception-type >
    <location>/error</location>
</error-page>

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

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

以下是关于上面的 web.xml 异常处理要注意的点：

如果有错误状态代码出现，不管为 404（Not Found 未找到）或 403（Forbidden 禁止），则会转发到 /error 的 servlet
如果 Web 应用程序抛出 ServletException 或 IOException ，那么 Web 容器会调用 /error 的 servlet
可以定义不同的错误处理程序来处理不同类型的错误或异常

Servlet 3.1 请求属性 - 错误/异常

以下是错误处理的 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 3.1 错误处理程序范例

下面的范例演示了应对任何所定义的错误或异常发生时的错误处理程序。

// author: 简单教程(www.twle.cn)
// Copyright © 2015-2065 www.twle.cn. All rights reserved.

package cn.twle.demo;

import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import javax.servlet.annotation.WebServlet;
import java.text.SimpleDateFormat;
import java.util.Date;


@WebServlet(name = "ErrorHandlerServlet", urlPatterns = {"error"})
//扩展 HttpServlet 类
public class ErrorHandlerServlet extends HttpServlet 
{
    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 信息 | 简单教程(www.twle.cn)";

        String docType = "<!DOCTYPE html>\n";
        out.println(docType +
            "<title>" + title + "</title>" +
            "<body bgcolor=\"#f0f0f0\">\n");

        out.println("<p>" + title + "</p>");
        out.println("<p>简单教程异常信息范例演示</p>");


        if (throwable == null && statusCode == null)
        {
            out.println("<h3>错误信息丢失</h3>");
            out.println("请返回 <a href=\"" +
                response.encodeURL("http://localhost:8080/servlet/") +
                "\">主页</a>。");
        }
        else if (statusCode != null)
        {
            out.println("错误代码 : " + statusCode);
        }
        else
        {
            out.println("<h4>错误信息</h4>");
            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>");
    }
}

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
                      http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  version="3.1">

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

</web-app>

在浏览器上输入 http://localhost:8080/servlet/let_s_error

因为我们没有定义 /servlet/let_s_error URL 的 servlet，这将触发 Web 容器调用 /error 的 servlet : ErrorHandlerServlet ，并显示适当的消息