Как сериализовать Joda DateTime с процессором Jackson JSON?

Как мне заставить Джексона сериализовать мой объект Joda DateTime в соответствии с простым шаблоном (например, «дд-мм-гггг»)?

Я пробовал:

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

Я также пробовал:

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

Спасибо!

Это стало очень просто с Jackson 2.0 и модулем Joda.

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

Зависимость от Maven:

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

Код и документация: https://github.com/FasterXML/jackson-datatype-joda

Двоичные файлы: http://repo1.maven.org/maven2/com/fasterxml/jackson/datatype/jackson-datatype-joda/

В отображаемом объекте:

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

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

Как сказал @Kimble, с Jackson 2 очень легко использовать форматирование по умолчанию; просто зарегистрируйтесь JodaModuleна своем ObjectMapper.

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

Для пользовательской сериализации / десериализации DateTimeвам необходимо реализовать свои собственные StdScalarSerializerиStdScalarDeserializer ; это довольно запутанно, но все равно.

Например, вот DateTimeсериализатор, который использует ISODateFormatчасовой пояс 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);
    }
}

И соответствующий десериализатор:

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

Затем свяжите их вместе модулем:

public class DateTimeModule extends SimpleModule {

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

Затем зарегистрируйте модуль на своем ObjectMapper:

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

Простое решение

Я столкнулся с подобной проблемой, и мое решение намного яснее, чем указано выше.

Я просто использовал узор в @JsonFormat аннотации

В основном у моего класса есть DateTimeполе, поэтому я помещаю аннотацию вокруг получателя:

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

Я сериализую класс с помощью 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);
    }

Мы используем Jackson 2.5.4

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

Хотя вы можете разместить аннотацию для каждого поля даты, лучше сделать глобальную конфигурацию для вашего сопоставителя объектов. Если вы используете Джексон, вы можете настроить свою пружину следующим образом:

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

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

Для 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)"));
    }
}

Конечно, SimpleDateFormat может использовать любой нужный вам формат.

Тем временем Джексон автоматически регистрирует модуль Joda, когда JodaModule находится в пути к классам. Я просто добавил в Maven jackson-datatype-joda, и он сразу заработал.

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

Вывод JSON:

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

Для тех, у кого есть Spring Boot, вам нужно добавить модуль в свой контекст, и он будет добавлен в вашу конфигурацию следующим образом.

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

И если вы хотите использовать новый модуль времени java8 jsr-310.

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

Похоже, что для Jackson 1.9.12 такой возможности по умолчанию нет из-за:

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

Этот класс сериализует данные с помощью метода toString () Joda DateTime.

Подход, предложенный Расти Кунцем, идеально подходит для моего случая.

Я использую Java 8, и у меня это сработало.

Добавьте зависимость от pom.xml

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

и добавьте JodaModule на свой ObjectMapper

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