17370845950

新闻动态

处理JSON时间戳：将Epoch毫秒转换为java.time类型的策略

本文旨在探讨在Java应用中，如何将REST服务返回的Epoch毫秒时间戳有效反序列化为java.time包下的LocalDateTime或LocalDate类型。我们将介绍三种主要策略：通过构造函数手动解析、配置全局Jackson反序列化规则以及实现自定义反序列化器，以解决直接转换时遇到的类型不匹配和时区信息缺失问题。

在现代java应用中，处理日期和时间数据通常推荐使用java.time包（jsr 310）中的类型，如localdatetime、localdate和instant，它们提供了更强大、更清晰的api。然而，当从外部rest服务接收json数据时，时间戳常以epoch毫秒（自1970年1月1日00:00:00 utc以来的毫秒数）的形式表示。直接尝试将这种长整型时间戳反序列化为localdatetime或localdate时，jackson库会抛出错误，例如“raw timestamp (...) not allowed for java.time.localdatetime: need additional information such as an offset or time-zone”或“invalid value for epochday”。这是因为localdatetime不包含时区信息，而epoch毫秒是一个带有隐含时区（utc）的绝对时间点。localdate则更进一步，仅表示日期，直接从epoch毫秒转换需要精确的时区和日期计算。

本文将详细介绍几种解决此问题的有效策略。

1. 通过构造函数手动解析时间戳

一种直接的方法是在目标数据类的构造函数中手动处理时间戳的转换。这种方法允许对单个类进行精确控制，适用于不希望引入全局配置或自定义反序列化器的场景。

实现步骤：

在目标数据类中定义一个接收long类型时间戳的构造函数。
使用@JsonProperty注解将JSON中的时间戳字段映射到构造函数的long参数。
在构造函数内部，利用Instant.ofEpochMilli()将Epoch毫秒转换为Instant，然后通过atZone(ZoneOffset.UTC).toLocalDateTime()转换为LocalDateTime。

示例代码：

假设我们希望将JSON中的creation_date字段（Epoch毫秒）反序列化到MyLocalApplicationClass的LocalDateTime creationDate字段。

import com.fasterxml.jackson.annotation.JsonProperty;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneOffset;

public class MyLocalApplicationClass {
    private String name;
    private LocalDateTime creationDate;
    private String createdBy;

    // 无参构造函数（或其他构造函数），如果需要的话
    public MyLocalApplicationClass() {
    }

    // 带有@JsonProperty注解的全参数构造函数，用于Jackson反序列化
    public MyLocalApplicationClass(@JsonProperty("name") String name,
                                   @JsonProperty("creation_date") long creationDate,
                                   @JsonProperty("created_by") String createdBy) {
        this.name = name;
        this.createdBy = createdBy;
        // 将Epoch毫秒转换为LocalDateTime，假设时间戳是UTC时间
        this.creationDate = Instant
            .ofEpochMilli(creationDate)
            .atZone(ZoneOffset.UTC) // 明确指定时区，通常是UTC
            .toLocalDateTime();
    }

    // Getters and Setters (省略)
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public LocalDateTime getCreationDate() { return creationDate; }
    public void setCreationDate(LocalDateTime creationDate) { this.creationDate = creationDate; }
    public String getCreatedBy() { return createdBy; }
    public void setCreatedBy(String createdBy) { this.createdBy = createdBy; }
}

注意事项：

此方法要求在每个需要处理时间戳的类中编写类似的构造函数。
ZoneOffset.UTC的选择取决于你的时间戳实际代表的时区。如果时间戳是基于其他时区生成的，你需要相应调整。

2. 配置全局Jackson反序列化规则

对于Spring Boot应用，可以通过配置ObjectMapper实现全局的时间戳处理。这种方法更具侵入性，但一旦配置，所有符合条件的字段都会自动处理，减少了重复代码。

实现步骤：

引入jackson-datatype-jsr310模块： 确保你的项目中包含了Jackson对Java 8日期时间类型的支持模块。
```
    com.fasterxml.jackson.datatype
    jackson-datatype-jsr310
    2.x.x 
```
修改字段类型为Instant： 为了利用Jackson的内置功能，将目标数据类中的LocalDateTime字段类型更改为Instant。Instant是表示时间线上一个精确点的类型，与Epoch毫秒天然匹配。
配置ObjectMapper：
- 注册JavaTimeModule。
- 设置DeserializationFeature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS为false，指示Jackson将时间戳视为毫秒而不是纳秒。

示例代码：

首先，修改MyLocalApplicationClass，将creationDate的类型改为Instant：

import com.fasterxml.jackson.annotation.JsonProperty;
import java.time.Instant;

public class MyLocalApplicationClass {
    private String name;
    @JsonProperty("creation_date") // 如果JSON字段名与Java字段名不匹配，仍需此注解
    private Instant creationDate;
    @JsonProperty("created_by")
    private String createdBy;

