Springboot中LocalDateTime对象返回给前端格式化解决方案

 更新时间:2024年04月24日 11:47:17   作者:奔跑卤蛋  
在项目开发当中前后端使用什么样的时间格式,是一个值得关注的问题,这篇文章主要给大家介绍了关于Springboot中LocalDateTime对象返回给前端格式化的解决方案,文中通过代码介绍的非常详细,需要的朋友可以参考下

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
@Slf4j
public 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);
    }
}

简单分析: 先反序列化,再序列化

优势: 一次配置,重复使用,不需要每个实体类的时间属性上加注解了

3.2.3 效果

和使用注解是一样的

总结

到此这篇关于Springboot中LocalDateTime对象返回给前端格式化解决方案的文章就介绍到这了,更多相关LocalDateTime对象返回前端格式化内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java 冒泡排序、快速排序实例代码

    Java 冒泡排序、快速排序实例代码

    这篇文章主要介绍了Java 冒泡排序、快速排序实例代码,需要的朋友可以参考下
    2017-05-05
  • java判断中文字符串长度的简单实例

    java判断中文字符串长度的简单实例

    下面小编就为大家带来一篇java判断中文字符串长度的简单实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01
  • Maven与Gradle的区别对比分析

    Maven与Gradle的区别对比分析

    这篇文章给大家给大家介绍了Maven与Gradle的区别对比分析,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2026-05-05
  • Java可变参数列表详解

    Java可变参数列表详解

    这篇文章主要介绍了Java可变参数列表详解的相关资料,需要的朋友可以参考下
    2017-05-05
  • 一起来了解Java的File类和IO流

    一起来了解Java的File类和IO流

    这篇文章主要为大家详细介绍了Java File类和IO流,在Java学习中,file类与io流是非常重要的部分,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java资源加载机制及使用最佳实践

    Java资源加载机制及使用最佳实践

    Java类加载器的资源加载机制,包括`getResource`、`getResources`、`findResource`、`findResources`等方法,本文给大家介绍Java资源加载机制及使用最佳实践,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • Springboot @Configuration与自动配置详解

    Springboot @Configuration与自动配置详解

    这篇文章主要介绍了SpringBoot中的@Configuration自动配置,在进行项目编写前,我们还需要知道一个东西,就是SpringBoot对我们的SpringMVC还做了哪些配置,包括如何扩展,如何定制,只有把这些都搞清楚了,我们在之后使用才会更加得心应手
    2022-07-07
  • 非常详细的Java异常处理机制知识整理大全

    非常详细的Java异常处理机制知识整理大全

    Java异常指在程序运行时可能出现的一些错误,比如试图打开一个根本不存在的文件等,异常处理将会改变程序的控制流程,让程序有机会对错误做出处理,下面这篇文章主要给大家介绍了关于Java异常处理机制知识整理的相关资料,需要的朋友可以参考下
    2022-11-11
  • Java中spring boot validation自定义注解使用方式

    Java中spring boot validation自定义注解使用方式

    这篇文章主要介绍了Java中spring boot validation自定义注解使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Java深入分析Iterator迭代器与foreach循环的使用

    Java深入分析Iterator迭代器与foreach循环的使用

    这篇文章主要介绍了Java-Iterator迭代器与foreach循环,主要包括Iterator迭代器接口的操作方法和foreach 循环语法解析,需要的朋友可以参考下
    2022-05-05

最新评论