百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

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

ztj100 2025-02-15 18:24 9 浏览 0 评论

1. 前言

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

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

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

2. 环境说明

js复制代码环境说明:Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

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

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

3.1 定义实体

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

kotlin复制代码/**
 * 系统日志实体
 *
 */
@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"。

less复制代码/**
 * 不分页查询所有日志
 */
@GetMapping("/get-logs")
@ApiOperation(value = "不分页查询所有日志", notes = "不分页查询所有日志")
public ResultResponse 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依赖引入

xml复制代码
 
    com.fasterxml.jackson.core 
    jackson-databind 
    2.9.1 

解释一下: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类,代码实现如下:

java复制代码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],接下来,我们重启下项目,使配置类生效,我们再次请求该接口,接口返回内容如下:

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

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

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

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


原文链接:
https://juejin.cn/post/7233297607043366968

相关推荐

如何将数据仓库迁移到阿里云 AnalyticDB for PostgreSQL

阿里云AnalyticDBforPostgreSQL(以下简称ADBPG,即原HybridDBforPostgreSQL)为基于PostgreSQL内核的MPP架构的实时数据仓库服务,可以...

Python数据分析:探索性分析

写在前面如果你忘记了前面的文章,可以看看加深印象:Python数据处理...

CSP-J/S冲奖第21天:插入排序

...

C++基础语法梳理:算法丨十大排序算法(二)

本期是C++基础语法分享的第十六节,今天给大家来梳理一下十大排序算法后五个!归并排序...

C 语言的标准库有哪些

C语言的标准库并不是一个单一的实体,而是由一系列头文件(headerfiles)组成的集合。每个头文件声明了一组相关的函数、宏、类型和常量。程序员通过在代码中使用#include<...

[深度学习] ncnn安装和调用基础教程

1介绍ncnn是腾讯开发的一个为手机端极致优化的高性能神经网络前向计算框架,无第三方依赖,跨平台,但是通常都需要protobuf和opencv。ncnn目前已在腾讯多款应用中使用,如QQ,Qzon...

用rust实现经典的冒泡排序和快速排序

1.假设待排序数组如下letmutarr=[5,3,8,4,2,7,1];...

ncnn+PPYOLOv2首次结合!全网最详细代码解读来了

编辑:好困LRS【新智元导读】今天给大家安利一个宝藏仓库miemiedetection,该仓库集合了PPYOLO、PPYOLOv2、PPYOLOE三个算法pytorch实现三合一,其中的PPYOL...

C++特性使用建议

1.引用参数使用引用替代指针且所有不变的引用参数必须加上const。在C语言中,如果函数需要修改变量的值,参数必须为指针,如...

Qt4/5升级到Qt6吐血经验总结V202308

00:直观总结增加了很多轮子,同时原有模块拆分的也更细致,估计为了方便拓展个管理。把一些过度封装的东西移除了(比如同样的功能有多个函数),保证了只有一个函数执行该功能。把一些Qt5中兼容Qt4的方法废...

到底什么是C++11新特性,请看下文

C++11是一个比较大的更新,引入了很多新特性,以下是对这些特性的详细解释,帮助您快速理解C++11的内容1.自动类型推导(auto和decltype)...

掌握C++11这些特性,代码简洁性、安全性和性能轻松跃升!

C++11(又称C++0x)是C++编程语言的一次重大更新,引入了许多新特性,显著提升了代码简洁性、安全性和性能。以下是主要特性的分类介绍及示例:一、核心语言特性1.自动类型推导(auto)编译器自...

经典算法——凸包算法

凸包算法(ConvexHull)一、概念与问题描述凸包是指在平面上给定一组点,找到包含这些点的最小面积或最小周长的凸多边形。这个多边形没有任何内凹部分,即从一个多边形内的任意一点画一条线到多边形边界...

一起学习c++11——c++11中的新增的容器

c++11新增的容器1:array当时的初衷是希望提供一个在栈上分配的,定长数组,而且可以使用stl中的模板算法。array的用法如下:#include<string>#includ...

C++ 编程中的一些最佳实践

1.遵循代码简洁原则尽量避免冗余代码,通过模块化设计、清晰的命名和良好的结构,让代码更易于阅读和维护...

取消回复欢迎 发表评论: