Websphere Liberty上的JAX-RS异常处理

Question

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

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

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

1. 客户端发送application/xml而不是application/json
2. 有一个ClientErrorException由容器抛出
3. 我可以使用自己的异常映射器(实现ExceptionMapper<WebApplicationException>处理此异常(实际上是为了处理所有Web应用程序异常,我很好)
4. 这样我就可以格式化错误消息,用ID标记错误,无论需要什么.非常好

以下是不适合我的情况:

1. 客户端发送application/json,但空体
2. 在这种情况下的核心例外是java.io.EOFException: No content to map to Object due to end of input- 是的,这看起来很准确
3. 现在我无法弄清楚 - 而不是将其包装EOFException成某种WebApplicationException(我可以轻松处理),WLP将异常问题包装成JaxRsRuntimeException

这里有几点:

• 我不想创建一个mapper实现,ExceptionMapper<JaxRsRuntimeException>因为该异常不是JAX-RS 2.0规范的一部分,我必须提供导入到JaxRsRuntimeException并将应用程序与一些Liberty特定的库连接起来.
• 一个可能的解决方案是让mapper实现泛型ExceptionMapper<RuntimeException>和字符串检查,如果它找到classname'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

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

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

用于JaxRsRuntimeException满足步骤 4。

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

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

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

使用 an ，只要提供者或资源抛出ExceptionMapper<EOFException>an ，您就可以返回特定的响应。EOFException

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

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

3. 注册一个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 月 Beta 成功测试了选项 1 和 3。我还没有亲自测试过此场景的选项 2，但根据过去使用自定义 MBR 的情况，这应该可行。

需要记住的一件事是，当 Liberty 发布该jaxrs-2.1功能时，它将使用 JSONB 作为内置提供程序来序列化/反序列化 JSON，而不是 Jackson。我使用 JAX-RS 2.1（也在 5 月 Beta 版中）测试了您的场景EOFException，JSONB 代码抛出的不是NoSuchElementException. 如果您认为您可能会迁移到 JAX-RS 2.1，那么我会建议选项 2 或 3。选项 1 要求您ExceptionMapper为 JAX-RS 2.1 创建一个新的。

希望这可以帮助，

安迪