如何在不向用户显示堆栈跟踪的情况下处理servlet过滤器中的错误状态?

时间:2013-02-08 22:12:18

标签: java jetty servlet-filters resteasy

我正在研究Jetty / RESTEasy应用。如果我从我的一个REST端点抛出WebApplicationException(myResponse),它会将给定的响应发送给客户端。

当过滤器检测到错误时,我想要相同的行为:

  1. 它应该从继续执行停止执行,
  2. 它应该为用户提供一个明确的,JSON格式的错误,不包括堆栈跟踪。
  3. 显然,只需在return方法中写入响应流和doFilter即可。但这不适用于doFilter调用的其他方法。

    抛出任何异常将符合条件#1但我还没有想出一个理智的方式来满足条件#2。 (你可以在底部看到我最好的尝试。)

    正如Perception在他的回答中解释的那样,WebApplicationException被视为在Filter的上下文中的任何其他异常,因此给用户一个漂亮的丑陋堆栈跟踪。

    所以,总结一下我的问题:

    • serveltt容器是否等同于throw new WebApplicationException(Response)
    • 也许更重要的是,其他java项目如何处理这个?

    我在一个过滤器中有这个代码并且它可以工作,但我更喜欢一个更优雅的解决方案,它自动应用于所有过滤器:

    public void doFilter(final ServletRequest   request, final ServletResponse response, final FilterChain chain) throws IOException, ServletException {
        try {
            doFilterOrThrow(request, response, chain);
        } catch (WebApplicationException e) {
            Response res = e.getResponse();
            ((HttpServletResponse) response).sendError(res.getStatus(), (String) res.getEntity());
        }
    }
    

1 个答案:

答案 0 :(得分:7)

您提到的Web应用程序异常的具体处理仅在JAX-RS容器的上下文中定义,顺便说一句, 同样的事情作为Servlet容器。

Web过滤器由Servlet容器处理,该容器不知道或不关心同一应用程序服务器中是否存在JAX-RS容器。它也不知道或不关心Web应用程序异常。因此,当您从过滤器中抛出WAE时,它被视为与任何其他异常相同(带有堆栈跟踪的服务器错误,或者如果您在Web应用程序中设置了一个预配置的错误页面)。

在我看来,如果您通过过滤器向客户端指示错误,您可以直接写入响应流。但是,如果您尝试利用一些现有的JAX-RS逻辑,那么(RESTEasy特定的)解决方案是将请求标记为过滤器中的错误,然后使用提供程序类在JAX-RS中生成WAE。例如:

@WebFilter(urlPatterns = "*")
public class ForwardingFilter implements Filter {

    @Override
    public void destroy() {
        return;
    }

    @Override
    public void doFilter(final ServletRequest request,
            final ServletResponse response, final FilterChain chain)
            throws IOException, ServletException {
        // Add an error response to be processed by the JAX-RS container.
        // This would obviously be based on some condition.
        request.setAttribute("errorResponse",
                Response.status(500).entity("Didn't work out!").build());
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        return;
    }
}

@Provider
@ServerInterceptor
@HeaderDecoratorPrecedence
@RequestScoped
public class ForwardingHandlerProvider implements PreProcessInterceptor {

    @Override
    public ServerResponse preProcess(final HttpRequest request,
            final ResourceMethod method) throws Failure,
            WebApplicationException {
        final Response errorResponse = (Response) request
                .getAttribute("errorResponse");
        if (errorResponse != null)
            throw new WebApplicationException(errorResponse);
        return null;
    }
}

由于提供程序存在于JAX-RS域中,因此根据JAX-RS规范的第3.3.4节的规则处理Web应用程序异常,并在客户端获得所需的响应。

*编辑:*

最重要的是,没有标准的Java EE规定方式(当前)以集中方式处理servlet异常,类似于JAX-RS中可用的方式。既然您正在使用JBoss / RestEASY,那么您可以利用JBoss Seam Catch库来获得非常接近的结果。

@HandlesExceptions
public class ExceptionHandler {
    public void handleServletException(
            final @Handles @WebRequest CaughtException<ServletException> caught,
            @Context final HttpServletResponse response) {
        try {
            response.sendError(500, "An error occured");
        } catch (final IOException ioe) {
            System.err.println("Dumb IO Exception: " + ioe);
        }
    }
}

上面说明了一个异常处理程序,如Seam Catch documentation中所述。请注意,图书馆目前处于巨大变化之中,因此您只想将其作为最后的手段使用。