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

我有一个实体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 保存到 Elasticsearch：

bulkRequestBody.append(objectMapper.writeValueAsString(item));

ObjectMapper将此字段序列化为对象：

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

我正在尝试注释@JsonFormat(shape = JsonFormat.Shape.STRING)但这对我不起作用。

我的问题是如何将该字段序列化为2010-05-30 22:15:52 string?

一种解决方案是使用杰克逊模块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 = "UTC")
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").withZone(ZoneOffset.UTC);

    @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").withZone(ZoneOffset.UTC);

    @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 is 2017-08-14T12:17:47.720Z，但是序列化后的字符串是2017-08-14 12:17:47（没有秒的分数），所以当反序列化时得到的结果Instant is 2017-08-14T12:17:47Z (the .720毫秒丢失）。