如何使用objectMapper设置java.time.Instant的字符串格式？

最新推荐文章于 2025-03-23 08:28:02 发布

二十一克阳光！

最新推荐文章于 2025-03-23 08:28:02 发布

阅读量2k

点赞数

原文链接：http://www.voidcn.com/article/p-pnolxhim-buo.html

版权

我有一个带有 java.time.Instant的实体用于创建的数据字段：

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
public class Item {
    private String id;
    private String url;
    private Instant createdDate;
}

我使用com.fasterxml.jackson.databind.ObjectMapper将项目保存为JSON格式，ObjectMapper将此字段序列化为对象：

"createdDate": {
    "epochSecond": 1502643595,
    "nano": 466000000
}

一种解决方案是使用 jackson-modules-java8.然后您可以将JavaTimeModule添加到对象映射器：

ObjectMapper objectMapper = new ObjectMapper();

JavaTimeModule module = new JavaTimeModule();
objectMapper.registerModule(module);

默认情况下,Instant被序列化为纪元值(单个数字中的秒和纳秒)：

{"createdDate":1502713067.720000000}

您可以通过在对象映射器中设置来更改它：

objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);

这将产生输出：

{"createdDate":"2017-08-14T12:17:47.720Z"}

上述两种格式都是反序列化的,无需任何其他配置.

要更改序列化格式,只需在字段中添加JsonFormat注释：

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Instant createdDate;

您需要设置时区,否则Instant无法正确序列化(它会引发异常).输出将是：

{"createdDate":"2017-08-14 12:17:47"}

如果您不想(或不能)使用java8模块,另一种方法是使用java.time.format.DateTimeFormatter创建自定义序列化程序和反序列化程序：

public class MyCustomSerializer extends JsonSerializer<Instant> {

    private DateTimeFormatter fmt = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss") .withLocale(Locale.getDefault())
            .withZone(ZoneId.systemDefault());

    @Override
    public void serialize(Instant value, JsonGenerator gen, SerializerProvider serializers) throws IOException, JsonProcessingException {
        String str = fmt.format(value);

        gen.writeString(str);
    }
}

public class MyCustomDeserializer extends JsonDeserializer<Instant> {

    private DateTimeFormatter fmt = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss") .withLocale(Locale.getDefault())
            .withZone(ZoneId.systemDefault());

    @Override
    public Instant deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        return Instant.from(fmt.parse(p.getText()));
    }
}

然后使用这些自定义类注释该字段：

@JsonDeserialize(using = MyCustomDeserializer.class)
@JsonSerialize(using = MyCustomSerializer.class)
private Instant createdDate;

输出将是：

{"createdDate":"2017-08-14 12:17:47"}

一个细节是,在序列化字符串中,您将丢弃秒的小数部分(小数点后的所有内容).因此,在反序列化时,此信息无法恢复(它将被设置为零).
在上面的例子中,原始的Instant是2017-08-14T12：17：47.720Z,但是序列化的字符串是2017-08-14 12:17:47(没有秒的分数),所以当反序列化时产生的Instant是2017-08-14T12：17：47Z(丢失.720毫秒).