วิธีการทำให้ Joda DateTime เป็นอนุกรมกับโปรเซสเซอร์ Jackson JSON


118

ฉันจะให้แจ็คสันทำให้เป็นซีเรียลไลซ์อ็อบเจ็กต์ Joda DateTime ตามรูปแบบง่ายๆ (เช่น "dd-MM-yyyy") ได้อย่างไร

ฉันพยายามแล้ว:

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

ฉันได้ลองแล้ว:

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

ขอบคุณ!


ทั้งสองข้างต้นจะจริงยังทำงาน (@JsonSerialize ควรบ่งบอกถึงข้อมูลที่จะต่อเนื่องกันและรูปแบบวันที่ควรใช้อย่างยิ่งสำหรับการ Joda) ดังนั้นคุณอาจต้องการที่จะยื่นข้อผิดพลาดที่ Jira jira.codehaus.org/browse/JACKSON
StaxMan

ฉันตระหนักดีว่าคำถามนี้เกิดขึ้นเมื่อไม่นานมานี้ แต่สำหรับการอ้างอิงในอนาคต objectMapper.getSerializationConfig (). setDateFormat (df) ถูกเลิกใช้แล้ว แนะนำ objectMapper.setDateFormat (df) แล้ว
Patrick

คำตอบ:


146

สิ่งนี้กลายเป็นเรื่องง่ายมากสำหรับ 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/


13
คุณช่วยขยายความได้ไหม โค้ดนี้ไปที่ไหนและอินสแตนซ์ ObjectMapper ใช้อย่างไร
พอล

คุณควรถามคำถามเฉพาะเกี่ยวกับการใช้ api และ Maven ของ Jackson รหัสจะไปที่ใดขึ้นอยู่กับว่าคุณใช้เฟรมเวิร์กใด / วิธีบูตแอปพลิเคชันของคุณ
Kimble

4
เมื่อฉันเพิ่มว่าฉันได้รับข้อผิดพลาดในการคอมไพล์ "ประเภทที่เข้ากันไม่ได้: JodaModule ไม่สามารถแปลงเป็นโมดูล" - วิธีการนี้คาดว่าจะเป็น org.codehaus.jackson.map.Module แต่ JodaModule ไม่มีสิ่งนี้ในมรดกดังนั้นวิธีนี้จะทำงานได้อย่างไร
Martin Charlesworth

4
สัญญา แต่ปัจจุบันแทบไม่มีประโยชน์เนื่องจากเราไม่สามารถระบุรูปแบบวันที่ที่จะแยกวิเคราะห์ได้ :(
Vincent Mimoun-Prat

10
คุณต้องปิดใช้งานการทำให้เป็นอนุกรมเป็นเวลาประทับ objectMapper.disable (SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
MarekM

74

ในวัตถุที่คุณกำลังแมป:

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

4
จะลงทะเบียน CustomDateSerializer ใน spring mvc 3 ได้อย่างไร
digz6666

1
ฉันไม่รู้เกี่ยวกับ Spring MVC3 แต่คุณสามารถเพิ่มซีเรียลไลเซอร์แบบกำหนดเองให้กับอ็อบเจ็กต์ผู้ทำแผนที่แจ็คสัน ดูรายการนี้ใน Jacksonคุณต้องสร้างโมดูลอย่างง่ายสำหรับ SimpleModule isoDateTimeModule = SimpleModule ใหม่ ("ISODateTimeModule", เวอร์ชันใหม่ (1, 0, 0, null)); isoDateTimeModule.addSerializer (ใหม่ JsonISODateTimeFormatSerializer ()); mapper.registerModule (isoDateTimeModule);
Guillaume Belrose

1
@ digz6666 ดูคำตอบของฉันที่นี่สำหรับ Spring MVC 3: stackoverflow.com/questions/7854030/…
Aram Kocharyan

หมายเหตุ - ให้แน่ใจว่าจะใช้เรียนข้างต้นจากมากกว่าorg.codehaus.jackson com.fasterxml.jackson.coreการใช้แพ็คเกจที่สองไม่ได้ผลสำหรับฉัน อันที่จริงแอพ Jersey ของฉันไม่เคารพ@JsonSerializedคำอธิบายประกอบเลยด้วยซ้ำ
Kevin Meredith

คำตอบได้ผลสำหรับฉัน แต่จะต้องมีคำอธิบายประกอบนี้ในทุกฟิลด์ มีการกำหนดค่าส่วนกลางสำหรับสิ่งนี้ที่ใช้ได้กับ Jackson หรือไม่?
Taher

26

ดังที่ @Kimble ได้กล่าวไว้กับ Jackson 2 การใช้การจัดรูปแบบเริ่มต้นนั้นง่ายมาก เพียงลงทะเบียนJodaModuleบนObjectMapperไฟล์.

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

สำหรับการทำให้เป็นอนุกรม / การทำให้เป็นอนุกรมที่กำหนดเองDateTimeคุณต้องใช้งานของคุณเองStdScalarSerializerและStdScalarDeserializer; มันค่อนข้างซับซ้อน แต่อย่างไรก็ตาม

ตัวอย่างเช่นนี่คือDateTimeserializer ที่ใช้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);
    }
}

และ de-serializer ที่สอดคล้องกัน:

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

วัตถุ DatatIme deserilazed อยู่ในเขตเวลา UTC หรือเขตเวลาอื่นของเบราว์เซอร์โปรดช่วยฉันด้วย
user3354457

สิ่งนี้ลงทะเบียนผู้ทำแผนที่ (และโมดูล) ทั่วโลกหรือไม่
raffian

16

ทางออกที่ง่าย

ฉันพบปัญหาที่คล้ายกันและวิธีแก้ปัญหาของฉันชัดเจนกว่าข้างต้นมาก

ฉันใช้รูปแบบใน @JsonFormat คำอธิบายประกอบ

โดยทั่วไปชั้นเรียนของฉันมีDateTimeฟิลด์ดังนั้นฉันจึงใส่คำอธิบายประกอบไว้รอบ ๆ getter:

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

เราใช้แจ็คสัน 2.5.4


15

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 สามารถใช้รูปแบบใดก็ได้ที่คุณต้องการ


4
setDateFormat(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssz"));ทำเคล็ดลับให้ฉันขอบคุณ
Konsumierer

8

ในขณะเดียวกัน Jackson จะลงทะเบียนโมดูล Joda โดยอัตโนมัติเมื่อ JodaModule อยู่ใน classpath ฉันเพิ่งเพิ่ม jackson-datatype-joda ให้กับ Maven และมันก็ใช้งานได้ทันที

<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"}

6

สำหรับผู้ที่มี Spring Boot คุณต้องเพิ่มโมดูลลงในบริบทของคุณและจะถูกเพิ่มในการกำหนดค่าของคุณเช่นนี้

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

และถ้าคุณต้องการใช้โมดูลเวลา java8 ใหม่ jsr-310

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

3

ดูเหมือนว่าสำหรับ 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

แนวทางที่เสนอโดย Rusty Kuntz เหมาะสำหรับกรณีของฉัน


คุณยังคงสามารถลงทะเบียน serializer และ deserializer แบบกำหนดเองได้และสิ่งเหล่านี้จะมีความสำคัญเหนือการใช้งานเริ่มต้น
StaxMan

2

ฉันใช้ 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());
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.