Come serializzare Joda DateTime con il processore Jackson JSON?

Come faccio a convincere Jackson a serializzare il mio oggetto Joda DateTime secondo uno schema semplice (come "dd-MM-yyyy")?

Ho provato:

@JsonSerialize(using=DateTimeSerializer.class)
private final DateTime date;

Ho anche provato:

ObjectMapper mapper = new ObjectMapper()
    .getSerializationConfig()
    .setDateFormat(df);

Grazie!

Questo è diventato molto semplice con Jackson 2.0 e il modulo Joda.

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JodaModule());

Dipendenza da Maven:

<dependency>
  <groupId>com.fasterxml.jackson.datatype</groupId>
  <artifactId>jackson-datatype-joda</artifactId>
  <version>2.1.1</version>
</dependency>  

Codice e documentazione: https://github.com/FasterXML/jackson-datatype-joda

Binari: http://repo1.maven.org/maven2/com/fasterxml/jackson/datatype/jackson-datatype-joda/

Nell'oggetto che stai mappando:

@JsonSerialize(using = CustomDateSerializer.class)
public DateTime getDate() { ... }

In CustomDateSerializer:

public class CustomDateSerializer extends JsonSerializer<DateTime> {

    private static DateTimeFormatter formatter = 
        DateTimeFormat.forPattern("dd-MM-yyyy");

    @Override
    public void serialize(DateTime value, JsonGenerator gen, 
                          SerializerProvider arg2)
        throws IOException, JsonProcessingException {

        gen.writeString(formatter.print(value));
    }
}

Come ha detto @Kimble, con Jackson 2, utilizzare la formattazione predefinita è molto semplice; registrati semplicemente JodaModulesul tuo ObjectMapper.

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JodaModule());

Per la serializzazione / deserializzazione personalizzata di DateTime, è necessario implementare il proprio StdScalarSerializere StdScalarDeserializer; è piuttosto contorto, ma comunque.

Ad esempio, ecco un file DateTime serializzatore che utilizza il ISODateFormatcon il fuso orario UTC:

public class DateTimeSerializer extends StdScalarSerializer<DateTime> {

    public DateTimeSerializer() {
        super(DateTime.class);
    }

    @Override
    public void serialize(DateTime dateTime,
                          JsonGenerator jsonGenerator,
                          SerializerProvider provider) throws IOException, JsonGenerationException {
        String dateTimeAsString = ISODateTimeFormat.withZoneUTC().print(dateTime);
        jsonGenerator.writeString(dateTimeAsString);
    }
}

E il corrispondente de-serializzatore:

public class DateTimeDesrializer extends StdScalarDeserializer<DateTime> {

    public DateTimeDesrializer() {
        super(DateTime.class);
    }

    @Override
    public DateTime deserialize(JsonParser jsonParser,
                                DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
        try {
            JsonToken currentToken = jsonParser.getCurrentToken();
            if (currentToken == JsonToken.VALUE_STRING) {
                String dateTimeAsString = jsonParser.getText().trim();
                return ISODateTimeFormat.withZoneUTC().parseDateTime(dateTimeAsString);
            }
        } finally {
            throw deserializationContext.mappingException(getValueClass());
        }
    }

Quindi collegali insieme a un modulo:

public class DateTimeModule extends SimpleModule {

    public DateTimeModule() {
        super();
        addSerializer(DateTime.class, new DateTimeSerializer());
        addDeserializer(DateTime.class, new DateTimeDeserializer());
    }
}

Quindi registra il modulo sul tuo ObjectMapper:

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new DateTimeModule());

La soluzione facile

Ho riscontrato un problema simile e la mia soluzione è molto chiara rispetto a quella precedente.

Ho semplicemente usato il modello in @JsonFormat annotazione

Fondamentalmente la mia classe ha un DateTimecampo, quindi metto un'annotazione attorno al getter:

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
public DateTime getDate() {
    return date;
}

Serializzo la classe con ObjectMapper

    ObjectMapper mapper = new ObjectMapper();
    mapper.registerModule(new JodaModule());
    mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
    ObjectWriter ow = mapper.writer();
    try {
        String logStr = ow.writeValueAsString(log);
        outLogger.info(logStr);
    } catch (IOException e) {
        logger.warn("JSON mapping exception", e);
    }

Usiamo Jackson 2.5.4

https://stackoverflow.com/a/10835114/1113510

Sebbene tu possa inserire un'annotazione per ogni campo data, è meglio fare una configurazione globale per il tuo mappatore oggetti. Se usi jackson puoi configurare la tua molla come segue:

<bean id="jacksonObjectMapper" class="com.company.CustomObjectMapper" />

<bean id="jacksonSerializationConfig" class="org.codehaus.jackson.map.SerializationConfig"
    factory-bean="jacksonObjectMapper" factory-method="getSerializationConfig" >
</bean>

Per CustomObjectMapper:

public class CustomObjectMapper extends ObjectMapper {

    public CustomObjectMapper() {
        super();
        configure(Feature.WRITE_DATES_AS_TIMESTAMPS, false);
        setDateFormat(new SimpleDateFormat("EEE MMM dd yyyy HH:mm:ss 'GMT'ZZZ (z)"));
    }
}

Naturalmente, SimpleDateFormat può utilizzare qualsiasi formato di cui hai bisogno.

Nel frattempo Jackson registra automaticamente il modulo Joda quando JodaModule è in classpath. Ho appena aggiunto jackson-datatype-joda a Maven e ha funzionato immediatamente.

<dependency>
  <groupId>com.fasterxml.jackson.datatype</groupId>
  <artifactId>jackson-datatype-joda</artifactId>
  <version>2.8.7</version>
</dependency>

Uscita JSON:

{"created" : "2017-03-28T05:59:27.258Z"}

Per quelli con Spring Boot devi aggiungere il modulo al tuo contesto e verrà aggiunto alla tua configurazione in questo modo.

@Bean
public Module jodaTimeModule() {
    return new JodaModule();
}

E se vuoi usare il nuovo modulo java8 time jsr-310.

@Bean
public Module jodaTimeModule() {
    return new JavaTimeModule();
}

Sembra che per Jackson 1.9.12 non ci sia tale possibilità per impostazione predefinita, a causa di:

public final static class DateTimeSerializer
    extends JodaSerializer<DateTime>
{
    public DateTimeSerializer() { super(DateTime.class); }

    @Override
    public void serialize(DateTime value, JsonGenerator jgen, SerializerProvider provider)
        throws IOException, JsonGenerationException
    {
        if (provider.isEnabled(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS)) {
            jgen.writeNumber(value.getMillis());
        } else {
            jgen.writeString(value.toString());
        }
    }

    @Override
    public JsonNode getSchema(SerializerProvider provider, java.lang.reflect.Type typeHint)
    {
        return createSchemaNode(provider.isEnabled(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS)
                ? "number" : "string", true);
    }
}

Questa classe serializza i dati utilizzando il metodo toString () di Joda DateTime.

L'approccio proposto da Rusty Kuntz funziona perfettamente per il mio caso.

Sto usando Java 8 e questo ha funzionato per me.

Aggiungi la dipendenza da pom.xml

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
    <version>2.4.0</version>
</dependency>

e aggiungi JodaModule sul tuo ObjectMapper

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JodaModule());