用 Jackson 序列化 Map<Date, String>答案

【问题标题】：Serializing Map<Date, String> with Jackson用 Jackson 序列化 Map<Date, String>
【发布时间】：2011-07-04 17:51:07
【问题描述】：

我想用 Jackson 序列化一个 Map。日期应序列化为时间戳，就像我所有其他日期一样。

以下代码以“Tue Mar 11 00:00:00 CET 1952”（即 Date.toString()）的形式呈现键，而不是时间戳。

Map<Date, String> myMap = new HashMap<Date, String>();
...
ObjectMapper.writeValue(myMap)

我认为这是因为类型擦除和杰克逊在运行时不知道密钥是日期。但是我没有找到将 TypeReference 传递给任何 writeValue 方法的方法。

有没有一种简单的方法来实现我想要的行为，或者杰克逊总是将所有键呈现为字符串？

感谢任何提示。

【问题讨论】：

JSON 映射只是带有元素名称/值对的 JSON 对象。 JSON 元素名称必须是字符串。因此，Jackson 正在根据提供的内容生成一个字符串。

标签： generics serialization jackson type-erasure

【解决方案1】：

默认的映射键序列化器是StdKeySerializer，它就是这么做的。

String keyStr = (value.getClass() == String.class) ? ((String) value) : value.toString();
jgen.writeFieldName(keyStr);

您可以使用the SimpleModule feature，并使用addKeySerializer 方法指定自定义密钥序列化程序。

这是如何做到的。

import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.Version;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.ObjectWriter;
import org.codehaus.jackson.map.SerializerProvider;
import org.codehaus.jackson.map.module.SimpleModule;
import org.codehaus.jackson.map.type.MapType;
import org.codehaus.jackson.map.type.TypeFactory;

public class CustomKeySerializerDemo
{
  public static void main(String[] args) throws Exception
  {
    Map<Date, String> myMap = new HashMap<Date, String>();
    myMap.put(new Date(), "now");
    Thread.sleep(100);
    myMap.put(new Date(), "later");

    ObjectMapper mapper = new ObjectMapper();
    System.out.println(mapper.writeValueAsString(myMap));
    // {"Mon Jul 04 11:38:36 MST 2011":"now","Mon Jul 04 11:38:36 MST 2011":"later"}

    SimpleModule module =  
      new SimpleModule("MyMapKeySerializerModule",  
          new Version(1, 0, 0, null));
    module.addKeySerializer(Date.class, new DateAsTimestampSerializer());

    MapType myMapType = TypeFactory.defaultInstance().constructMapType(HashMap.class, Date.class, String.class);

    ObjectWriter writer = new ObjectMapper().withModule(module).typedWriter(myMapType);
    System.out.println(writer.writeValueAsString(myMap));
    // {"1309806289240":"later","1309806289140":"now"}
  }
}

class DateAsTimestampSerializer extends JsonSerializer<Date>
{
  @Override
  public void serialize(Date value, JsonGenerator jgen, SerializerProvider provider) 
      throws IOException, JsonProcessingException
  {
    jgen.writeFieldName(String.valueOf(value.getTime()));
  }
}

最新 Jackson (2.0.4) 更新：

import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.type.MapType;
import com.fasterxml.jackson.databind.type.TypeFactory;

public class CustomKeySerializerDemo
{
  public static void main(String[] args) throws Exception
  {
    Map<Date, String> myMap = new HashMap<Date, String>();
    myMap.put(new Date(), "now");
    Thread.sleep(100);
    myMap.put(new Date(), "later");

    ObjectMapper mapper = new ObjectMapper();
    System.out.println(mapper.writeValueAsString(myMap));
    // {"2012-07-13T21:14:09.499+0000":"now","2012-07-13T21:14:09.599+0000":"later"}

    SimpleModule module = new SimpleModule();
    module.addKeySerializer(Date.class, new DateAsTimestampSerializer());

    MapType myMapType = TypeFactory.defaultInstance().constructMapType(HashMap.class, Date.class, String.class);

    ObjectWriter writer = new ObjectMapper().registerModule(module).writerWithType(myMapType);
    System.out.println(writer.writeValueAsString(myMap));
    // {"1342214049499":"now","1342214049599":"later"}
  }
}

class DateAsTimestampSerializer extends JsonSerializer<Date>
{
  @Override
  public void serialize(Date value, JsonGenerator jgen, SerializerProvider provider) 
      throws IOException, JsonProcessingException
  {
    jgen.writeFieldName(String.valueOf(value.getTime()));
  }
}

【讨论】：

感谢您的回答，我想过这样的事情。无论如何，这对我的问题来说太过分了，所以我只是稍微重组了我的数据。
我发现 addKeySerializer() 似乎没有达到我的预期。我正在序列化 Map<Foo, Foo> 的一个实例，而 Jackson 无法使用我的 Foo 密钥序列化程序。
没关系，我没有意识到我不能对键和值使用相同的 FooSerializer；密钥序列化程序必须 jgen.writeFieldName()。
别介意我的别介意......显然，当你有一个扩展泛型的类时，杰克逊只尊重关键序列化程序，比如class MyMap extends Map<Foo, Bar>，或者 Map 是另一个类中的一个字段。我理解为什么这些情况不同（元数据逃避擦除），但我不明白为什么 Jackson 不只是查看关键对象的运行时类型。
这种方法是否适用于序列化 Map

【解决方案2】：

像往常一样，布鲁斯的回答是当场的。

另外一个想法是，由于存在将Date 值序列化为时间戳的全局设置：

SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS

也许这也适用于这里。和/或至少使用标准的ISO-8601 文本格式。主要的实际问题是向后兼容性；但是，我怀疑当前使用普通 toString() 是否非常有用，因为它既不高效也不方便（读取值）。

因此，如果您愿意，您可能需要提交功能请求；这听起来像是 Jackson 对 Map 键的次优处理。

【讨论】：

【解决方案3】：

自 Jackson 2.0（也可能是 1.9）以来，WRITE_DATE_KEYS_AS_TIMESTAMPS 可用于更改此特定行为。

ObjectMapper的用法示例：

ObjectMapper m = new ObjectMapper().configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS, true);

对于ObjectWriter：

ObjectWriter w = mapper.with(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS);

【讨论】：