SpringBoot如何通过Jackson配置全局时间日期格式,这你会吗?

2,065 阅读13分钟

👨‍🎓作者:bug菌
✏️博客:CSDN掘金infoQ51CTO
🎉简介:CSDN|阿里云|华为云|51CTO等社区博客专家,历届博客之星Top30,掘金年度人气作者Top40,51CTO年度博主Top12,掘金 | InfoQ | 51CTO等社区优质创作者,全网粉丝合计15w+  ;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。

...

✍️温馨提醒:本文字数:1999字, 阅读完需:约 5 分钟

🏆本文收录于《Spring Boot从入门到精通》,专门攻坚指数提升。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。

小伙伴们在批阅文章的过程中如果觉得文章对您有一丝丝帮助,还请别吝啬您手里的赞呀,大胆的把文章点亮👍吧,您的点赞三连(收藏⭐+关注👨‍🎓+留言📃)就是对bug菌我创作道路上最好的鼓励与支持😘。时光不弃🏃🏻‍♀️,创作不停💕,加油☘️

 1. 前言

        不知道小伙伴对于日期字段,在项目中都是如何处理的,是单独给每个字段都自定义日期格式还是做全局格式设置?这个我之前啊,是对日期都是有做单独配置,给每个Entity带有日期字段的都配@JsonFormat注解,具体配置如下:

//把属性的格式序列化时转换成指定的格式.
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")

        这不就代码冗余了嘛;既然每个都要设置一遍,那何不如想一个能一劳永逸的方法,将全局的日期格式都统一化,自己也用不着挨个挨个去配置了,你们觉得呢?

2. 环境说明

环境说明:Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

3. 默认时间格式展示演示

接下来,我先为大家演示一下,写个接口查询log日志列表来演示一下默认的Date类型的字段内容输出是何种样子?我们一起拭目以待。

3.1 定义实体

先定义一个日志实体,演示代码如下:

/**
 * 系统日志实体
 *
 */
@Data
@TableName("log_info")
@ApiModel(value = "系统日志实体", description = "系统日志实体")
public class LogInfo {
   private static final long serialVersionUID = 1L;

   @ApiModelProperty(value = "主键id自增列")
   @TableId(value = "id", type = IdType.AUTO)
   private int id;

   @ApiModelProperty(value = "操作类型")
   @TableField(value = "log_type")
   private String logType;

   @ApiModelProperty(value = "接口返回状态码")
   @TableField(value = "response_code")
   private int responseCode;

   @ApiModelProperty(value = "请求时间")
   @TableField(value = "operate_time")
   private Date operateTime;

   @ApiModelProperty(value = "消耗时间")
   @TableField(value = "spend_time")
   private Long spendTime;

   @ApiModelProperty(value = "url")
   @TableField(value = "url")
   private String url;

   @ApiModelProperty(value = "请求体")
   @TableField(value = "body")
   private String body;

   @ApiModelProperty(value = "ip")
   @TableField(value = "ip")
   private String ip;

   @ApiModelProperty(value = "查询参数")
   @TableField(value = "query")
   private String query;

   @ApiModelProperty(value = "异常信息")
   @TableField(value = "exception")
   private String exception;
}

3.2 定义Controller

定义一个接口,请求路径为:"/get-logs"。

/**
 * 不分页查询所有日志
 */
@GetMapping("/get-logs")
@ApiOperation(value = "不分页查询所有日志", notes = "不分页查询所有日志")
public ResultResponse<List> getLogList() {
    return new ResultResponse<>(logInfoService.list());
}

        接着,我们通过swagger直接请求一下,可以发现operateTime字段本是Date类型,所以不难看出,当你未处理该字段时,默认展示是Date字符串时间格式,即UTC格式。很不习惯也不方便页面展示,所以,我们必须对该日期格式进行处理,转成比如“yyyy-MM-dd”或者“yyyy-MM-dd HH:mm:ss”等常规时间格式,这样看着肯定舒服多了,也是页面能接受的日期展示格式。

所以接下来,我就带着大家如何来配置这个全局日期时间格式问题。

