泽西岛 + Jackson JSON 日期格式序列化 - 如何更改格式或使用自定义 JacksonJsonProvider

Question

我正在使用 Jersey + Jackson 为我的应用程序提供 REST JSON 服务层。我遇到的问题是默认的日期序列化格式如下所示：

"CreationDate":1292236718456

起初我以为它是 UNIX 时间戳...但它太长了。我的客户端 JS 库在反序列化这种格式时遇到问题（它支持一堆不同的日期格式，但我想不支持这个）。我想更改格式，以便我的库可以使用它（例如 ISO）。我该怎么做...我找到了一段可以提供帮助的代码，但是...我应该把它放在哪里，因为我不控制杰克逊序列化器实例化（泽西岛控制）？

objectMapper.configure(
    SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);

我还找到了自定义 JacksonJsonProvider 的代码 - 问题是..如何让我的所有 POJO 类都使用它？

@Provider
public class MessageBodyWriterJSON extends JacksonJsonProvider {

    private static final String DF = "yyyy-MM-dd’T'HH:mm:ss.SSSZ";

    @Override
    public boolean isWriteable(Class arg0, Type arg1, Annotation[] arg2,
            MediaType arg3) {
        return super.isWriteable(arg0, arg1, arg2,
                arg3);
    }
    @Override
    public void writeTo(Object target, Class arg1, Type arg2, Annotation[] arg3,
            MediaType arg4, MultivaluedMap arg5, OutputStream outputStream)
            throws IOException, WebApplicationException {
            SimpleDateFormat sdf=new SimpleDateFormat(DF);

        ObjectMapper om = new ObjectMapper();
        om.getDeserializationConfig().setDateFormat(sdf);
        om.getSerializationConfig().setDateFormat(sdf);
        try {
            om.writeValue(outputStream, target);
        } catch (JsonGenerationException e) {
            throw e;
        } catch (JsonMappingException e) {
            throw e;
        } catch (IOException e) {
            throw e;
        }
    }
}

Answer 1

我遇到了同样的问题（使用 Jersey+Jackson+Json），客户端正在发送一个日期，但当数据映射到对象时，它在服务器中被更改。

我通过阅读此链接采用其他方法来解决此问题： http: //blog.bdoughan.com/2010/07/xmladapter-jaxbs-secret-weapon.html，当我意识到收到的日期是一个时间戳（与阿德林在他的问题中相同：“creationDate” ":1292236718456)

在我的 VO 类中，我将此注释添加到属性 @XmlJavaTypeAdapter 中，并且还实现了一个扩展了 XmlAdapter 的内部类：

@XmlRootElement
public class MyClassVO {
   ...
   @XmlJavaTypeAdapter(DateFormatterAdapter.class) 
   Date creationDate;
   ...

   private static class DateFormatterAdapter extends XmlAdapter<String, Date> {
      @Override
      public Date unmarshal(final String v) throws Exception {
         Timestamp stamp = new Timestamp(new Long(v));
         Date date = new Date(stamp.getTime());
         return date;
      }
}

我希望它能有所帮助也给你。

Answer 2

下面的代码对我有用 - JAX-RS 1.1，Jersy 1.8

import java.text.SimpleDateFormat;

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

import org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider;
import org.codehaus.jackson.map.DeserializationConfig;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;
import org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion;


@Provider
@Produces(MediaType.APPLICATION_JSON)
public class JsonProvider extends JacksonJaxbJsonProvider {
  private static final ObjectMapper objectMapper = new ObjectMapper();
  static {
    // allow only non-null fields to be serialized
    objectMapper.getSerializationConfig().setSerializationInclusion(Inclusion.NON_NULL);

    SerializationConfig serConfig = objectMapper.getSerializationConfig();
    serConfig.setDateFormat(new SimpleDateFormat(<your date format>));
    DeserializationConfig deserializationConfig = objectMapper.getDeserializationConfig();
    deserializationConfig.setDateFormat(new SimpleDateFormat(<your date format>));
    objectMapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);

  }

  public JsonProvider() {
    super.setMapper(objectMapper);
  }
}

Answer 3

用这个重写 MessageBodyWriterJSON

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

import org.codehaus.jackson.jaxrs.JacksonJsonProvider; 
import org.codehaus.jackson.map.ObjectMapper; 
import org.codehaus.jackson.map.SerializationConfig; 

@Provider 
public class MessageBodyWriterJSON extends JacksonJsonProvider { 
            public MessageBodyWriterJSON (){ 
            } 

        @Override 
            public ObjectMapper locateMapper(Class<?> type, MediaType mediaType) 
        { 
        ObjectMapper mapper = super.locateMapper(type, mediaType); 
        //DateTime in ISO format "2012-04-07T17:00:00.000+0000" instead of 'long' format 
            mapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false); 
            return mapper; 
        } 
}

