java - 从 Glassfish 4.1 中的 Object.afterUnmarshal 捕获异常

Question

我目前在 JDK 1.8.0-40 上运行 Glassfish 4.1。我正在使用 javaee-web-api-7.0 和 jersey-media-moxy-2.22。我正在从 JAXB 注释的 java 对象编码/解码 JSON 和 XML。

我有一个ContextResolver<Unmarshaller>设置提供 Unmarshaller与定制ValidationEventHandler它将从属性 setter 收集异常并抛出 BadRequestException与聚合验证错误。这部分正在工作。

不过，我还有beforeMarshal和afterUnmarshal检查未设置属性的对象上的方法(必须设置属性的规则因属性值而异，导致我排除针对架构的验证)。如果从afterUnmarshal抛出异常方法，ValidationEventHandler看不到它相反，冒泡到 ExceptionMapper .

有没有办法捕获 beforeMarshal 中的异常和afterUnmarshal单个对象上的方法并将它们获取到 ValidationEventHandler ？

我认为可以实现 MessageBodyReader要捕获异常，请使用 Unmarshaller.getEventHandler ，手动调用ValidationEventHandler.handleEvent ，然后抛出 BadRequestException <罢工>如果 handleEvent返回 false [编辑:如果从 Unmarshaller.unmarshal 抛出异常，不可能继续解码，因此唯一可能的办法是终止处理]。但这会丢失事件位置信息，而且我并不特别喜欢实现我自己的 MessageBodyReader 。我希望有一种我尚未发现的更简单的内置方法可以做到这一点。

预先感谢您的帮助。

Answer 1

经过一番挖掘和头痛之后，我最终开发出了一个解决方案。

第 1 步(可选)

编辑:您无需修补 Jersey 即可实现此行为。我找不到任何地方记录它，但 org.glassfish.jersey.internal.inject.Custom注释将提供程序标记为自定义(而 @Provider 单独是不够的)。您还必须通过设置 CommonProperties.MOXY_JSON_FEATURE_DISABLE 来禁用 MOXy如果您的提供商是 application/json 则为 true 。因此你只需要做:

@Custom
@Provider
public class MyCustomMessageBodyReader...
[...]

<罢工>这是我的解决方案中我最不喜欢的部分，但也使我免于一堆代码重复。 Jersey 的排序算法选择MessageBodyReader/Writers无法确定应用程序提供商的优先级(我可以找到)。我想延长 AbstractRootElementJaxbProvider重用其功能，但这意味着我无法使其比 Jersey 提供的 XmlRootElementJaxbProvider 更具体。 。由于默认情况下 Jersey 仅根据媒体类型距离、对象类型距离以及提供程序是否注册为自定义提供程序(通过 @Provider 注释检测到的提供程序未注册为自定义提供程序)进行排序，因此始终会选择 Jersey 实现而不是我的MessageBodyReader/Writer 。

<罢工>

我从 Github 查看了 Jersey 2.10.4 源代码并修补了 MessageBodyFactory利用 @Priority注释作为 MessageBodyReader/Writers的选择算法的一部分。

diff --git a/core-common/src/main/java/org/glassfish/jersey/message/internal/MessageBodyFactory.java b/core-common/src/main/java/org/glassfish/jersey/message/internal/MessageBodyFactory.java
index 3845b0c..110f18c 100644
--- a/core-common/src/main/java/org/glassfish/jersey/message/internal/MessageBodyFactory.java
+++ b/core-common/src/main/java/org/glassfish/jersey/message/internal/MessageBodyFactory.java
@@ -72,6 +72,7 @@ import javax.ws.rs.ext.MessageBodyWriter;
 import javax.ws.rs.ext.ReaderInterceptor;
 import javax.ws.rs.ext.WriterInterceptor;