4. 配置 Jackson

        在上方提到,如何一劳永逸,这不,我教你们,用到了Jackson,一个java的开源框架,一个超级好用的JSON解析类库,包括上方提到的“@JsonFormat”,也是来自于它,至于Jackson的详细用法,我将在下期重点介绍,此文主要带大家如何配置全局日期格式。

4.1 jackson依赖引入

<!--jackson依赖-->
<dependency> 
    <groupId>com.fasterxml.jackson.core</groupId> 
    <artifactId>jackson-databind</artifactId> 
    <version>2.9.1</version> 
</dependency>

        解释一下:jackson-databind 依赖 jackson-core 和 jackson-annotations这两,当添加 jackson-databind 依赖之后, jackson-core 和 jackson-annotations 也会一并被引入;在添加相关依赖包之后,你就能使用 Jackson了。

注意:如果你是springboot项目,有引入spring-boot-starter-web这个starter,自然就引入了jackson包,所以大家不要重复导包啦,特此提醒!!

        然后,再给大家解读下,Jackson依赖被添加后,刷新maven,可以看到jackson-core 和 jackson-annotations这两都被引入进来了。具体请看如下截图:

4.2 Jackson配置

        对于ObjectMapper类作为Jackson类的主类,我们要实现的日期格式设置也是基于它来实现的,大家请看,我们要用到这个方法setDateFormat()。

配置JacksonConfig类,代码实现如下:

package com.example.demo.config;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.text.SimpleDateFormat;

@Configuration
public class JacksonConfig {

    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        // 自定义日期转换格式
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return objectMapper;
    }
}

4.3 测试

        我们直接在JacksonConfig类中将日期格式转成[yyyy-MM-dd HH:mm:ss],接下来,我们重启下项目,使配置类生效,我们再次请求该接口,接口返回内容如下:

        可以看到,日期格式将顺利写成了我们所指定的日期格式,或许有的小伙伴可能不太笃定,凑巧嘛,可以,那我们另设置一个日期格式,具体如下修改:

//自定义时间格式
objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));

转存失败,建议直接上传图片文件

        之后我们再重启项目重新请求接口,大家请看。日期格式也是按指定格式输出。

        毫无疑问,如此设置,确实是可以针对全局是Date类型的字段进行统一日期格式转化,使用起来非常的方便,Jackson真的超级好用,推荐给大家。

... ...

    ok,以上就是我这期的全部内容啦,如果还想学习更多,你可以看看如下的往期热文推荐哦,每天积累一个奇淫小知识,日积月累下去,你一定能成为令人敬仰的大佬。

「赠人玫瑰,手留余香」,咱们下期拜拜~~

5. 热文推荐💭

为了便于同学快速定位文章学习,熬夜几天终于整理出了【基础篇】【进阶篇】专栏的文章及有效地址,同学们敬请吩咐bug菌吧。

目前基础篇已完结75篇+,进阶篇已完结45篇+,两专栏都在持续更新中;生命不息,更新不止,加油卷起来吧,同学们。部分文章总结如下:

5.1 Spring Boot【基础篇】

导读:SpringBoot 学习指南(附思维导图)

Spring Boot入门(01):Spring Boot的奋斗成长史

Spring Boot入门(02):快速开发环境搭建和项目启动

Spring Boot入门(03): yaml、properties配置文件介绍及使用

Spring Boot入门(04):多环境切换,实例演示

Spring Boot入门(05):starter基础入门

Spring Boot入门(06):Spring Boot常用注解大全

Spring Boot入门(07):整合 MySQL 和 Druid数据源(两万字教学)

Spring Boot入门(08):整合Mybatis访问MySQL实现增删改查

Spring Boot入门(09):使用MyBatis的XML配置方式访问MySQL实现增删改查

Spring Boot入门(10): mybatis之xml映射文件>、<=等特殊符号写法

Spring Boot入门(11):Spring Boot 整合 JPA

Spring Boot入门(12):整合Mybatis-Plus mybatis-plus实现接口增删改查

Spring Boot入门(13): Mybatis-Plus之条件构造器使用手册

Spring Boot入门(14): mybatis-plus之如何自定义sql

Spring Boot入门(15):Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码

Spring Boot入门(16):Spring Boot整合Swagger-UI实现在线API文档