    // Getters and Setters (省略)
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public Instant getCreationDate() { return creationDate; }
    public void setCreationDate(Instant creationDate) { this.creationDate = creationDate; }
    public String getCreatedBy() { return createdBy; }
    public void setCreatedBy(String createdBy) { this.createdBy = createdBy; }
}

然后，配置ObjectMapper。

方法一：通过配置类（适用于非Spring Boot或需要更细粒度控制的场景）

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

@Configuration
public class JsonConfig {

    @Bean
    public Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder() {
        return new Jackson2ObjectMapperBuilder();
    }

    @Bean
    public ObjectMapper objectMapper() {
        return jackson2ObjectMapperBuilder()
            .build()
            .registerModule(new JavaTimeModule()) // 注册JavaTime模块
            .configure(DeserializationFeature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS, false); // 将时间戳视为毫秒
    }
}

方法二：通过application.properties（Spring Boot推荐）

在Spring Boot应用中，JacksonAutoConfiguration会自动检测并注册JavaTimeModule。我们只需通过配置文件来设置DeserializationFeature。

# application.properties 或 application.yml
spring.jackson.deserialization.read-date-timestamps-as-nanoseconds=false

使用这种方式，你无需定义上述的JsonConfig类中的ObjectMapper和Jackson2ObjectMapperBuilder Bean。Spring Boot会自动为你配置。

注意事项：

使用Instant类型后，如果需要LocalDateTime，可以在获取Instant值后手动转换：myObject.getCreationDate().atZone(ZoneOffset.UTC).toLocalDateTime()。
此方法是全局性的，会影响所有Jackson对Instant类型的反序列化。

3. 创建自定义反序列化器

如果前两种方法不适用，例如你必须将时间戳反序列化为LocalDateTime而不是Instant，或者需要更复杂的转换逻辑，可以实现一个自定义的Jackson反序列化器。

实现步骤：

创建一个继承自StdDeserializer（或你目标类型）的类。
重写deserialize()方法，在该方法中手动解析JSON节点并执行转换逻辑。
使用@JsonDeserialize(using = YourDeserializer.class)注解将自定义反序列化器应用到目标字段上。

示例代码：

首先，定义自定义反序列化器：

import com.fasterxml.jackson.core.JacksonException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import java.io.IOException;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneOffset;

public class DateTimeDeserializer extends StdDeserializer {

    public DateTimeDeserializer() {
        super(LocalDateTime.class);
    }

    @Override
    public LocalDateTime deserialize(JsonParser p,
                                     DeserializationContext ctxt) throws IOException, JacksonException {
        JsonNode node = p.getCodec().readTree(p);
        long timestamp = node.longValue(); // 获取Epoch毫秒值

        return Instant
            .ofEpochMilli(timestamp)
            .atZone(ZoneOffset.UTC) // 同样，明确指定时区
            .toLocalDateTime();
    }
}

然后，在MyLocalApplicationClass中应用此反序列化器：

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.time.LocalDateTime;

public class MyLocalApplicationClass {

    private String name;

    @JsonDeserialize(using = DateTimeDeserializer.class) // 应用自定义反序列化器
    @JsonProperty("creation_date")
    private LocalDateTime creationDate;

    @JsonProperty("created_by")
    private String createdBy;

    // Getters and Setters (省略)
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public LocalDateTime getCreationDate() { return creationDate; }
    public void setCreationDate(LocalDateTime creationDate) { this.creationDate = creationDate; }
    public String getCreatedBy() { return createdBy; }
    public void setCreatedBy(String createdBy) { this.createdBy = createdBy; }
}

注意事项：

自定义反序列化器提供了最大的灵活性，可以处理任何复杂的转换逻辑。
它只作用于被@JsonDeserialize注解标记的特定字段，不会影响其他字段或类。
需要编写更多的代码来创建和维护反序列化器类。

总结

将REST响应中的Epoch毫秒时间戳反序列化为java.time类型是常见的需求。根据你的具体场景和偏好，可以选择以下策略：

构造函数解析： 适用于少量、特定类的局部控制，代码相对直观，但可能导致重复。
全局配置（使用Instant）： 对于Spring Boot应用，这是最推荐和简洁的方式。它利用了Jackson的强大功能，通过配置将Epoch毫秒直接映射到Instant类型，减少了样板代码。之后可以根据需要将Instant转换为LocalDateTime或LocalDate。
自定义反序列化器： 提供最大的灵活性和精确控制，适用于需要将Epoch毫秒直接映射到LocalDateTime或LocalDate，或存在复杂转换逻辑的场景。

无论选择哪种方法，关键在于理解java.time类型与Epoch毫秒之间的转换关系，特别是时区（ZoneOffset.UTC是常用选择）在转换过程中的作用，以确保日期时间数据的准确性。

17370845950

1. 通过构造函数手动解析时间戳

2. 配置全局Jackson反序列化规则

3. 创建自定义反序列化器

总结

关于我们

服务项目

广告推广

案例欣赏