Como serializar Joda DateTime com processador Jackson JSON?

Como faço para que Jackson serialize meu objeto Joda DateTime de acordo com um padrão simples (como "dd-MM-aaaa")?

Eu tentei:

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

Eu também tentei:

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

Obrigado!

Isso se tornou muito fácil com Jackson 2.0 e o módulo Joda.

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

Dependência de Maven:

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

Código e documentação: https://github.com/FasterXML/jackson-datatype-joda

Binários: http://repo1.maven.org/maven2/com/fasterxml/jackson/datatype/jackson-datatype-joda/

No objeto que você está mapeando:

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

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

Como @Kimble disse, com Jackson 2, usar a formatação padrão é muito fácil; basta se cadastrar JodaModuleno seu ObjectMapper.

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

Para serialização / desserialização customizada de DateTime, você precisa implementar seu próprio StdScalarSerializere StdScalarDeserializer; é muito complicado, mas de qualquer maneira.

Por exemplo, aqui está um DateTimeserializador que usa ISODateFormatcom o fuso horário 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 o desserializador correspondente:

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

Em seguida, vincule-os com um módulo:

public class DateTimeModule extends SimpleModule {

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

Em seguida, registre o módulo em ObjectMapper:

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

A solução fácil

Encontrei um problema semelhante e minha solução é muito mais clara do que a acima.

Eu simplesmente usei o padrão na @JsonFormat anotação

Basicamente, minha classe tem um DateTimecampo, então coloco uma anotação ao redor do getter:

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

Eu serializo a classe com 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);
    }

Usamos Jackson 2.5.4

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

Embora você possa colocar uma anotação para cada campo de data, é melhor fazer uma configuração global para seu mapeador de objetos. Se você usa jackson, pode configurar sua mola da seguinte maneira:

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

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

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

Claro, SimpleDateFormat pode usar qualquer formato de que você precisa.

Enquanto isso, Jackson registra o módulo Joda automaticamente quando o JodaModule está no caminho de classe. Acabei de adicionar jackson-datatype-joda ao Maven e funcionou instantaneamente.

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

Saída JSON:

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

Para aqueles com Spring Boot, você deve adicionar o módulo ao seu contexto e ele será adicionado à sua configuração assim.

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

E se você quiser usar o novo módulo de tempo java8 jsr-310.

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

Parece que para Jackson 1.9.12 não existe essa possibilidade por padrão, devido a:

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

Esta classe serializa os dados usando o método toString () do Joda DateTime.

A abordagem proposta por Rusty Kuntz funciona perfeitamente para o meu caso.

Estou usando Java 8 e isso funcionou para mim.

Adicione a dependência de pom.xml

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

e adicionar JodaModule em seu ObjectMapper

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