1.问题的出现
在未使用
LocalDateTime 以前,项目中的实体类都是用 Timestamp 对应的。可以在springboot的主配置文件中,统一进行格式化设置
# 返回时间戳
spring.jackson.serialization.write-dates-as-timestamps=true
使用@responseBody
返回json数据时,会自动将时间格式化为毫秒值。
但当使用了LocalDateTime后,这种做法就失效了,时间数据会被转成一个类似于[2019,2,22,15,24,55]
的数组,而并非毫秒值。引用自jackson-modules-java8
LocalDate
,LocalTime
,LocalDateTime
, andOffsetTime
, which cannot portably be converted to timestamps and are instead represented as arrays whenWRITE_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());
DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
gen.writeString(df.format(value));
}
}
- 在实体类时间属性上,加入
@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了。
局部配置(兼容其他的类型,避免全局配置导致的新问题),配置一个Jon反序列化配置 StringToLocalDateTime
/**
* @Description: yyyy-MM-dd HH:mm:ss.SSS 字符串时间转 localDateTime
* @author: LinQin
* @date: 2020/05/27
*/
public class StringToLocalDateTime extends JsonDeserializer<LocalDateTime> {
@Override
public LocalDateTime deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
String date = jsonParser.getText();
DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");
LocalDateTime parse = LocalDateTime.parse(date, df);
return parse;
}
}
在实体类时间属性上,加入@JsonDeserialize(using = StringToLocalDateTime.class)
注解即可
jackson的全局配置解决
新建类JacksonConfig
@Configuration
public class JacksonConfig {
@Bean
public ObjectMapper objectMapper() {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
//objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
//关闭日期序列化为时间戳的功能
//objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
//关闭序列化的时候没有为属性找到getter方法,报错
objectMapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
//关闭反序列化的时候,没有找到属性的setter报错
objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
//序列化的时候序列对象的所有属性
objectMapper.setSerializationInclusion(JsonInclude.Include.ALWAYS);
//反序列化的时候如果多了其他属性,不抛出异常
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
//如果是空对象的时候,不抛异常
objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
SimpleModule simpleModule = new SimpleModule();
//json值反序列化
//json键序列化
simpleModule.addSerializer(LocalDateTime.class, LocalDateTimeToLongSerializer.INSTANCE);
simpleModule.addSerializer(Instant.class, InstantToStringSerializer.INSTANCE);
simpleModule.addDeserializer(Instant.class, StringToInstantSerializer.INSTANCE);
objectMapper.registerModule(simpleModule);
return objectMapper;
}
public static class LocalDateTimeToLongSerializer extends JsonSerializer<LocalDateTime> {
private static final LocalDateTimeToLongSerializer INSTANCE = new LocalDateTimeToLongSerializer();
@Override
public void serialize(LocalDateTime localDateTime, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
Instant instant = localDateTime.atZone(ZoneId.systemDefault()).toInstant();
long ts = instant.getEpochSecond();
jsonGenerator.writeNumber(ts);
}
}
public static class InstantToStringSerializer extends JsonSerializer<Instant> {
private static final InstantToStringSerializer INSTANCE = new InstantToStringSerializer();
@Override
public void serialize(Instant instant, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
if (instant == null) {
return;
}
DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");
String jsonValue = df.format(instant.atZone(ZoneId.systemDefault()));
//gen.writeNumber(value.toInstant(ZoneOffset.of("+8")).toEpochMilli());
jsonGenerator.writeString(jsonValue);
}
}
public static class StringToInstantSerializer extends JsonDeserializer<Instant> {
private static final StringToInstantSerializer INSTANCE = new StringToInstantSerializer();
@Override
public Instant deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
String date = jsonParser.getText();
if (StringUtils.isNotBlank(date)) {
DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
//将 string 装换成带有 T 的国际时间,但是没有进行,时区的转换,即没有将时间转为国际时间,只是格式转为国际时间
LocalDateTime parse = LocalDateTime.parse(date, dateTimeFormatter);
//+8 小时,offset 可以理解为时间偏移量
ZoneOffset offset = OffsetDateTime.now().getOffset();
//转换为 通过时间偏移量将 string -8小时 变为 国际时间,因为亚洲上海是8时区
Instant instant = parse.toInstant(offset);
return instant;
}
return null;
}
}
}