使用@JsonFormat转换时间类型为指定时间格式的字符串

背景

在我们的数据库使用datatime等类型时,实体类需要使用Date或者LocalDateTime等相对应(当然也可以使用String,不过格式不受控制,而且有时候我们其他功能需要使用Date等类型,所以不推荐使用String),我们希望给调用者以我们希望的时间格式传递json,而不是默认的格式。
通常我们可能会使用for循环,遍历每一个元素进行转换,如下

List<User> users = xxx;
SimpleDateFormat fomatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
for (User user : users) {
	user.setLastLoginTimeStr(formatter.format(user.getLastLoginTime));
}

这种写法的确可以实现我们的功能,但是比较繁琐,不优雅,并且还需要新增其他辅助字段,所以我们并不希望使用这种写法

使用@JsonFormat

使用一个组件或是jar时,就需要引入相应的依赖
如果是使用SpringBoot,在引用webstarter时,会自动引入com.fasterxml.jackson.core相关包,其中有一个@JsonFormat注解,我们可以使用它来帮助我们实现我们的功能

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonFormat {
	...
    String pattern() default "";
    String timezone() default "##default";
    ...
}

我们主要关系以上两个属性

  • pattern:格式化表达式
  • timezone:时区

数据库

我们创建一张表,名字以及字段无所谓,但需要包含两个datetime类型的字段来进行测试
在这里插入图片描述

编写实体类

我们使用一个Date以及一个LocalDateTime分别对应数据库相应的列,然后标注@JsonFormat注解,两个注解分别用不同的pattern来起到测试的目的

public User {
	...
	// 表示查询时不查询此字段
	@JsonFormat(pattern = "yyyyMMdd'T'HHmmss'Z'")
	private Date createTime;
	
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
	private LocalDateTime updateTime;
	...
}

进行测试

接下来我们需要查询实体,直接把实体返回查看json

@RestController
@AllArgsConstructor
public class TestController {
    private IUserService userService;

    @GetMapping("test/user")
    public List<User> test() {
        return userService.list();
    }
}

启动项目,访问路径,看下结果
在这里插入图片描述
我们看到,两个日期确实按照我们的指定的格式进行了转换,证明@JsonFormat以及pattern有效,可以达到我们的目的。
但是事情还没有结束,我们对比一下数据库
在这里插入图片描述
可以看出LocalDateTime类型的updateTime字段和数据库的值一致,但是Date类型的createTime却比数据库少了8个小时。一想差8小时,我们就应该明白这就是时区问题。Date类型把时间变为了世界时GMT,而北京时间为GMT+8
增加JsonFormattimezone属性,如下

@JsonFormat(pattern = "yyyyMMdd'T'HHmmss'Z'", timezone="GMT+8")
private Date createDate;

再次运行,查看结果
在这里插入图片描述
可以看到时间已经正确了

小结

  • JsonFormat注解可以帮助我们实现日期转化为指定格式的时间字符串
  • pattern属性指定时间格式,timezone属性指定时区
  • LocalDateTime不会产生时区问题;Date会产生时区问题,需要使用timezone进行指定
  • 2
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值