Jackson fecha

1. Información general

En este tutorial, serializaremos fechas con Jackson. Comenzaremos serializando un java.util simple. Date , luego Joda-Time y Java 8 DateTime .

2. Serializar la fecha en la marca de tiempo

Primero, veamos cómo serializar un java.util.Date simple con Jackson .

En el siguiente ejemplo, serializaremos una instancia de " Evento " que tiene un campo de fecha " 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); }

Lo importante aquí es que Jackson serializará la fecha en un formato de marca de tiempo de forma predeterminada (cantidad de milisegundos desde el 1 de enero de 1970, UTC).

El resultado real de la serialización del " evento " es:

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

3. Serializar la fecha en ISO-8601

Serializar a este formato de marca de tiempo conciso no es óptimo. Ahora serialicemos la fecha al 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")); }

Observe cómo la representación de la fecha ahora es mucho más legible.

4. Configurar ObjectMapper DateFormat

Las soluciones anteriores todavía carecen de la flexibilidad total de elegir el formato exacto para representar las instancias java.util.Date .

Echemos ahora un vistazo a una configuración que nos permitirá establecer nuestros formatos para representar fechas :

@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)); }

Tenga en cuenta que, aunque ahora somos más flexibles con respecto al formato de fecha, todavía estamos usando una configuración global a nivel de todo el ObjectMapper .

5. Use @JsonFormat para formatear la fecha

A continuación, echemos un vistazo a la anotación @JsonFormat para controlar el formato de fecha en clases individuales en lugar de globalmente, para toda la aplicación:

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

Ahora, probémoslo:

@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. Serializador de fecha personalizado

A continuación, para obtener un control total sobre la salida, aprovecharemos un serializador personalizado para fechas:

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)); } }

A continuación, usémoslo como serializador de nuestro campo " eventDate ":

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

Finalmente, probémoslo:

@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. Serializar Joda-Time con Jackson

Las fechas no siempre son una instancia de java.util.Date ; en realidad, están cada vez más representados por alguna otra clase, y uno común es, por supuesto, la implementación de DateTime de la biblioteca Joda-Time.

Veamos cómo podemos serializar DateTime con Jackson .

Usaremos el módulo jackson-datatype-joda para soporte de Joda-Time listo para usar :

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

Y ahora podemos simplemente registrar el JodaModule y listo:

@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. Serializar Joda DateTime con serializador personalizado

Si no queremos la dependencia adicional de Joda-Time Jackson, también podemos hacer uso de un serializador personalizado (similar a los ejemplos anteriores) para obtener instancias de DateTime serializadas limpiamente:

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)); } }

A continuación, usémoslo como nuestro serializador de propiedad " eventDate ":

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

Finalmente, juntemos todo y probémoslo:

@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. Serializar Java 8 Date con Jackson

A continuación, veamos cómo serializar Java 8 DateTime , en este ejemplo, LocalDateTime , usando Jackson . Podemos hacer uso del módulo jackson-datatype-jsr310 :

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

Ahora, todo lo que tenemos que hacer es registrar JavaTimeModule ( JSR310Module está en desuso) y Jackson se encargará 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. Serializar Java 8 Date sin ninguna dependencia adicional

Si no desea la dependencia adicional, siempre puede usar un serializador personalizado para escribir Java 8 DateTime en 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)); } }

A continuación, usemos el serializador para nuestro campo " eventDate ":

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

Ahora, probémoslo:

@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. Deserializar fecha

A continuación, veamos cómo deserializar una cita con Jackson . En el siguiente ejemplo, deserializamos una instancia de " Evento " que contiene una fecha:

@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. Deserializar Joda ZonedDateTime con la zona horaria preservada

En su configuración predeterminada, Jackson ajusta la zona horaria de Joda ZonedDateTime a la zona horaria del contexto local. Como, de forma predeterminada, la zona horaria del contexto local no está configurada y debe configurarse manualmente, Jackson ajusta la zona horaria a 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)); }

Este caso de prueba fallará con la salida:

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

Afortunadamente, hay una solución rápida y sencilla para este extraño comportamiento predeterminado: solo tenemos que decirle a Jackson que no ajuste la zona horaria.

Esto se puede hacer agregando la siguiente línea de código al caso de prueba anterior:

objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);

Tenga en cuenta que, para preservar la zona horaria, también tenemos que deshabilitar el comportamiento predeterminado de serializar la fecha en la marca de tiempo.

13. Deserializador de fecha personalizada

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.

Como siempre, el código de ejemplos se puede encontrar en GitHub.