Springboot中LocalDateTime对象返回给前端，格式化

2024-06-24 前端 0

1.需求

后端日期时间对象，是LocalDateTime类型，直接返回前端，是数组形式
在这里插入图片描述
希望以正常的日期时间字符串格式返回

2.思路

1.@JsonFormat注解
2.消息转化器

3.解决方案

3.1 使用注解（不推荐）

在实体类的LocalDateTime属性上面，添加注解

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private LocalDateTime createTime;@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private LocalDateTime updateTime;

缺点： 每个日期时间属性都要添加，麻烦

3.2 扩展SpringMVC框架的消息转化器，实现返回日期时间的格式化（推荐）

3.2.1 配置类: config.WebMvcConfiguration

该config已实现了登录拦截器，和knife4j生成接口文档、静态资源映射(已从代码中删除)，
现添加时间按格式转换功能extendMessageConverters

/** * 配置类，注册web层相关组件 */@Configuration@Slf4jpublic class WebMvcConfiguration extends WebMvcConfigurationSupport {    //扩展SpringMVC框架的消息转化器，例如实现返回日期时间的格式化    @Override    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {        log.info("扩展消息转换器");        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();        //将java对象序列化为json数据,为消息转换器设置序列转换器        converter.setObjectMapper(new JacksonObjectMapper());        //将自己的消息转换器加入容器中        converters.add(0, converter);    }}

思路：参数获取到当前的消息转换器列表converters，将我们自定义的消息转化器convert添加到converters中，而且要添加到首位，让它优先生效

3.2.2 JacksonObjectMapper类的定义

显然是个工具类，位于sky-common模块的json.JacksonObjectMapper

import com.fasterxml.jackson.databind.DeserializationFeature;import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.databind.module.SimpleModule;import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;import java.time.LocalDate;import java.time.LocalDateTime;import java.time.LocalTime;import java.time.format.DateTimeFormatter;import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;/** * 对象映射器:基于jackson将Java对象转为json，或者将json转为Java对象 * 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象] * 从Java对象生成JSON的过程称为 [序列化Java对象到JSON] */public class JacksonObjectMapper extends ObjectMapper {    public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";    public static final String DATE_TIME_FORMAT_NO_SECOND = "yyyy-MM-dd HH:mm";    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";    public JacksonObjectMapper() {        super();        //收到未知属性时不报异常        this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);        //反序列化时，属性不存在的兼容处理        this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);        SimpleModule simpleModule = new SimpleModule()                .addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))                .addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))                .addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))                .addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))                .addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))                .addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));        //注册功能模块 例如，可以添加自定义序列化器和反序列化器        this.registerModule(simpleModule);    }}