在 RestEasy 中访问 Jackson 对象映射器

Question

我被要求美化来自 RestEasy 端点的默认 Jackson JSON。我对 Jackson 做了一些研究，并编写了一些独立代码，以便能够抑制空值、自定义数据格式等。现在的挑战是将这些代码注入 RestEasy 的 JSON 序列化中。

从论坛帖子来看，这在 Spring 中是微不足道的，但在 RestEasy 中似乎并非如此。我编写了一个 ContextResolver 并在 web.xml（在 Tomcat 上）的上下文参数中配置为resteasy.provider，但这会阻止 web 应用程序在 Tomcat 上加载。

现在我尝试扩展 javax.ws.rs.core.Application 并提供 ContextResolver 但没有取得任何进展。这个简单吗，有人做过吗？非常感谢任何帮助。

Answer 1

我找到了一种更好的修改 Jackson SerializationConfig 的方法 - 您可以使用 JAX-RS ContextResolver 拦截 ObjectMapper 创建。

@Provider
@Produces(Array(MediaType.APPLICATION_JSON))
class JacksonConfig extends ContextResolver[ObjectMapper] {

  val mapper = new ObjectMapper()
  mapper.getSerializationConfig.setSerializationInclusion(Inclusion.NON_NULL)

  def getContext(objectType: Class[_]) = mapper
}

您需要通过以下方式之一向 RESTEasy 注册：

• 将其作为 javax.ws.rs.core.Application 实现中的类或实例返回
• 使用resteasy.providers 将其列为提供程序
• 让 RESTEasy 在您的应用程序中自动扫描它WAR 文件。请参阅配置指南
• 通过 ResteasyProviderFactory.getInstance().registerProvider(Class) 或 registerProviderInstance(Object) 手动添加它

参考：RESTEasy 文档

参考：JBoss 论坛上的 Nicklas Karlsson

请注意，这适用于作为模块提供的 RESTEasy 2.3.2在 JBoss 7.1.1.Final 中，但似乎不适用于 RESTEasy 3.0-beta5。

Answer 2

好吧，我想通了，我可以通过基于 Jackson FAQ：JAX-RS 编写自定义 JacksonJsonProvider 来做到这一点。代码如下：

@Provider
public class QBOJacksonJsonProvider extends JacksonJsonProvider {
    public static final String DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";

    @Override
    public void writeTo(Object value, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException, WebApplicationException {
        Log.info(getClass(), "In custom JSON provider");
        //get the Object Mapper
        ObjectMapper mapper = locateMapper(type, mediaType);
        // Suppress null properties in JSON output
        mapper.getSerializationConfig().setSerializationInclusion(org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion.NON_NULL);
        // Set human readable date format
        SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT);
        mapper.getSerializationConfig().setDateFormat(sdf);

        super.writeTo(value, type, genericType, annotations, mediaType, httpHeaders, entityStream);
    }
}

Answer 3

如果您使用的是 Jackson2 提供程序，您需要做一些与之前的答案略有不同的事情。默认情况下，此示例将漂亮地打印输出

@Provider
public class JSONProvider extends ResteasyJackson2Provider {

  @Override
  public void writeTo(Object value, Class<?> type, Type genericType, Annotation[]  annotations, MediaType json, MultivaluedMap<String, Object> headers, OutputStream body) throws IOException {

    ObjectMapper mapper = locateMapper(type, json);
    mapper.enable(SerializationFeature.INDENT_OUTPUT);

    super.writeTo(value, type, genericType, annotations, json, headers, body);
  }

}

并将其注册到您的 web-xml 中，如果您没有启用自动注册，请将其添加到您的resteasy.providers context-param

Answer 4

我做了很多工作来在我的应用程序中注册它，即使在我使用 spring boot 并且没有 web.xml 时遵循使用 context-param 的提示，这里我做了什么

自定义提供程序

package com.mageddo;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.jboss.resteasy.plugins.providers.jackson.ResteasyJackson2Provider;

import javax.ws.rs.Consumes;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.Provider;

@Provider
@Consumes({"application/json", "application/*+json", "text/json"})
@Produces({"application/json", "application/*+json", "text/json"})
public class CustomJacksonJsonProvider extends ResteasyJackson2Provider {

    private ObjectMapper objectMapper = new ObjectMapper(); // my own object mapper

    @Override
    public ObjectMapper locateMapper(Class<?> type, MediaType mediaType) {
        return objectMapper;
    }
}

在应用程序

META-INF/services/ 上注册javax.ws.rs.ext.Providers

com.mageddo.CustomJacksonJsonProvider
org.jboss.resteasy.plugins.providers.jackson.UnrecognizedPropertyExceptionHandler

Answer 5

Jackson ObjectMapper 的提供程序应该是执行此操作的标准 JAX-RS 方式（与 Jersey 一起使用），因此它似乎也是使用 RESTeasy 的方式。

Answer 6

如果您使用 Jackson 2.2.x 提供程序，Resteasy 提供了
漂亮的打印注释与 JAXB 提供程序中的注释类似：

org.jboss.resteasy.annotations.providers.jackson.Formatted

这是一个例子：

<前><代码>@GET
@Produces(“应用程序/json”)
@Path("/格式化/{id}")
@格式化
公共产品 getFormattedProduct()
{
返回新产品（333，“机器人”）；
}

如上例所示，@Formatted 注解将启用
底层 Jackson 选项“SerializationFeature.INDENT_OUTPUT”。

© RESTEasy 用户指南 。

这不是一个全局解决方案，但您也可以将注释放在类上。