How to make JsonGenerator pretty-print Date and DateTime values?

Question

I'm using this method to convert any object to a json string:

private String objectToJson(Object object) throws IOException {
        // write JSON
        StringWriter writer = new StringWriter();
        ObjectMapper mapper = new ObjectMapper();
        final JsonGenerator jsonGenerator = mapper.getJsonFactory().createJsonGenerator(writer);
        jsonGenerator.setPrettyPrinter(new DefaultPrettyPrinter());

        mapper.writeValue(jsonGenerator, object);
        return writer.toString();
    }

When the object being printed contains fields that are java.util.Date or jodatime's DateTime, the printed value is the number of milliseconds since the epoch. I would like, instead, to pretty-print them in a standard "HH:MM:SS" notation. How should I go about doing this?

score 8 · Accepted Answer · answered Dec 14 '10 at 21:43

8

Because the epoch timestamp (number of milliseconds since January 1st, 1970, UTC) is the most efficient and accurate representation of the time, nearly all date and time related objects are serialized to it. You can of course overwrite it and if you want to use the format mentioned in the question, you'd need to add the following to your code:

DateFormat myDateFormat = new SimpleDateFormat("hh:mm:ss");
objectMapper.getSerializationConfig().setDateFormat(myDateFormat);
objectMapper.getDeserializationConfig().setDateFormat(myDateFormat);

For more information regarding dates and times in the Jackson JSON-processor see the following link: http://wiki.fasterxml.com/JacksonFAQDateHandling

answered Dec 14 '10 at 21:43

Tim

831
7
7

2

the new form (because setDateFormat is marked as ``deprecated`` is actually ``getDeserializationConfig().withDateFormat(...)`` now – Jeremy S. Aug 24 '11 at 15:00
1

I believe `objectMapper.setDateFormat(df)` is the preferred way at this time (version 1.8+). See: http://jackson.codehaus.org/1.8.8/javadoc/org/codehaus/jackson/map/ObjectMapper.html#setDateFormat(java.text.DateFormat) – Patrick Sep 10 '12 at 18:52

StaxMan · Answer 2 · 2011-01-03T18:40:54.097

8

This was already mentioned in FAQ first answer points to, but just in case: you can choose between numeric and textual representation (numeric being used by default since it is much faster) by using this feature:

objectMapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);

doing this will use the default date format, which you can then redefine as mentioned (with setDateFormat).

Also: you can simplify you code like so:

ObjectMapper mapper = new ObjectMapper();
mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true);
mapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);
return mapper.writeValueAsString(object);

instead of using StringWriter and JsonGenerator explicitly.

edited Jan 03 '11 at 18:40

answered Dec 19 '10 at 18:50

StaxMan

113,358
34
211
239

+1 for cleaner solution. However I needed to use SerializationConfig.Feature.INDENT_OUTPUT. – John in MD Jan 03 '11 at 17:15
ah. my bad, will fix the typo – StaxMan Jan 03 '11 at 18:40
1

Note if you are using Spring 3.1+ you can easily use a custom ObjectMapper by following Ryan's answer to http://stackoverflow.com/questions/7672211/java-spring-jackons-date-serialization – Korny Mar 01 '13 at 01:04

How to make JsonGenerator pretty-print Date and DateTime values?

2 Answers2

Linked