SpringBoot中LocalDatetime作为参数和返回值的序列化问题
👆关注微信公众号，获取更多编程内容
欢迎访问我的个人网站 https://www.zhoutao123.com
LocalDatetime、LocalDate以及LocalTime，是JDK8 新增的和时间相关的类。在SpringBoot的创建接口的时候，可能需要将Local的相关时间类作为参数，但是有时候需要特输的时间格式，由于SpringBoot默认使用Jackson作为序列化的框架，所以在配置LocalDatetime这类新的API的时候，默认的参数就非常得让人不爽。经过一段折腾，笔者找到合适的解决方法，这里提供了一个简单地方法，将相应的时间转换为ISO8601的时间格式，保存了时区信息，同时接受参数也可以包含时区信息，或者自定义为前端需要的格式。
Ps: 当然可以使用@JsonFormat等注解标识，但是能统一处理为什么还要单独一个一个加那么麻烦呢？
主要的点就是：
笔者建议，在项目中创建一个名为 LocalDatetimConfig.java的类用户集中配置.
依赖
- Grale
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.9.8'
- Maven
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.datatype/jackson-datatype-jsr310 -->
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.8</version>
</dependency>
代码如下
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import java.io.IOException;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import org.jetbrains.annotations.NotNull;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.util.StringUtils;
/** Converter 不可优化使用Lambda表达式，否则会出现启动失败的问题 */
@Configuration
public class LocalDateTimeSerializerConfig {
/** String --> LocalDate */
@Bean
public Converter<String, LocalDate> localDateConverter() {
return new Converter<String, LocalDate>() {
@Override
public LocalDate convert(@NotNull String source) {
if (StringUtils.hasText(source)) {
return LocalDate.parse(source, DateTimeFormatter.ISO_OFFSET_DATE);
}
return null;
}
};
}
/** String --> LocalDatetime */
@Bean
public Converter<String, LocalDateTime> localDateTimeConverter() {
return new Converter<String, LocalDateTime>() {
@Override
public LocalDateTime convert(@NotNull String source) {
if (StringUtils.hasText(source)) {
return LocalDateTime.parse(source, DateTimeFormatter.ISO_OFFSET_DATE_TIME);
}
return null;
}
};
}
/** String --> LocalTime */
@Bean
public Converter<String, LocalTime> localTimeConverter() {
return new Converter<String, LocalTime>() {
@Override
public LocalTime convert(@NotNull String source) {
if (StringUtils.hasText(source)) {
return LocalTime.parse(source, DateTimeFormatter.ISO_OFFSET_TIME);
}
return null;
}
};
}
/** Json序列化和反序列化转换器，用于转换Post请求体中的json以及将我们的对象序列化为返回响应的json */
@Bean
public ObjectMapper objectMapper() {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);
// LocalDateTime系列序列化模块，继承自jsr310，我们在这里修改了日期格式
JavaTimeModule javaTimeModule = new JavaTimeModule();
javaTimeModule.addSerializer(
LocalDateTime.class,
new JsonSerializer<LocalDateTime>() {
@Override
public void serialize(
LocalDateTime value, JsonGenerator gen, SerializerProvider serializers)
throws IOException {
String format =
value.atZone(ZoneOffset.UTC).format(DateTimeFormatter.ISO_OFFSET_DATE_TIME);
gen.writeString(format);
}
});
javaTimeModule.addSerializer(
LocalDate.class,
new JsonSerializer<LocalDate>() {
@Override
public void serialize(LocalDate value, JsonGenerator gen, SerializerProvider serializers)
throws IOException {
String format = value.format(DateTimeFormatter.ISO_OFFSET_DATE);
gen.writeString(format);
}
});
objectMapper.registerModule(javaTimeModule);
return objectMapper;
}
}
代码很简单, 这里不再赘述，稍微看下就明白了了，需要注意的是：