+import javax.annotation.Priority;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import javax.xml.transform.Source;
@@ -107,6 +108,8 @@ import jersey.repackaged.com.google.common.primitives.Primitives;
  */
 public class MessageBodyFactory implements MessageBodyWorkers {

+    private static final int DEFAULT_WORKER_PRIORITY = 1000;
+
     private static final Logger LOGGER = Logger.getLogger(MessageBodyFactory.class.getName());

     /**
@@ -218,13 +221,15 @@ public class MessageBodyFactory implements MessageBodyWorkers {
         public final T provider;
         public final List<MediaType> types;
         public final Boolean custom;
+        public final int priority;
         public final Class<?> providerClassParam;

         protected WorkerModel(
-                final T provider, final List<MediaType> types, final Boolean custom, Class<T> providerType) {
+                final T provider, final List<MediaType> types, final Boolean custom, final int priority, Class<T> providerType) {
             this.provider = provider;
             this.types = types;
             this.custom = custom;
+            this.priority = priority;
             this.providerClassParam = getProviderClassParam(provider, providerType);
         }

@@ -239,8 +244,8 @@ public class MessageBodyFactory implements MessageBodyWorkers {

     private static class MbrModel extends WorkerModel<MessageBodyReader> {

-        public MbrModel(MessageBodyReader provider, List<MediaType> types, Boolean custom) {
-            super(provider, types, custom, MessageBodyReader.class);
+        public MbrModel(MessageBodyReader provider, List<MediaType> types, Boolean custom, int priority) {
+            super(provider, types, custom, priority, MessageBodyReader.class);
         }

         public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
@@ -263,8 +268,8 @@ public class MessageBodyFactory implements MessageBodyWorkers {

     private static class MbwModel extends WorkerModel<MessageBodyWriter> {

-        public MbwModel(MessageBodyWriter provider, List<MediaType> types, Boolean custom) {
-            super(provider, types, custom, MessageBodyWriter.class);
+        public MbwModel(MessageBodyWriter provider, List<MediaType> types, Boolean custom, int priority) {
+            super(provider, types, custom, priority, MessageBodyWriter.class);
         }

         public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
@@ -437,6 +442,10 @@ public class MessageBodyFactory implements MessageBodyWorkers {
             if (modelA.custom ^ modelB.custom) {
                 return (modelA.custom) ? -1 : 1;
             }
+
+            if(modelA.priority != modelB.priority) {
+                return modelA.priority - modelB.priority;
+            }
             return 0;
         }

@@ -578,17 +587,27 @@ public class MessageBodyFactory implements MessageBodyWorkers {
         }
     }

+    private static int getPriority(Priority annotation) {
+        if (annotation == null) {
+            return DEFAULT_WORKER_PRIORITY;
+        }
+
+        return annotation.value();
+    }
+
     private static void addReaders(List<MbrModel> models, Set<MessageBodyReader> readers, boolean custom) {
         for (MessageBodyReader provider : readers) {
+            int priority = getPriority(provider.getClass().getAnnotation(Priority.class));
             List<MediaType> values = MediaTypes.createFrom(provider.getClass().getAnnotation(Consumes.class));
-            models.add(new MbrModel(provider, values, custom));
+            models.add(new MbrModel(provider, values, custom, priority));
         }
     }

     private static void addWriters(List<MbwModel> models, Set<MessageBodyWriter> writers, boolean custom) {
         for (MessageBodyWriter provider : writers) {
+            int priority = getPriority(provider.getClass().getAnnotation(Priority.class));
             List<MediaType> values = MediaTypes.createFrom(provider.getClass().getAnnotation(Produces.class));
-            models.add(new MbwModel(provider, values, custom));
+            models.add(new MbwModel(provider, values, custom, priority));
         }
     }

<罢工>构建 Jersey 后，我用我的修补版本替换了 Glassfish 模块目录中的 jersey-common jar。这让我可以注释我的 MessageBodyReader/Writers与 @Priority(500)并让他们被 Jersey 选中。

我觉得这是让我优先考虑 MessageBodyReader/Writers 的最干净的方式。不影响 Glassfish 中依赖 Jersey 的任何其他内容。

第 2 步

灵感来自 this post我决定使用 Unmarshaller.Listener会比我原来的实现路径 afterUnmarshal 更干净我的每个 JAXB 类(class)。我制作了一个接口(interface)( CanBeValidated )并扩展了 Unmarshaller.Listener如下。

public final class ValidatingUnmarshallerListener
        extends Unmarshaller.Listener
{
    private final ValidationEventHandler validationEventHandler;

    public ValidatingUnmarshallerListener(
            ValidationEventHandler validationEventHandler)
    {
        this.validationEventHandler = validationEventHandler;
    }

    @Override
    public void afterUnmarshal(Object target, Object parent)
    {
        if (target == null
                || !(target instanceof CanBeValidated))
        {
            return;
        }

        CanBeValidated v = (CanBeValidated) target;
        Collection<Throwable> validationErrors = v.validate();

        for (Throwable t : validationErrors)
        {
            ValidationEvent event = new ValidationEventImpl(
                    ValidationEvent.ERROR,
                    t.getLocalizedMessage(),
                    null,
                    t);

            this.validationEventHandler.handleEvent(event);
        }
    }
}

第 3 步

最后，我扩展了org.glassfish.jersey.message.internal.AbstractRootElementJaxbProvider覆盖 readFrom方法。

@Override
protected Object readFrom(
        Class<Object> type,
        MediaType mediaType,
        Unmarshaller u,
        InputStream entityStream)
        throws JAXBException
{
    final SAXSource source = getSAXSource(spf.provide(), entityStream);
    ValidationEventCollector eventCollector = new ValidationEventCollector();
    ValidatingUnmarshallerListener listener = new ValidatingUnmarshallerListener(eventCollector);
    u.setEventHandler(eventCollector);
    u.setListener(listener);

    final Object result;
    if (type.isAnnotationPresent(XmlRootElement.class))
    {
        result = u.unmarshal(source);
    }
    else
    {
        result = u.unmarshal(source, type).getValue();
    }

    if (eventCollector.hasEvents())
    {
        HttpError error = new HttpError(Response.Status.BAD_REQUEST);

        for (ValidationEvent event : eventCollector.getEvents())
        {
            error.addMessage(ValidationUtil.toString(event));
        }

        throw new WebApplicationException(error.toResponse());
    }

    return result;
}