Servlet JSP Tutorial -- 1.7 Servlet Exception and Error Handling Example Tutorial

逃离我推掉我的手 2022-06-02 09:48 220阅读 0赞

今天我们将学习 Servlet 异常和错误处理。之前我写了一篇关于 Java 异常处理的文章，但是当涉及到 web 应用程序时，我们需要在 Java 中处理更多的异常处理。

## Servlet Exception ##

如果您注意到 doGet() 和 doPost() 方法会抛出 javax.servlet.ServletException 和 IOException，那么让我们看看在从应用程序中抛出这些异常时会发生什么。我将写一个简单的 servlet 来抛出ServletException。

package com.journaldev.servlet.exception;
    
    import java.io.IOException;
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @WebServlet("/MyExceptionServlet")
    public class MyExceptionServlet extends HttpServlet { 
        private static final long serialVersionUID = 1L;
    
        protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            throw new ServletException("GET method is not supported.");
        }
    
    }

现在当我们用 GET 方法通过浏览器调用这个 servlet 时，我们得到如下图像的响应。  
![这里写图片描述][SouthEast]  
由于浏览器只能理解 HTML，所以当我们的应用程序抛出异常时，servlet 容器会处理异常并生成一个 HTML 响应。这个逻辑是特定于 Servlet 容器的。我使用 Tomcat 并获取到了这个异常页面。如果你使用别的服务器（如 JBoss 或 GlassFish），那么可能会得到不同的 HTML 响应。

这个响应的问题在于它对用户没有任何价值。而且它向用户显示我们应用程序类和服务器详细信息，这对用户来说是没有意义的，从安全的角度来看它是不好的。

### Servlet Error ###

我相信，当你尝试一点一个不存在的 URL 时，你一定看到了 404 错误。让我们看看我们的 Servlet 容器如何响应 404 错误。如果我们发送一个无效 URL 请求，我们得到如下图像的响应 HTML。  
![这里写图片描述][SouthEast 1]  
同样，这也是我们应用程序由服务器生成的通用 HTML，并且对用户几乎没有任何价值。

### Servlet Exception and Error Handling ###

Servlet API 提供自定义异常和错误处理 servlet 的支持，我们可以在部署描述符中配置。这些 servlet 的目的都是处理由应用程序引发的异常或错误，并向用户发送有用的 HTML 响应。我们可以提供链接到应用程序主页或一些细节去让用户知道哪里出了问题。

首先我们需要创建一个自定义的 Exception and Error Handler servlet。我们剋为应用程序提供多个异常和错误处理 servlet，但为了简单起见，我将创建一个 servlet 并将其用于异常和错误。

AppExceptionHandler.java

package com.journaldev.servlet.exception;
    
    import java.io.IOException;
    import java.io.PrintWriter;
    
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @WebServlet("/AppExceptionHandler")
    public class AppExceptionHandler extends HttpServlet {
        private static final long serialVersionUID = 1L;
    
        protected void doGet(HttpServletRequest request,
                             HttpServletResponse response) throws IOException {
            processError(request, response);
        }
    
        protected void doPost(HttpServletRequest request,
                              HttpServletResponse response) throws IOException {
            processError(request, response);
        }
    
        private void processError(HttpServletRequest request,
                                  HttpServletResponse response) throws IOException {
            // Analyze the servlet exception
            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";
            }
    
            // Set response content type
            response.setContentType("text/html");
    
            PrintWriter out = response.getWriter();
            out.write("<html><head><title>Exception/Error Details</title></head><body>");
            if (statusCode != 500) {
                out.write("<h3>Error Details</h3>");
                out.write("<strong>Status Code</strong>:" + statusCode + "<br>");
                out.write("<strong>Requested URI</strong>:" + requestUri);
            } else {
                out.write("<h3>Exception Details</h3>");
                out.write("<ul><li>Servlet Name:" + servletName + "</li>");
                out.write("<li>Exception Name:" + throwable.getClass().getName() + "</li>");
                out.write("<li>Requested URI:" + requestUri + "</li>");
                out.write("<li>Exception Message:" + throwable.getMessage() + "</li>");
                out.write("</ul>");
            }
    
            out.write("<br><br>");
            out.write("<a href=\"index.html\">Home Page</a>");
            out.write("</body></html>");
        }
    }

让我们看看如何在配置描述符中配置它，然后我们将了解它的实现以及它的工作原理。

<?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">
        <display-name>ServletExceptionHandling</display-name>
        <welcome-file-list>
            <welcome-file>index.html</welcome-file>
        </welcome-file-list>
    
        <error-page>
            <error-code>404</error-code>
            <location>/AppExceptionHandler</location>
        </error-page>
    
        <error-page>
            <exception-type>javax.servlet.ServletException</exception-type>
            <location>/AppExceptionHandler</location>
        </error-page>
    </web-app>

正如你所见，使用错误也i按元素为应用程序指定异常处理 servlet 非常容易。每个错误页面元素应该由错误带货或异常类型的元素。我们在 location 元素中定义异常处理 servlet。

基于上述配置，如果应用程序抛出 404 错误或 ServletException，它将由 AppExceptionHandler servlet 处理。

当出现这样的异常和错误时，servlet 容器将调用异常处理 servlet的相应 HTTP 方法并传递请求和相应对象。注意，我已经提供了 doGet() 和 doPost() 方法的实现，以便它可以处理 GET 和 POST 请求，并通过通用的方法来处理它们。

在 servlet 容器调用 servlet 处理异常之前，它会在请求中设置一些属性来获取有关异常的有用信息，其中一些属性是 **javax.servlet.error.exception**、**javax.servlet.error.status\_code**、**javax.servlet.error.servlet\_name** 以及 **javax.servlet.error.request\_uri**。

对于异常，状态码始终为 500，对应“内部服务器错误”。对于其他类型的错误，我们得到不同的错误代码，如 404、403 等

使用状态吗，我们实现向用户展示不同类型的 HML 相应。它还提供了到应用程序主页的超链接。

现在，当我们调用 servlet 并抛出 ServletException，我们将得到像下面图像的响应。  
![这里写图片描述][SouthEast 2]

如果我们尝试访问将导致 404 响应的无效URL，我们将得到如下图所示的响应。  
![这里写图片描述][SouthEast 3]

看起啦不错吧？并帮助用户轻松了解发生了什么，为他们提供了一个方法去正确的位置。它也避免了向用户发送应用程序敏感信息。我们应该总是有我们的 Web 应用程序的异常处理程序。

如果要在单个异常处理程序中处理运行时异常和所有其他异常，则可以将异常类型提供为 Throwable。

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

如果有多个错误页面条目，一个用于Throwable，另一个用于IOException，然后应用程序抛出 FileNotFoundException，那么它将由 IOException 的错误处理程序处理。

您也可以使用 JSP 页面作为异常处理程序，只提供 JSP 文件的位置而不是servlet映射。

这就是 Web 应用程序中 servlet 异常处理的全部内容，我希望你喜欢它。

Check out other articles in this series:

1.  Java Web Application
2.  Java Servlet Tutorial
3.  Session Management in Java
4.  Servlet Filter
5.  Servlet Listeners
6.  Cookies in Servlets
7.  Servlet File Upload and Download Example

[SouthEast]: /images/20220602/45e5ab097ce94733bc7e9a845e9aec12.png
[SouthEast 1]: /images/20220602/b854b758bb2c4ee59a52e528d999630f.png
[SouthEast 2]: /images/20220602/f874d2e781a04989aa945c757aa1529c.png
[SouthEast 3]: /images/20220602/ccad366417184e5b944539ac71ea1600.png