SpringBoot中对于LocalDate和LocalDateTime如何返回时间戳

问题

Springboot从2.0开始，最低的jdk支持版本是1.8， 1.8里面，对于时间的处理，引入了LocalDate和LocalDateTime等类型，对于这种类型的数据，返回给前端，默认是字符串类型。但是在公司里面，前后端约定，时间类型的数据，统一返回时间戳的数据格式给前端，前端根据样式来展示时间格式。

Date类型

对于Date类型的数据，在SpringBoot 2.x的版本中，只需要在配置文件中加入下面的配置

spring:
  jackson:
    serialization:
      WRITE_DATES_AS_TIMESTAMPS: true

那么返回的Date类型的数据，就会变成时间戳，通过这样的配置，可以比较简单的满足前端的需求。

LocalDate和LocalDateTime

如果同一个项目中，有的接口返回Date类型，有的接口又返回LocalDate或者LocalDateTime类型，则 SpringBoot 不会返回时间戳类型。

而是返回

{
  "code": 0,
  "msg": "success",
  "traceId": "defbea4801b1e570",
  "data": {
    "date": 1604387042235,
    "localDate": [
      2020,
      11,
      3
    ],
    "localDateTime": [
      2020,
      11,
      3,
      15,
      4,
      2,
      235207000
    ]
  }
}

那么如何才能同时对于三种不同的时间格式的数据，都统一返回时间戳类型呢？

我们采取的方案是，重新修改默认的ObjectMapper对象，添加一个自定义类型的DateBeanSerializerModifier

通过DateBeanSerializerModifier来对于LocalDate和LocalDateTime的类型进行自定义的序列化方法

 public static class DateBeanSerializerModifier extends BeanSerializerModifier {
    @Override
    public List<BeanPropertyWriter> changeProperties(SerializationConfig config,
        BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {
      for (Object beanProperty : beanProperties) {
        BeanPropertyWriter writer = (BeanPropertyWriter) beanProperty;
        if (isLocalDateType(writer)) {
          writer.assignSerializer(new LocalDateConverter() );
        } else if (isLocalDateTimeType(writer)) {
          writer.assignSerializer(new LocalDateTimeConverter());
        }
      }
      return beanProperties;
    }

 private boolean isLocalDateType(BeanPropertyWriter writer) {
      Class<?> clazz = writer.getType().getRawClass();
      return LocalDate.class.isAssignableFrom(clazz);
    }

    private boolean isLocalDateTimeType(BeanPropertyWriter writer) {
      Class<?> clazz = writer.getType().getRawClass();
      return LocalDateTime.class.isAssignableFrom(clazz) ;
    }

public static class LocalDateConverter extends JsonSerializer<Object> {

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

  public static class LocalDateTimeConverter extends JsonSerializer<Object> {

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

并且把DateBeanSerializerModifier注册到ObjectMapper的序列化工厂`

    objectMapper.setSerializerFactory(
        objectMapper.getSerializerFactory()
            .withSerializerModifier(new DateBeanSerializerModifier()));
  }

然后返回的数据不管是Date还是LocalDate还是LocalDateTime就是统一的时间戳格式了

{
  "code": 0,
  "msg": "success",
  "traceId": "212feeaf35a2b2f9",
  "data": {
    "date": 1604387760925,
    "localDate": 1604332800000,
    "localDateTime": 1604387760925
  }
}

这样就又可以和前端愉快的玩耍了。

结束

转载请注明作者和出处，并添加本页链接。
原文链接: //tech.cnhnb.com/post/9

最后编辑于：2020.11.03 15:20:33