Answer 4

我设法在 Resteasy“JAX-RS 方式”中做到这一点，因此它应该适用于每个兼容的实现，例如 Jersey（最近在 JEE7 服务器 Wildfly 8 上成功测试，它只需要对 Jackson 部分进行一些更改，因为他们更改了一些蜜蜂）。

您必须定义一个 ContextResolver （检查 Produces 是否包含正确的内容类型）：

import javax.ws.rs.ext.ContextResolver;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;
import org.codehaus.jackson.map.DeserializationConfig;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.Produces; 
import java.text.SimpleDateFormat;
@Provider
@Produces("application/json")
public class JacksonConfigurator implements ContextResolver<ObjectMapper> {

    private ObjectMapper mapper = new ObjectMapper();

    public JacksonConfigurator() {
        SerializationConfig serConfig = mapper.getSerializationConfig();
        serConfig.setDateFormat(new SimpleDateFormat(<my format>));
        DeserializationConfig deserializationConfig = mapper.getDeserializationConfig();
        deserializationConfig.setDateFormat(new SimpleDateFormat(<my format>));
        mapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);
    }

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

}

然后您必须在 javax.ws.rs.core.Application 的 getClasses 中返回新创建的类，

import javax.ws.rs.core.Application;
public class RestApplication extends Application {

     @Override
     public Set<Class<?>> getClasses() {
         Set<Class<?>> classes = new HashSet<Class<?>>();
         // your classes here
         classes.add(JacksonConfigurator.class);
         return classes;
      }

}

这样通过 jackson 进行的所有操作都会被赋予您的 ObjectMapper选择。

编辑：我最近发现，如果您决定扩展 JacksonConfigurator 以添加自定义映射，则使用 RestEasy 2.0.1（以及 Jackson 1.5.3）会出现奇怪的行为。

import javax.ws.rs.core.MediaType;
@Provider
@Produces(MediaType.APPLICATION_JSON)
public class MyJacksonConfigurator extends JacksonConfigurator

如果您只是这样做（当然将扩展类放入 RestApplication 中），则使用父类的映射器，也就是说您会丢失自定义映射。为了使其正常工作，我必须做一些对我来说似乎无用的事情：

public class MyJacksonConfigurator extends JacksonConfigurator implements ContextResolver<ObjectMapper> 

Answer 5

要配置您自己的 ObjectMapper，您需要注入自己的实现 ContextResolver的类。

究竟如何让球衣接受这一点将取决于你的国际奥委会（弹簧，guice）。我使用 spring，我的类看起来像这样：

import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig.Feature;
import org.codehaus.jackson.map.deser.CustomDeserializerFactory;
import org.codehaus.jackson.map.deser.StdDeserializerProvider;
import org.codehaus.jackson.map.ser.CustomSerializerFactory;
import org.springframework.stereotype.Component;

// tell spring to look for this.
@Component
// tell spring it's a provider (type is determined by the implements)
@Provider
public class ObjectMapperProvider implements ContextResolver<ObjectMapper> {
    @Override
    public ObjectMapper getContext(Class<?> type) {
        // create the objectMapper.
        ObjectMapper objectMapper = new ObjectMapper();
        // configure the object mapper here, eg.
           objectMapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);
        return objectMapper;
    }
}

Answer 6

就其价值而言，该数字是标准 Java 时间戳（由 JDK 类使用）； Unix 存储秒，Java 存储毫秒，这就是为什么它的值要大一些。

我希望有一些关于如何将 ObjectMapper 注入 Jersey 的文档（它应该遵循注入提供的对象的通常方法）。但是，您也可以重写 JacksonJaxRsProvider 来指定/配置 ObjectMapper 并注册它；这就是泽西岛本身所做的，并且有多种方法可以做到这一点。

Answer 7

如果您选择在服务器上使用 Joda DateTime 对象并希望序列化为 ISO8601，您可以使用 Jackson 的 JodaModule 。您可以按如下方式注册 Jersey 提供商：

import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.joda.JodaModule;

@Provider
public class MyObjectMapperProvider implements ContextResolver<ObjectMapper> {

  final ObjectMapper objectMapper;

  public MyObjectMapperProvider() {
    objectMapper = new ObjectMapper();
    /* Register JodaModule to handle Joda DateTime Objects. */
    objectMapper.registerModule(new JodaModule());
    /* We want dates to be treated as ISO8601 not timestamps. */
    objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
  }

  @Override
  public ObjectMapper getContext(Class<?> arg0) {
    return objectMapper;
  }
}

更多信息请访问 Jersey 网站。