Websphere Liberty 上的 JAX-RS 异常处理

Question

我需要一些帮助来了解 Websphere Liberty (18.0.0.1) 如何处理 JAX-RS 端点调用中抛出的异常。我正在使用 Liberty 功能 jaxrs-2.0，因此实施应由 WLP 提供。

现在，我的应用程序有一个 POST 接受 JSON 负载的 HTTP 端点，我想为所有可能的错误客户端输入提供自定义错误消息。

这是一个以我预期的方式工作的案例：

客户端发送 application/xml 而不是 application/json
容器抛出了一个ClientErrorException
我可以使用我自己的异常映射器（实现 ExceptionMapper<WebApplicationException> 来处理这个异常（实际上是为了处理所有的 Web 应用程序异常，我对此很满意）
这样我就可以格式化错误消息，用 ID 标记错误，无论需要什么。不错

这种情况不适合我：

客户端发送 application/json，但正文为空
这种情况下的核心异常是 java.io.EOFException: No content to map to Object due to end of input - 是的，看起来很准确
现在我想不通的是 - WLP 没有将这个 EOFException 包装成某种 WebApplicationException（我可以轻松处理），而是将异常问题包装成 JaxRsRuntimeException

这里有几点：

我不想创建实现 ExceptionMapper<JaxRsRuntimeException> 的映射器，因为该异常不是 JAX-RS 2.0 规范的一部分，我必须提供对 JaxRsRuntimeException 的导入并将应用程序与一些特定于 Liberty 的库。
一个可能的解决方案是让我的映射器实现一个泛型 ExceptionMapper<RuntimeException> 和字符串检查它是否发现类名异常 'JaxRsRuntimeException' 然后处理它。但这对我来说似乎不对。

那么，在这种情况下，WLP 设计是否不给我 WebApplicationException？处理这种情况的优雅解决方案是什么？

谢谢

编辑：添加了部分源代码。

REST 端点和资源方法：

@Path("/books")
public class BookEndpoint {

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    public Response createBook(Book book, @Context UriInfo uriInfo) {
        bookDao.create(book);
        UriBuilder builder = uriInfo.getAbsolutePathBuilder();
        builder.path(Integer.toString(book.getId()));
        return Response.created(builder.build()).entity(book).build();
    }
}

带有 JAXB 注释的实体：

@XmlRootElement
public class Book {

    private int id;
    private String title;

    // getters, setters
}

异常堆栈跟踪：

com.ibm.ws.jaxrs20.JaxRsRuntimeException: java.io.EOFException: No content to map to Object duto end of input
    at org.apache.cxf.jaxrs.utils.JAXRSUtils.toJaxRsRuntimeException(JAXRSUtils.java:1928)
    at [internal classes]
    at org.apache.logging.log4j.web.Log4jServletFilter.doFilter(Log4jServletFilter.java:71)
    at com.ibm.ws.webcontainer.filter.FilterInstanceWrapper.doFilter(FilterInstanceWrapper.java:201)
    at [internal classes]
    at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
    at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
    at java.lang.Thread.run(Thread.java:745)
Caused by: java.io.EOFException: No content to map to Object duto end of input
    at org.codehaus.jackson.map.ObjectMapper._initForReading(ObjectMapper.java:2775)
    at [internal classes]
    at java.security.AccessController.doPrivileged(Native Method)
    at org.apache.cxf.jaxrs.utils.JAXRSUtils.readFromMessageBodyReader(JAXRSUtils.java:1413)
    at [internal classes]
    ... 48 more

Answer 1

不是 "why WLP wrap the exception ..etc" 上的直接答案，但可能会像您所做的那样添加一个异常拦截器，但是在 "ExceptionMapper<Exception>" 上并递归迭代 "causes" 检查 java.io.EOFException 是否是其中之一...

Answer 2

这是基于 JAX-RS 2.0 Spec 的第 3.3.4 节（和 4.5.1）的预期行为。这些部分描述了如何处理来自 JAX-RS 资源和提供程序的异常 - 简而言之：

如果异常是WebApplicationException，那么它会自动映射到Response。
如果注册了 ExceptionMapper 可以处理抛出的异常，那么它将用于生成响应。
未经检查的异常被传播到容器（即 Liberty 的 JAX-RS 实现代码）。
未映射的异常必须通过特定于容器的异常处理，然后适当地传播到底层容器 - 在这种情况下，必须将 ServletException 传递到 Web 容器。

JaxRsRuntimeException用于满足步骤4。

在这种情况下，内置 JSON 提供程序（基于 Jackson 1.X）正在抛出 EOFException。由于 EOFException（或其任何超类）没有异常映射器，因此它最终通过 JaxRsRuntimeException 映射到 ServletException。

为了让应用程序处理这种情况，有几个不同的选项：

您可以注册特定于此异常类型的 ExceptionMapper（EOFException 或其任何超类 - 即 IOException）。您不需要为 JaxRsRuntimeException 注册映射器，因为该异常仅在 Liberty 内部使用 - 不应进行映射。如果您看到 JaxRsRuntimeException 传递给 ExceptionMapper，那么您应该向 IBM 提交支持案例，因为这可能是一个错误。

使用 ExceptionMapper<EOFException>，您可以 return 每当从提供程序或资源中抛出 EOFException 时的特定响应。

您可以注册自己的 MessageBodyReader，它将 JSON 转换为对象（使用 Jackson 或任何其他 JSON 序列化代码），但它将按照您的方式处理空消息体想要 - 例如，将其转换为 null 或使用某种默认对象实例。由于用户注册的提供程序优先于内置提供程序，因此将使用此 MBR 而不是 Liberty 的基于 Jackson 的 MBR。

这种方法绝对可以让您更好地控制数据的反序列化方式以及异常处理。

注册一个 ContainerRequestFilter 提供程序，它将在消息正文为空时中止。这是一个例子：

@Provider
public class EmptyBodyCheckFilter implements ContainerRequestFilter {

    @Override
    public void filter(ContainerRequestContext crc) throws IOException {
        if (crc.getEntityStream().available() < 1) {
            crc.abortWith(Response.status(400).entity("Invalid request - empty message body").build());
        }
    }
}

我已经使用 WebSphere Liberty 2018 年 5 月测试版成功测试了选项 1 和 3。我没有针对这种情况亲自测试选项 2，但基于过去使用自定义 MBR，这应该可行。

要记住的一件事是，当 Liberty GA 具有 jaxrs-2.1 功能时，它将使用 JSONB 作为 serializing/deserializing JSON 的内置提供程序而不是杰克逊。我使用 JAX-RS 2.1（也在 5 月 Beta 中）测试了您的场景，JSONB 代码抛出 NoSuchElementException 而不是 EOFException。如果您认为您可能转向 JAX-RS 2.1，那么我会建议选项 2 或 3。选项 1 要求您为 JAX-RS 2.1 创建一个新的 ExceptionMapper。

希望这对您有所帮助，

安迪

Websphere Liberty 上的 JAX-RS 异常处理

JAX-RS exception handling on Websphere Liberty

java

jax-rs

websphere-liberty

open-liberty