Jackson deserialization issue for ZonedDateTime

Question

I've the following field in a class I use during deserialization of a service that I'm consuming.

private ZonedDateTime transactionDateTime;

The service I'm consuming may return a Date or DateTime using the pattern: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Let me give 2 examples of what the service returns:

2015-11-18T18:05:38.000+0200
2015-11-18T00:00:00.000+0200

While first one works well, the latter causes the following exception to be thrown during deserialization:

java.time.format.DateTimeParseException: Text '2015-11-18T00:00:00.000+0200' could not be parsed at index 23

I'm using;

Spring Boot 1.3.1
Jackson 2.6.4 (with JSR310 module included)

Does this require a custom deserialization class?

score 7 · Answer 1 · edited Jun 11 '23 at 07:50

7

Jackson deserializer will by default bypass the timezone information and use context timezone to override it, which all ISO8601 will ends to UTC.

Using Spring, this feature can be turned off by:

spring.jackson.deserialization.ADJUST_DATES_TO_CONTEXT_TIME_ZONE=false

edited Jun 11 '23 at 07:50

Eyal Schneider

22,166
5
47
78

answered Aug 30 '18 at 08:11

Jiajun Cui

71
1
1

or if using jackson mapper `new ObjectMapper().registerModule(new JavaTimeModule()).disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE)` – prayagupa Feb 21 '20 at 01:16

score 5 · Answer 2 · answered Jan 13 '16 at 11:22

You can use annotations like:

@JsonSerialize(using = MyCustomJsonDateSerializer.class)

or

@JsonDeserialize(using = MyCustomJsonDateDeserializer.class)

To customize how Jackson parses Dates. Those custom Serializer and Deserializer must extend JsonSerializer and JsonDeserializer. For example:

public class MyCustomJsonDateSerializer extends JsonSerializer<Date> {

    @Override
    public void serialize(Date date, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
        jgen.writeString(date != null ? ISODateTimeFormat.dateTime().print(new DateTime(date)) : null);
      }
}

score 4 · Accepted Answer · answered Jan 13 '16 at 15:07

4

Earlier in the code I was using the field with @JsonFormat annotation but removed that as I thought it was meant for serialization only like the JavaDocs suggest.

Turned out that I needed add back that annotation. And the real issue was that the 3rd party service response was indeed wrong (it was missing a wrapper element in the XML) which caused the deserialisation to fail. The error was:

com.fasterxml.jackson.databind.JsonMappingException: Can not instantiate value of type [simple type, class com.foo.bar.adapter.john.model.account.UserAccount] from String value ('2015-11-18T00:00:00.000+0200'); no single-String constructor/factory method

The field is written like below:

@JsonFormat(pattern = Constants.DATETIME_FORMAT)
@JacksonXmlProperty(localName = "transactionDate")
private ZonedDateTime transactionDateTime;

Also I had to add @JsonRootName("transaction") to the class of this field because the object is wrapped into a collection.

answered Jan 13 '16 at 15:07

Alper Kanat

376
1
2
16

Can you share the pattern? `Constants.DATETIME_FORMAT` – ehsun7b Sep 10 '17 at 17:55
2

yyyy-MM-dd'T'HH:mm:ss.SSSZ – Alper Kanat Sep 11 '17 at 19:43
1

Thanks, but this didn't work for me, eventually I solve my issue by writing custom serializer and deserializer for ZonedDateTime class. – ehsun7b Sep 13 '17 at 07:14
Do you have the JSR310 dependency on your classpath? – Alper Kanat Sep 14 '17 at 08:07
1

Yes, and I use ZonedDatetime. Serializations works fine, but deserialization ends up UTC zonedDateTime objects – ehsun7b Sep 14 '17 at 08:18
@ehsun7b Can you share the custom deserialiser and serializers code with me? I have the same problem. – Aryan Venkat Mar 02 '18 at 10:57
I am outstation now. I will try to find it as soon as I go back home. – ehsun7b Mar 04 '18 at 16:01

score 1 · Answer 4 · answered Apr 29 '20 at 16:31

I've used

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
private ZonedDateTime startDate;

plus jackson-datatype-jsr310 library, obviously.

This solution is described in Jackson deserialize ISO8601 formatted date-time into Java8 Instant

Michael Belkin · Answer 5 · 2021-12-20T08:08:33.993

The following configuration helped me

Specify datetime pattern:

public class Timestamp {

    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
    private ZonedDateTime timestamp;

}

Disable converting ZonedDateTime to UTC:

objectMapper.configure(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE, false);

Also there was another problem, which may be tricky to spot. In my case I was receiving Timestamp from another micro service using RestTemplate. RestTemplate can be configured to use notProjectDefaultObjectMapper, which is not affected by default Spring Jackson configuration approaches (like application properties, or @Configuration classes with Jackson2ObjectMapperBuilderCustomizer bean definition or somehow else). So RestTemplate's objectMapper (if there is one) should be configured too

Jackson deserialization issue for ZonedDateTime

5 Answers5

Linked