如何使用 Jackson JSON 处理器序列化 Joda DateTime？

Posted 2023-02-15

【中文标题】如何使用 Jackson JSON 处理器序列化 Joda DateTime？

【英文标题】：How to serialize Joda DateTime with Jackson JSON processor?

【发布时间】：2011-03-17 05:10:49

【问题描述】：

如何让 Jackson 根据简单模式（如“dd-MM-yyyy”）序列化我的 Joda DateTime 对象？

我试过了：

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

我也试过了：

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

谢谢！

【问题讨论】：

以上两者实际上也应该有效（@JsonSerialize 应该暗示该字段将被序列化；并且日期格式也应该理想地适用于 Joda），因此您可能需要在 @987654321 提交 Jira 错误@.

我意识到这个问题是很久以前提出的，但为了将来的参考，现在不推荐使用 objectMapper.getSerializationConfig().setDateFormat(df)。现在建议使用 objectMapper.setDateFormat(df)。

另见***.com/questions/27952472/…

【参考方案1】：

我正在使用 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());

【参考方案2】：

简单的解决方案

我也遇到过类似的问题，我的解决方法比上面的要清楚很多。

我只是在 @JsonFormat annotation

中使用了模式

基本上我的班级有一个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);
    

我们使用 Jackson 2.5.4

【参考方案3】：

同时，当 JodaModule 在类路径中时，Jackson 会自动注册 Joda 模块。我刚刚将 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"

【参考方案4】：

对于那些使用 Spring Boot 的人，您必须将模块添加到您的上下文中，它将像这样添加到您的配置中。

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

如果你想使用新的 java8 时间模块 jsr-310。

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

【参考方案5】：

正如@Kimble 所说，使用Jackson 2，使用默认格式非常容易；只需在您的ObjectMapper 上注册JodaModule。

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

DateTime的自定义序列化/反序列化需要实现自己的StdScalarSerializer和StdScalarDeserializer；这很令人费解，但无论如何。

例如，这是一个 DateTime 序列化程序，它使用带有 UTC 时区的 ISODateFormat：

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

【讨论】：

反序列化的 DatatIme 对象位于 UTC 时区或浏览器时区，请帮助我

这是否在全局范围内注册映射器（和模块）？

【参考方案6】：

使用 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/

【讨论】：

您能详细说明一下吗？这段代码去哪里了，ObjectMapper 实例是如何使用的？

您应该询问有关使用 Jackson 的 api 和 Maven 的具体问题。代码的去向取决于您是否使用任何框架/如何引导您的应用程序。

当我添加我得到编译错误“不兼容的类型：JodaModule 无法转换为模块” - 该方法需要一个 org.codehaus.jackson.map.Module 但 JodaModule 没有这个层次结构，那么这怎么可能？

很有希望，但目前几乎没用，因为我们无法指定要解析的日期格式:(

您需要禁用序列化作为时间戳 objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

【参考方案7】：

似乎对于 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);
    

该类使用 Joda DateTime 的 toString() 方法对数据进行序列化。

Rusty Kuntz 提出的方法非常适合我的情况。

【讨论】：

您仍然可以注册自定义序列化器和反序列化器，它们将优先于默认实现。

【参考方案8】：

https://***.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 可以使用您需要的任何格式。

【讨论】：

setDateFormat(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssz")); 帮了我大忙，谢谢

【参考方案9】：

在您正在映射的对象中：

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

【讨论】：

如何在spring mvc 3中注册CustomDateSerializer？

我不了解 Spring MVC3，但您可以向 Jackson 映射器对象添加自定义序列化程序。请参阅this entry in Jackson 您需要为该 SimpleModule 创建一个简单模块 isoDateTimeModule = new SimpleModule("ISODateTimeModule", new Version(1, 0, 0, null)); isoDateTimeModule.addSerializer(new JsonISODateTimeFormatSerializer()); mapper.registerModule(isoDateTimeModule);

@digz6666 在这里查看我对 Spring MVC 3 的回答：***.com/questions/7854030/…

注意 - 确保使用来自 org.codehaus.jackson 而不是 com.fasterxml.jackson.core 的上述类。使用第二个包对我不起作用。事实上，我的 Jersey 应用甚至不尊重 @JsonSerialized 注释。

答案对我有用。但它需要在所有字段上都有这个注释。是否有一些适用于杰克逊的全局配置？