Tomcat自定义异常页面

发表于 分类于 阅读次数： 本文字数： 332 阅读时长 ≈ 1 分钟

前言

Tomcat在抛出异常的时候会自动跳转到带有异常堆栈的错误页面, 这很容易暴露自己的代码。

Tomcat的原生解决方案

在项目的/WEB-INF/web.xml中指定自定义的默认页面即可, 并且该页面要与WEB-INF文件夹放在同一个目录下。
如果是Servlet 2.5, 还需要指定Http状态码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<web-app>
    <!-- 支持Servlet 2.5+, 如果要对状态码特别指定页面, 需要按顺序排列error-page标签  -->
    <error-page>
        <error-code>500</error-code>
        <location>/500.jsp</location>
    </error-page>

    <!-- 支持Servlet 3  -->
    <error-page>
        <location>/Error.jsp</location>
    </error-page>
    <error-page>
        <exception-type>java.lang.Exception</exception-type>
        <location>/Error.jsp</location>
    </error-page>
</web-app>

SpringMVC的解决方案

Tomcat的解决方案局限性太大, 也不能做逻辑处理记录到数据库之类的操作。

使用ControllerAdvice进行拦截, 并处理逻辑, 也可以重定向到其他页面。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@ControllerAdvice
public class ErrorController {
    private static final Logger logger = LoggerFactory.getLogger(ErrorController.class);

    @ExceptionHandler(Exception.class)
    public void handleConflict(HttpServletRequest request, HttpServletResponse response, Exception e) throws Exception {
        // 如果使用@ResponseStatus注释异常，则重新抛出该异常并让框架处理该异常
        if (AnnotationUtils.findAnnotation(e.getClass(), ResponseStatus.class) != null) {
            throw e;
        }

        logger.error("发生了错误", e);
        // 逻辑操作, 记录到数据库等

        // 设置状态码, 并输出错误信息
        response.setStatus(500);
        response.getWriter().println(e.getMessage());
    }
}

参考资料