Джаксън Дата

1. Общ преглед

В този урок ще сериализираме дати с Джаксън. Ще започнем със сериализиране на прост java.util. Дата , след това Joda-Time, както и Java 8 DateTime .

2. Сериализирайте датата към клеймото за време

Първо - нека видим как да сериализираме прост java.util.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); }

Важното тук е, че Джаксън ще сериализира датата във формат на клеймо по подразбиране (брой милисекунди от 1 януари 1970 г., UTC).

Действителният изход на сериализацията „ събитие “ е:

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

3. Дата на сериализиране до ISO-8601

Сериализирането на този кратък формат на клеймо не е оптимално. Нека сега сериализираме датата във формат 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")); }

Обърнете внимание как представянето на датата вече е много по-четливо.

4. Конфигурирайте ObjectMapper DateFormat

Предишните решения все още нямат пълната гъвкавост при избора на точния формат, който да представя екземплярите на java.util.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)); }

Имайте предвид, че въпреки че вече сме по-гъвкави по отношение на формата на датата - все още използваме глобална конфигурация на нивото на целия ObjectMapper .

5. Използвайте @JsonFormat, за да форматирате дата

След това нека да разгледаме анотацията @JsonFormat, за да контролираме формата на датата за отделни класове, вместо глобално, за цялото приложение:

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

Сега - нека го тестваме:

@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. Персонализиран сериализатор за дати

След това - за да получим пълен контрол върху изхода, ще използваме персонализиран сериализатор за дати:

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

След това - нека го използваме като сериализатор на нашето поле „ eventDate “:

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

И накрая - нека го тестваме:

@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. Сериализирайте Joda-Time с Джаксън

Датите не винаги са екземпляр на java.util.Date ; всъщност - те са все повече и повече представени от някакъв друг клас - и общ е, разбира се, изпълнението на DateTime от библиотеката Joda-Time.

Нека да видим как можем да сериализираме DateTime с Джаксън .

Ще използваме модула jackson-datatype-joda за изчерпателна поддръжка на Joda -Time:

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

И сега можем просто да регистрираме JodaModule и да свършим:

@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. Сериализирайте Joda DateTime с персонализиран сериализатор

Ако не искаме допълнителната зависимост на Joda-Time Jackson - можем да използваме и персонализиран сериализатор (подобно на по-ранните примери), за да получим екземплярите DateTime сериализирани чисто:

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

След това - нека го използваме като свой сериализатор “ eventDate ”:

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

И накрая - нека съберем всичко и го тестваме:

@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. Сериализирайте Java 8 Date With Jackson

След това - нека видим как да сериализираме Java 8 DateTime - в този пример, LocalDateTime - с помощта на Jackson . Можем да използваме модула jackson-datatype-jsr310 :

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

Сега всичко, което трябва да направим, е да регистрираме JavaTimeModule ( JSR310Module е оттеглено) и Jackson ще се погрижи за останалото:

@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. Сериализирайте Java 8 Date без никаква допълнителна зависимост

Ако не искате допълнителната зависимост, винаги можете да използвате персонализиран сериализатор, за да запишете Java 8 DateTime в 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)); } }

След това - нека използваме сериализатора за нашето поле „ eventDate “:

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

Сега - нека го тестваме:

@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. Десериализирайте дата

След това - нека видим как да десериализираме дата с Джаксън . В следния пример - десериализираме екземпляр „ Събитие “, съдържащ дата:

@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. Deserialize Joda ZonedDateTime With Time Zone Preserved

In its default configuration, Jackson adjusts the time zone of a Joda ZonedDateTime to the time zone of the local context. As, by default, the time zone of the local context is not set and has to be configured manually, Jackson adjusts the time zone to 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)); }

This test case will fail with output:

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

Fortunately, there is a quick and simple fix for this odd default-behavior: we just have to tell Jackson, not to adjust the time zone.

This can be done by adding the below line of code to the above test case:

objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);

Note that, to preserve time zone we also have to disable the default behavior of serializing the date to the timestamp.

13. Custom Date Deserializer

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.

Както винаги, примерите могат да бъдат намерени в GitHub.