泽西岛忽略自定义ObjectMapper

时间:2019-05-05 01:19:40

标签: java jackson jersey

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

在研究此问题时,我发现了几篇旧文章(超过5年),提出了与当前代码有很大不同的各种修复程序。我没有特别注意这些,因为它们是用于Jackson / 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");
  }
}

1 个答案:

答案 0 :(得分:1)

现在正在工作。泽西岛现在正在识别自定义ObjectMapper,该对象已配置为忽略未知的JSON字段,并带有“ FAIL_ON_UNKNOWN_PROPERTIES,false”。

上面的ObjectMapper代码是正确的。问题(如Paul在评论中所建议)是客户端尚未注册自定义ObjectMapper。通过使用ClientBuilder进行客户端设置,将以下行添加到客户端设置方法中,可以非常简单地解决此问题。

this.client.register(OutMapperProvider.class);