使用 Jackson 将 Java8 LocalDateTime 序列化为 UTC 时间戳答案

【问题标题】：Serialize Java8 LocalDateTime to UTC Timestamp using Jackson使用 Jackson 将 Java8 LocalDateTime 序列化为 UTC 时间戳
【发布时间】：2019-02-01 12:38:17
【问题描述】：

我刚刚根据新的（ish）java 8 时间包将我的许多日期转换为 LocalDateTime。到目前为止，我一直很喜欢这种切换，直到我开始尝试序列化和反序列化。

如何配置 Jackson 以支持它们？：

LocalDateTime --serialize--> UTC 时间戳 --deserialize--> LocalDateTime?

这里有很多关于转换为格式化字符串的材料，但我似乎找不到一个开箱即用的 utc 时间戳解决方案。

【问题讨论】：

这应该会有所帮助：fasterxml.github.io/jackson-databind/javadoc/2.8/com/fasterxml/…
如果是 UTC 时间戳，为什么不使用 Instant 而不是 LocalDateTime？
@assylias，信不信由你：WRITE_DATES_AS_TIMESTAMPS 适用于日期。当 LocalDateTimes 开启时，Jackson 将其序列化为一组值。
@ernest_k，我还有其他原因想要使用 LocalDateTime。第三方 API 希望将其格式化为时间戳整数，因此我需要将其转换为与他们的系统交互。
@DanielPatrick 如果您注册new JavaTimeModule()，它应该可以工作 - 请参阅此处：fasterxml.github.io/jackson-datatype-jsr310/javadoc/2.6/com/…

标签： java datetime java-8 jackson java-time

【解决方案1】：

您可以为LocalDateTime 自定义序列化器和反序列化器，例如：

CustomLocalDateTimeSerializer

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;

import java.io.IOException;
import java.time.LocalDateTime;
import java.time.ZoneId;

public class CustomLocalDateTimeSerializer extends StdSerializer<LocalDateTime> {

    protected CustomLocalDateTimeSerializer(Class<LocalDateTime> t) {
        super(t);
    }

    protected CustomLocalDateTimeSerializer() {
        this(null);
    }

    @Override
    public void serialize(LocalDateTime value, JsonGenerator gen, SerializerProvider sp)
            throws IOException {
        Long epoch = value.atZone(ZoneId.systemDefault()).toInstant().getEpochSecond();
        gen.writeString(epoch.toString());
    }
}

CustomLocalDateTimeDesSerializer：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;

import java.io.IOException;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;

class CustomLocalDateTimeDesSerializer extends StdDeserializer<LocalDateTime> {

    protected CustomLocalDateTimeDesSerializer() {
        this(null);
    }

    protected CustomLocalDateTimeDesSerializer(Class<LocalDateTime> t) {
        super(t);
    }

    @Override
    public LocalDateTime deserialize(JsonParser jsonparser, DeserializationContext context)
            throws IOException {
        Long timestamp = Long.parseLong(jsonparser.getText());
        return LocalDateTime.ofInstant(Instant.ofEpochSecond(timestamp), ZoneId.systemDefault());
    }
}

并使用它们：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;

import java.time.LocalDateTime;

public class RestObject {

    private LocalDateTime timestamp = LocalDateTime.now();

    @JsonSerialize(using = CustomLocalDateTimeSerializer.class)
    @JsonDeserialize(using = CustomLocalDateTimeDesSerializer.class)
    public LocalDateTime getTimestamp() {
        return timestamp;
    }

    public static void main(String[] args) throws Exception {
        ObjectMapper objectMapper = new ObjectMapper();
        // {"timestamp":"1549026058"}
        System.out.println(objectMapper.writeValueAsString(new RestObject()));
    }
}

【讨论】：

这行得通...谢谢！不敢相信 Jackson 没有配置来允许 LocalDateTime 序列化与其旧的 Date 序列化兼容。
@DanielPatrick 我不确定这是否是最合适的方法，这只是一种可行的方法。

【解决方案2】：

以下解决方案解决了将LocalDateTime序列化/反序列化为时间戳的任务，至少与spring-boot v1.5相关，还包括@xingbin的answer中未考虑的下一点：

如果需要具有与java.util.Date 相同的行为，则必须使用toInstant().toEpochMilli() 而不是toInstant().getEpochSecond()
检查null要反序列化的值
还有可选点：为JacksonObjectMapper指定这个序列化/反序列化配置

时间戳序列化器类：

public class LocalDateTimeSerializer extends StdSerializer<LocalDateTime> {
    private static final ZoneId DEFAULT_ZONE_ID = ZoneId.of("UTC");

    public LocalDateTimeSerializer() {
        super(LocalDateTime.class);

    }

    @Override
    public void serialize(final LocalDateTime value,
                          final JsonGenerator generator,
                          final SerializerProvider provider) throws IOException {
        if (value != null) {
            final long mills = value.atZone(DEFAULT_ZONE_ID).toInstant().toEpochMilli();
            generator.writeNumber(mills);
        } else {
            generator.writeNull();
        }
    }
}

时间戳解串器类：

public class LocalDateTimeDeserializer extends StdDeserializer<LocalDateTime> {
    private static final ZoneId DEFAULT_ZONE_ID = ZoneId.of("UTC");

    public LocalDateTimeDeserializer() {
        super(LocalDateTime.class);
    }

    @Override
    public LocalDateTime deserialize(final JsonParser parser,
                                     final DeserializationContext context) throws IOException {
        final long value = parser.getValueAsLong();
        return LocalDateTime.ofInstant(Instant.ofEpochMilli(value), DEFAULT_ZONE_ID);
    }
}

对象映射器配置：

@Configuration
public class ObjectMapperConfiguration {
    @Bean
    public ObjectMapper objectMapper() {
        final ObjectMapper objectMapper = new ObjectMapper();
        final SimpleModule module = new SimpleModule();
        module.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer());
        module.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer());
        objectMapper.registerModule(module);
        return objectMapper;
    }
}

【讨论】：

【解决方案3】：

您可以利用the JavaTimeModule，而不是手动重写所有内容：

ObjectMapper om = new ObjectMapper();
om.registerModule(new JavaTimeModule());
om.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, true);

【讨论】：

链接中有说明。
根据我对问题的理解，链接中的解释似乎解释了为什么这不适用于LocalDateTime，因此对于这个问题

【解决方案4】：

这里是如何简单有效地做到这一点：

@JsonFormat(shape= JsonFormat.Shape.STRING, pattern="EEE MMM dd HH:mm:ss Z yyyy")
@JsonProperty("created_at") 
ZonedDateTime created_at;

这是一个问题的引用：Jackson deserialize date from Twitter to `ZonedDateTime`，所以这可能是一个重复的问题

【讨论】：