SpringBoot使用Jackson配置全局时间日期格式
作者：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真的超级好用，推荐给大家。
到此这篇关于SpringBoot使用Jackson配置全局时间日期格式的文章就介绍到这了,更多相关SpringBoot 全局时间日期格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！