Jersey 忽略自定义 ObjectMapper

Question

我正在使用 Jackson 2.7.5 和 Jersey 2.25.1。我正在尝试修复现有的生产代码，当它在 JSON 输入中获取意外字段时，该代码现在因“UnrecognizedPropertyException：无法识别的字段”而失败。

在研究这个问题时，我发现了几篇旧帖子（5 年以上）建议的各种修复措施与我当前的代码非常不同。我没有太注意这些，因为它们是旧版本的 Jackson/Jersey 的。最近的建议，包括 Jersey 自己的文档（https://jersey.github.io/documentation/latest/media.html#json.jackson），看起来与我已经有了的非常相似。事实上，在我看来，我现有的代码似乎已经遵循了当前的做法。但是，Jersey 似乎忽略了我的自定义 ObjectMapper 设置...

DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false

我很确定该设置应该可以修复该错误，但 Jersey 似乎使用默认的 ObjectMapper 而不是我的自定义设置。

首先，这是依赖项信息，我相信它与 Jersey 文档中显示的内容相匹配（https://jersey.github.io/documentation/latest/media.html#json.jackson）。

<dependency>
  <groupId>org.glassfish.jersey.media</groupId>
  <artifactId>jersey-media-json-jackson</artifactId>
  <version>${jersey.version}</version>
</dependency>

这是返回错误的调用：

// this will throw an exception if it can't convert the string to the class
PropSearchResponse propResponse = null;
try {
  propResponse = getResponse.readEntity(PropSearchResponse.class);
} catch(final ProcessingException e) {
  throw new ProcessResultException(Code.FAILED, "failed to map from prop response", e);
}

这是我的自定义 ObjectMapper 的原始代码：

@Provider()
@Produces(value = MediaType.APPLICATION_JSON)
public class OutMapperProvider implements ContextResolver<ObjectMapper> {
  private final ObjectMapper mapper;

  public OutMapperProvider() {
    mapper = new ObjectMapper();
    mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    mapper.configure(JsonGenerator.Feature.ESCAPE_NON_ASCII, true);
    mapper.setSerializationInclusion(Include.NON_NULL);
    mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ"));
  }

  @Override()
  public ObjectMapper getContext(final Class<?> type) {
    return mapper;
  }
}

以下是 Jersey 文档中的示例：

@Provider
public class MyObjectMapperProvider implements ContextResolver<ObjectMapper> {

    final ObjectMapper defaultObjectMapper;

    public MyObjectMapperProvider() {
        defaultObjectMapper = createDefaultMapper();
    }

    @Override
    public ObjectMapper getContext(Class<?> type) {
            return defaultObjectMapper;
    }

    private static ObjectMapper createDefaultMapper() {
        final ObjectMapper result = new ObjectMapper();
        result.configure(Feature.INDENT_OUTPUT, true);

        return result;
    }
}

我尝试过 Jersey 示例（当然，更改名称以匹配我的名称）以及我在网上找到的其他几个示例。Jersey 示例在 @Override 之后进行自定义。大多数其他示例都是在 @Override 之前执行的，但它们看起来彼此之间以及与我现有的代码基本相似。但这似乎没有什么区别。无论我尝试什么，自定义配置都会被忽略，并且 Jersey 会调用默认的 ObjectMapper，这会在意外的 JSON 字段上失败。

免责声明：这是我第一次体验泽西岛和杰克逊。我对底层机制还没有很好的理解。我只是试图遵循示例的模式。

更新：我相信上面的代码基本上是正确的。但 Paul 下面的评论说我需要注册自定义 ObjectMapper。我尝试重现在网上找到的几个示例（例如https://docs.huihoo.com/jersey/2.13/deployment.html#environmenmt.appmodel上的示例 4.2），但没有成功。对于我当前的尝试，我尝试使用 Jersey 的 ResourceConfig 将新的 MyApplication 类添加到现有配置包 (com.dmx.repl.config)。代码如下。但它仍然不起作用。

编辑：忽略此代码，它不起作用。请参阅下面的解决方案。

package com.dmx.repl.config;

import org.glassfish.jersey.server.ResourceConfig;
import com.dmx.repl.commons.OutMapperProvider;


/**
 *
 * @author Greg
 * @version 1.0
 */

// Attempt to register custom ObjectMapper
public class MyApplication extends ResourceConfig {
  public MyApplication() {
    // I've tried both of these.
    //register(OutMapperProvider.class);
    packages("com.dmx.repl.commons");
  }
}

Answer 1

现在正在工作。Jersey 现在可以识别自定义 ObjectMapper，该对象配置为忽略带有“FAIL_ON_UNKNOWN_PROPERTIES, false”的未知 JSON 字段。

上面的ObjectMapper代码是正确的。问题（正如 Paul 在评论中所建议的）是客户端没有注册自定义 ObjectMapper。这个问题的修复非常简单，只需将以下行添加到客户端设置方法中，然后使用 ClientBuilder 进行客户端设置即可。

this.client.register(OutMapperProvider.class);