Spring Boot入门(17):Spring Boot整合Knife4j,美化强化丑陋的Swagger

Spring Boot入门(18):Spring Boot静态资源映射

Spring Boot入门(19):Spring Boot 整合 Thymeleaf 模板引擎,开发Web页面

Spring Boot入门(20):实现多数据源配置,开箱即用

Spring Boot入门(21):整合Log4j2以及配置详解

Spring Boot入门(22):整合LogBack 实现日志文件本地保存

Spring Boot入门(23):Spring Boot基于AOP拦截日志

Spring Boot入门(24):Spring Boot事务

Spring Boot入门(25):过滤器、拦截器、监听器对比及使用场景

Spring Boot入门(26):实现邮件发送简单邮件、附件邮件、嵌入资源(图片)邮件、模板邮件等

Spring Boot入门(27):war包部

Spring Boot入门(28):jar包部署

Spring Boot入门(29):如何实现热部署

Spring Boot入门(30):Windows安装Redis客户端?你玩过么

5.2 Spring Boot【进阶篇】

Spring Boot进阶(01):Spring Boot 集成 Redis,实现缓存自由

Spring Boot进阶(02):使用Validation进行参数校验

Spring Boot进阶(03):如何使用MyBatis-Plus实现字段的自动填充

Spring Boot进阶(04):如何使用MyBatis-Plus快速实现自定义sql分页

Spring Boot进阶(05):Spring Boot 整合RabbitMq,实现消息队列服务

Spring Boot进阶(06):Windows10系统搭建 RabbitMq Server 服务端

Spring Boot进阶(07):集成EasyPoi,实现Excel/Word的导入导出

Spring Boot进阶(08):集成EasyPoi,实现Excel/Word携带图片导出

Spring Boot进阶(09):集成EasyPoi,实现Excel文件多sheet导入导出

Spring Boot进阶(10):集成EasyPoi,实现Excel模板导出成PDF文件

Spring Boot进阶(11):Spring Boot 如何实现纯文本转成.csv格式文件?

Spring Boot进阶(12):Spring Boot 如何获取Excel sheet页的数量?

Spring Boot进阶(13):Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值?

Spring Boot进阶(14):Spring Boot 如何手动连接库并获取指定表结构?一文教会你

Spring Boot进阶(15):根据数据库连接信息指定分页查询表结构信息

Spring Boot进阶(16):Spring Boot 如何通过Redis实现手机号验证码功能?

Spring Boot进阶(17):Spring Boot如何在swagger2中配置header请求头等参数信息

Spring Boot进阶(18):SpringBoot如何使用@Scheduled创建定时任务?

Spring Boot进阶(19):Spring Boot 整合ElasticSearch

Spring Boot进阶(20):配置Jetty容器

Spring Boot进阶(21):配置Undertow容器

Spring Boot进阶(22):Tomcat与Undertow容器性能对比分析

Spring Boot进阶(23):实现文件上传

Spring Boot进阶(24):如何快速实现多文件上传?

Spring Boot进阶(25):文件上传的单元测试怎么写?

Spring Boot进阶(26):Mybatis 中 resultType、resultMap详解及实战教学

Spring Boot进阶(27):Spring Boot 整合 kafka(环境搭建+演示)

Spring Boot进阶(28):Jar包Linux后台启动部署及滚动日志查看,日志输出至实体文件保存

Spring Boot进阶(29):如何正确使用@PathVariable,@RequestParam、@RequestBody等注解?不会我教你,结合Postman演示

Spring Boot进阶(30):@RestController和@Controller 注解使用区别,实战演示

...

若想学习更多,可以参考这篇专栏总结《2023最新首发,全网最全 Spring Boot 学习宝典(附思维导图)》本专栏致力打造最硬核 Spring Boot 进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中。欢迎大家订阅持续学习。

在入门及进阶之途,我必助你一臂之力,系统性学习,从入门到精通,带你不走弯路,直奔终点;投资自己,永远性价比最高,都这么说了,你还不赶紧来学??

6. 文末💭

       我是bug菌,CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家,历届博客之星Top30,掘金年度人气作者Top40,51CTO年度博主Top12,掘金 | InfoQ | 51CTO等社区优质创作者,全网粉丝合计15w+ ;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。