Jackson Date

1. Panoramica

In questo tutorial, serializzeremo le date con Jackson. Inizieremo serializzando un semplice java.util. Date , quindi Joda-Time e Java 8 DateTime .

2. Serializza la data in timestamp

Innanzitutto, vediamo come serializzare un semplice java.util.Date con Jackson .

Nel seguente esempio, serializzeremo un'istanza di " Event " che ha un campo Date " eventDate ":

@Test public void whenSerializingDateWithJackson_thenSerializedToTimestamp() throws JsonProcessingException, ParseException { SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm"); df.setTimeZone(TimeZone.getTimeZone("UTC")); Date date = df.parse("01-01-1970 01:00"); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); mapper.writeValueAsString(event); }

Ciò che è importante qui è che Jackson serializzerà la data in un formato di timestamp per impostazione predefinita (numero di millisecondi dal 1 ° gennaio 1970, UTC).

L'output effettivo della serializzazione " evento " è:

{ "name":"party", "eventDate":3600000 }

3. Serializza la data su ISO-8601

La serializzazione in questo formato di timestamp conciso non è ottimale. Serializziamo ora la data nel formato ISO-8601 :

@Test public void whenSerializingDateToISO8601_thenSerializedToText() throws JsonProcessingException, ParseException { SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm"); df.setTimeZone(TimeZone.getTimeZone("UTC")); String toParse = "01-01-1970 02:30"; Date date = df.parse(toParse); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); // StdDateFormat is ISO8601 since jackson 2.9 mapper.setDateFormat(new StdDateFormat().withColonInTimeZone(true)); String result = mapper.writeValueAsString(event); assertThat(result, containsString("1970-01-01T02:30:00.000+00:00")); }

Si noti come la rappresentazione della data sia ora molto più leggibile.

4. Configurare ObjectMapper DateFormat

Le soluzioni precedenti mancano ancora della piena flessibilità di scegliere il formato esatto per rappresentare le istanze java.util.Date .

Diamo ora un'occhiata a una configurazione che ci permetterà di impostare i nostri formati per la rappresentazione delle date :

@Test public void whenSettingObjectMapperDateFormat_thenCorrect() throws JsonProcessingException, ParseException { SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm"); String toParse = "20-12-2014 02:30"; Date date = df.parse(toParse); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); mapper.setDateFormat(df); String result = mapper.writeValueAsString(event); assertThat(result, containsString(toParse)); }

Notare che, anche se ora siamo più flessibili riguardo al formato della data, stiamo ancora utilizzando una configurazione globale a livello dell'intero ObjectMapper .

5. Utilizzare @JsonFormat per formattare la data

Successivamente, diamo un'occhiata all'annotazione @JsonFormat per controllare il formato della data su singole classi anziché globalmente, per l'intera applicazione:

public class Event { public String name; @JsonFormat (shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy hh:mm:ss") public Date eventDate; }

Ora, proviamolo:

@Test public void whenUsingJsonFormatAnnotationToFormatDate_thenCorrect() throws JsonProcessingException, ParseException { SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm:ss"); df.setTimeZone(TimeZone.getTimeZone("UTC")); String toParse = "20-12-2014 02:30:00"; Date date = df.parse(toParse); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); String result = mapper.writeValueAsString(event); assertThat(result, containsString(toParse)); }

6. Serializzatore di data personalizzato

Successivamente, per ottenere il pieno controllo sull'output, utilizzeremo un serializzatore personalizzato per le date:

public class CustomDateSerializer extends StdSerializer { private SimpleDateFormat formatter = new SimpleDateFormat("dd-MM-yyyy hh:mm:ss"); public CustomDateSerializer() { this(null); } public CustomDateSerializer(Class t) { super(t); } @Override public void serialize (Date value, JsonGenerator gen, SerializerProvider arg2) throws IOException, JsonProcessingException { gen.writeString(formatter.format(value)); } }

Avanti, usiamolo come serializzatore del nostro campo " eventDate ":

public class Event { public String name; @JsonSerialize(using = CustomDateSerializer.class) public Date eventDate; }

Infine, proviamolo:

@Test public void whenUsingCustomDateSerializer_thenCorrect() throws JsonProcessingException, ParseException { SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm:ss"); String toParse = "20-12-2014 02:30:00"; Date date = df.parse(toParse); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); String result = mapper.writeValueAsString(event); assertThat(result, containsString(toParse)); }

7. Serializzare Joda-Time con Jackson

Le date non sono sempre un'istanza di java.util.Date ; in realtà - sono sempre più rappresentati da qualche altra classe - e una comune è, ovviamente, l' implementazione DateTime dalla libreria Joda-Time.

Vediamo come possiamo serializzare DateTime con Jackson .

Faremo uso della jackson-tipo di dati-joda modulo per out-of-the-box di supporto Joda-Time:

 com.fasterxml.jackson.datatype jackson-datatype-joda 2.9.7 

E ora possiamo semplicemente registrare il JodaModule ed essere fatto:

@Test public void whenSerializingJodaTime_thenCorrect() throws JsonProcessingException { DateTime date = new DateTime(2014, 12, 20, 2, 30, DateTimeZone.forID("Europe/London")); ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(new JodaModule()); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); String result = mapper.writeValueAsString(date); assertThat(result, containsString("2014-12-20T02:30:00.000Z")); }

8. Serializza Joda DateTime con il serializzatore personalizzato

Se non vogliamo la dipendenza Joda-Time Jackson extra, possiamo anche utilizzare un serializzatore personalizzato (simile agli esempi precedenti) per ottenere le istanze DateTime serializzate in modo pulito:

public class CustomDateTimeSerializer extends StdSerializer { private static DateTimeFormatter formatter = DateTimeFormat.forPattern("yyyy-MM-dd HH:mm"); public CustomDateTimeSerializer() { this(null); } public CustomDateTimeSerializer(Class t) { super(t); } @Override public void serialize (DateTime value, JsonGenerator gen, SerializerProvider arg2) throws IOException, JsonProcessingException { gen.writeString(formatter.print(value)); } }

Avanti, usiamolo come serializzatore della nostra proprietà " eventDate ":

public class Event { public String name; @JsonSerialize(using = CustomDateTimeSerializer.class) public DateTime eventDate; }

Infine, mettiamo tutto insieme e testiamolo:

@Test public void whenSerializingJodaTimeWithJackson_thenCorrect() throws JsonProcessingException { DateTime date = new DateTime(2014, 12, 20, 2, 30); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); String result = mapper.writeValueAsString(event); assertThat(result, containsString("2014-12-20 02:30")); }

9. Serializzare Java 8 Date con Jackson

Successivamente, vediamo come serializzare Java 8 DateTime - in questo esempio, LocalDateTime - usando Jackson . Possiamo utilizzare il modulo jackson-datatype-jsr310 :

 com.fasterxml.jackson.datatype jackson-datatype-jsr310 2.9.7 

Ora, tutto ciò che dobbiamo fare è registrare JavaTimeModule ( JSR310Module è deprecato) e Jackson si prenderà cura del resto:

@Test public void whenSerializingJava8Date_thenCorrect() throws JsonProcessingException { LocalDateTime date = LocalDateTime.of(2014, 12, 20, 2, 30); ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(new JavaTimeModule()); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); String result = mapper.writeValueAsString(date); assertThat(result, containsString("2014-12-20T02:30")); }

10. Serialize Java 8 Data senza alcuna dipendenza Extra

Se non vuoi la dipendenza extra, puoi sempre utilizzare un serializzatore personalizzato per scrivere Java 8 DateTime in JSON :

public class CustomLocalDateTimeSerializer extends StdSerializer { private static DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm"); public CustomLocalDateTimeSerializer() { this(null); } public CustomLocalDateTimeSerializer(Class t) { super(t); } @Override public void serialize( LocalDateTime value, JsonGenerator gen, SerializerProvider arg2) throws IOException, JsonProcessingException { gen.writeString(formatter.format(value)); } }

Avanti - usiamo il serializzatore per il nostro campo " eventDate ":

public class Event { public String name; @JsonSerialize(using = CustomLocalDateTimeSerializer.class) public LocalDateTime eventDate; }

Ora, proviamolo:

@Test public void whenSerializingJava8DateWithCustomSerializer_thenCorrect() throws JsonProcessingException { LocalDateTime date = LocalDateTime.of(2014, 12, 20, 2, 30); Event event = new Event("party", date); ObjectMapper mapper = new ObjectMapper(); String result = mapper.writeValueAsString(event); assertThat(result, containsString("2014-12-20 02:30")); }

11. Deserializza data

Successivamente, vediamo come deserializzare un appuntamento con Jackson . Nell'esempio seguente, deserializziamo un'istanza " Event " contenente una data:

@Test public void whenDeserializingDateWithJackson_thenCorrect() throws JsonProcessingException, IOException { String json = "{"name":"party","eventDate":"20-12-2014 02:30:00"}"; SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm:ss"); ObjectMapper mapper = new ObjectMapper(); mapper.setDateFormat(df); Event event = mapper.readerFor(Event.class).readValue(json); assertEquals("20-12-2014 02:30:00", df.format(event.eventDate)); }

12. Deserializza Joda ZonedDateTime mantenendo fuso orario

Nella sua configurazione predefinita, Jackson adatta il fuso orario di un Joda ZonedDateTime al fuso orario del contesto locale. Poiché, per impostazione predefinita, il fuso orario del contesto locale non è impostato e deve essere configurato manualmente, Jackson regola il fuso orario su GMT:

@Test public void whenDeserialisingZonedDateTimeWithDefaults_thenNotCorrect() throws IOException { ObjectMapper objectMapper = new ObjectMapper(); objectMapper.findAndRegisterModules(); objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); ZonedDateTime now = ZonedDateTime.now(ZoneId.of("Europe/Berlin")); String converted = objectMapper.writeValueAsString(now); ZonedDateTime restored = objectMapper.readValue(converted, ZonedDateTime.class); System.out.println("serialized: " + now); System.out.println("restored: " + restored); assertThat(now, is(restored)); }

Questo caso di test fallirà con l'output:

serialized: 2017-08-14T13:52:22.071+02:00[Europe/Berlin] restored: 2017-08-14T11:52:22.071Z[UTC]

Fortunatamente, c'è una soluzione rapida e semplice per questo strano comportamento predefinito: dobbiamo solo dire a Jackson, non modificare il fuso orario.

Questo può essere fatto aggiungendo la riga di codice sottostante al caso di test sopra:

objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);

Nota che, per preservare il fuso orario, dobbiamo anche disabilitare il comportamento predefinito di serializzare la data in base al timestamp.

13. Deserializzatore data personalizzato

Let's also see how to use a custom Date deserializer; we'll write a custom deserializer for the property “eventDate“:

public class CustomDateDeserializer extends StdDeserializer { private SimpleDateFormat formatter = new SimpleDateFormat("dd-MM-yyyy hh:mm:ss"); public CustomDateDeserializer() { this(null); } public CustomDateDeserializer(Class vc) { super(vc); } @Override public Date deserialize(JsonParser jsonparser, DeserializationContext context) throws IOException, JsonProcessingException { String date = jsonparser.getText(); try { return formatter.parse(date); } catch (ParseException e) { throw new RuntimeException(e); } } }

Next – let's use it as the “eventDate” deserializer:

public class Event { public String name; @JsonDeserialize(using = CustomDateDeserializer.class) public Date eventDate; }

And finally – let's test it:

@Test public void whenDeserializingDateUsingCustomDeserializer_thenCorrect() throws JsonProcessingException, IOException { String json = "{"name":"party","eventDate":"20-12-2014 02:30:00"}"; SimpleDateFormat df = new SimpleDateFormat("dd-MM-yyyy hh:mm:ss"); ObjectMapper mapper = new ObjectMapper(); Event event = mapper.readerFor(Event.class).readValue(json); assertEquals("20-12-2014 02:30:00", df.format(event.eventDate)); }

14. Fixing InvalidDefinitionException

When creating a LocalDate instance, we may come across an exception:

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Cannot construct instance of `java.time.LocalDate`(no Creators, like default construct, exist): no String-argument constructor/factory method to deserialize from String value ('2014-12-20') at [Source: (String)"2014-12-20"; line: 1, column: 1]

This problem occurs because JSON doesn't natively have a date format, so represents dates as String.

The String representation of a date isn't the same as an object of type LocalDate in memory, so we need an external deserializer to read that field from a String, and a serializer to render the date to String format.

These methods also apply to LocalDateTime — the only change is to use an equivalent class for LocalDateTime.

14.1. Jackson Dependency

Jackson allows us to fix this a couple of ways. First, we have to make sure the jsr310 dependency is in our pom.xml:

 com.fasterxml.jackson.datatype jackson-datatype-jsr310 2.11.0 

14.2. Serialization to Single Date Object

In order to be able to handle LocalDate, we need to register the JavaTimeModule with our ObjectMapper.

We also disable the feature WRITE_DATES_AS_TIMESTAMPS in ObjectMapper to prevent Jackson from adding time digits to the JSON output:

@Test public void whenSerializingJava8DateAndReadingValue_thenCorrect() throws IOException { String stringDate = "\"2014-12-20\""; ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(new JavaTimeModule()); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); LocalDate result = mapper.readValue(stringDate, LocalDate.class); assertThat(result.toString(), containsString("2014-12-20")); }

Here, we've used Jackson's native support for serializing and deserializing dates.

14.3. Annotation in POJO

Another way to deal with that problem is to use the LocalDateDeserializer and JsonFormat annotations at the entity level:

public class EventWithLocalDate { @JsonDeserialize(using = LocalDateDeserializer.class) @JsonSerialize(using = LocalDateSerializer.class) @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy") public LocalDate eventDate; }

The @JsonDeserialize annotation is used to specify a custom deserializer to unmarshal the JSON object. Similarly, @JsonSerialize indicates a custom serializer to use when marshaling the entity.

In addition, the annotation @JsonFormat allows us to specify the format to which we will serialize date values. Therefore, this POJO can be used to read and write the JSON:

@Test public void whenSerializingJava8DateAndReadingFromEntity_thenCorrect() throws IOException { String json = "{\"name\":\"party\",\"eventDate\":\"20-12-2014\"}"; ObjectMapper mapper = new ObjectMapper(); EventWithLocalDate result = mapper.readValue(json, EventWithLocalDate.class); assertThat(result.getEventDate().toString(), containsString("2014-12-20")); }

While this approach takes more work than using the JavaTimeModule defaults, it's a lot more customizable.

15. Conclusion

In this extensive Date article, we looked at several ways Jackson can help marshal and unmarshal a date to JSON using a sensible format we have control over.

Come sempre, il codice di esempio può essere trovato su GitHub.