Jackson在springboot中LocalDateTime格式问题

最新推荐文章于 2024-07-30 21:41:18 发布

OkidoGreen

最新推荐文章于 2024-07-30 21:41:18 发布

阅读量5.2k

点赞数 1

分类专栏： SpringBoot-实战 Json转换-Jackson

原文链接：https://www.jianshu.com/p/aad7973a0bf7

版权

SpringBoot-实战同时被 2 个专栏收录

90 篇文章 4 订阅

订阅专栏

Json转换-Jackson

34 篇文章 4 订阅

订阅专栏

Jackson在springboot中LocalDateTime的格式化

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

@Configuration
public class MvcConfig {
    /**
     * 更改jackson默认配置
     */
    @Bean
    public ObjectMapper ObjectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        // 日期和时间格式化
        JavaTimeModule javaTimeModule = new JavaTimeModule();
        javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        javaTimeModule.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern("HH:mm:ss")));
        javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        javaTimeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern("HH:mm:ss")));
        objectMapper.registerModule(javaTimeModule);
        return objectMapper;
    }

}

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

最近使用了JDK8中新的时间API LocalDateTime，这里记录一下与springboot集成时出现的一些需要注意的细节

1.问题的出现

在未使用LocalDateTime以前，项目中的实体类都是用Timestamp对应的。可以在springboot的主配置文件中，统一进行格式化设置

# 返回时间戳
spring.jackson.serialization.write-dates-as-timestamps=true

使用 @responseBody 返回json数据时，会自动将时间格式化为毫秒值。

但当使用了LocalDateTime后，这种做法就失效了，时间数据会被转成一个类似于 [2019,2,22,15,24,55] 的数组，而并非毫秒值。引用自 jackson-modules-java8 7

LocalDate , LocalTime , LocalDateTime , and OffsetTime , which cannot portably be converted to timestamps and are instead represented as arrays when WRITE_DATES_AS_TIMESTAMPS is enabled.

2.解决方案

自定义 JsonSerialize

/**
 * json序列化，将LocateDateTime转换为时间戳
 *
 * @author zhangxu
 */
public class LocalDateTimeConverter extends JsonSerializer<LocalDateTime> {

    @Override
    public void serialize(LocalDateTime value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeNumber(value.toInstant(ZoneOffset.of("+8")).toEpochMilli());
    }
}

在实体类时间属性上，加入 @JsonSerialize(using = LocalDateTimeConverter.class) 注解即可

3.其他问题

服务器返回时间戳的问题解决了，但还会有另一个问题，就是时间戳的接收问题。当接口使用实体类接收数据时，无法解析客户端传过来的时间戳，会报类型转换错误的bug。

这就需要自定义 Converter 解决问题。

/**
 * spring接收参数格式转化 long --> LocalDateTime
 *
 * @author zhangxu
 */
@Configuration
public class DateConfig implements Converter<String, LocalDateTime> {

    @Override
    public LocalDateTime convert(String source) {
        ZoneOffset zoneOffset = ZoneOffset.of("+8");
        return LocalDateTime.ofInstant(Instant.ofEpochMilli(Long.parseLong(source)), zoneOffset);
    }
}

再次启动项目，就可以自动将时间戳转换为 LocalDateTime了。