Jak serializować Joda DateTime z procesorem Jackson JSON?

Jak zmusić Jacksona do serializacji mojego obiektu Joda DateTime zgodnie z prostym wzorcem (np. „Dd-MM-yyyy”)?

Próbowałem:

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

Próbowałem też:

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

Dzięki!

Stało się to bardzo łatwe dzięki Jacksonowi 2.0 i modułowi Joda.

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

Zależność Mavena:

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

Kod i dokumentacja: https://github.com/FasterXML/jackson-datatype-joda

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

W obiekcie, który mapujesz:

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

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

Jak powiedział @Kimble, w przypadku Jackson 2 użycie domyślnego formatowania jest bardzo łatwe; po prostu zarejestruj się JodaModulena swoim ObjectMapper.

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

W przypadku niestandardowej serializacji / deserializacji programu DateTimenależy zaimplementować własne StdScalarSerializeri StdScalarDeserializer; jest to dość zawiłe, ale i tak.

Na przykład, oto DateTimeserializator, który używa ISODateFormatze strefą czasową 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);
    }
}

I odpowiedni desserializator:

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

Następnie połącz je razem z modułem:

public class DateTimeModule extends SimpleModule {

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

Następnie zarejestruj moduł na swoim ObjectMapper:

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

Proste rozwiązanie

Napotkałem podobny problem i moje rozwiązanie jest znacznie jasne niż powyżej.

Po prostu użyłem wzorca w @JsonFormat adnotacji

Zasadniczo moja klasa ma DateTimepole, więc umieściłem adnotację wokół gettera:

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

Serializuję klasę z 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);
    }

Używamy Jackson 2.5.4

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

Chociaż możesz umieścić adnotację dla każdego pola daty, lepiej jest wykonać globalną konfigurację dla programu mapowania obiektów. Jeśli używasz jacksona, możesz skonfigurować swoją sprężynę w następujący sposób:

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

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

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

Oczywiście SimpleDateFormat może używać dowolnego formatu.

W międzyczasie Jackson automatycznie rejestruje moduł Joda, gdy JodaModule znajduje się w ścieżce klas. Właśnie dodałem jackson-datatype-joda do Mavena i zadziałało natychmiast.

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

Wyjście JSON:

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

Dla tych z Spring Boot musisz dodać moduł do swojego kontekstu i zostanie dodany do twojej konfiguracji w ten sposób.

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

A jeśli chcesz użyć nowego modułu czasu java8 jsr-310.

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

Wygląda na to, że w przypadku Jacksona 1.9.12 domyślnie nie ma takiej możliwości, ponieważ:

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

Ta klasa serializuje dane przy użyciu metody toString () Joda DateTime.

Podejście zaproponowane przez Rusty'ego Kuntza sprawdza się idealnie w moim przypadku.

Używam Java 8 i to zadziałało.

Dodaj zależność od pom.xml

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

i dodaj JodaModule do swojego ObjectMapper

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