关于实体类中Date属性格式化@JsonFormat @DateTimeFormat

 更新时间:2023年07月15日 10:06:27   作者:imHanweihu  
这篇文章主要介绍了关于实体类中Date属性格式化@JsonFormat @DateTimeFormat问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

实体类中Date属性格式化@JsonFormat @DateTimeFormat

mysql 数据库中是datetime类型,java对象中用date接收,传给前台时,想要格式化一下

在实体类的属性上使用注解: 

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
  • shape: 表示序列化后的一种数据类型
  • pattern: 表示最终日期的格式
  • timezone: 默认是GMT,中国需要GMT+8
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date createDate;

注意:使用JsonFormat注解发现,格式化后的时间比实际少了8小时,就要加上中国时区GMT+8

返给前台的json值:

"createDate": "2019-04-25 10:45:37"

实体类日期时间入参@DateTimeFormat 和出参@JsonFormat 格式化

准备

定义一个pojo,它有一个 java.util.Date 类型的属性 date。

import java.util.Date;
public class DateVo {
    private Date date;
    public void setDate(Date date){
        this.date = date;
    }
    public Date getDate(){
        return date;
    }
}

定义一个Controller

@RestController
@RequestMapping("/date/")
public class DateController {
    @RequestMapping("test")
    public DateVo getDate(DateVo vo){
        System.out.println("date1:"+vo.getDate());
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String date = sdf.format(vo.getDate());
        System.out.println("date2:"+date);
        DateVo vo2 = new DateVo();
        vo2.setDate(new Date());
        return vo2;
    }
}

访问 /date/test ,并传入参数:2018-08-02 22:05:55

发现并不能访问成功,会抛出异常:

因为传入的参数是 String 类型的,而用来接收参数的 DateVo 的 date 属性是 java.util.Date 类型的,类型无法转换。

入参格式化

这时,就可以使用 Spring 的 @DateTimeFormat 注解格式化参数,来解决上述问题。

改造 DateVo:

public class DateVo {
    @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")
    private Date date;
    public void setDate(Date date){
        this.date = date;
    }
    public Date getDate(){
        return date;
    }
}

再像上面一样访问 /date/test ,并传入参数:2018-08-02 22:05:55,将在控制台上打印:

date1: Thu Aug 02 22:05:55 CST 2018
date2: 2018-08-02 22:05:55

可以看到,加入 @DateTimeFormat 注解后参数可以被接收到了,但日期时间的格式还是需要自己再手动转换一下。

因为 @DateTimeFormat 注解的 pattern 属性值指定的日期时间格式并不是将要转换成的日期格式,这个指定的格式是和传入的参数对应的,假如注解为:

@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss")
则传入的参数应该是这样的:
2018/08/02 22:05:55

否则会抛出异常。

出参格式化

在上述示例中,调用接口的返回结果为:

"date": "2018-08-01T14:25:31.296+0000"

这个格式并不是我们想要的,那么如何将其进行格式化?这时就需要用到 jackson  的 @JsonFormat 注解。

改造 DateVo:

public class DateVo {
    @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date date;
    public void setDate(Date date){
        this.date = date;
    }
    public Date getDate(){
        return date;
    }
}

继续访问 /date/test ,并传入参数:2018-08-02 22:05:55,可以看到接口返回的结果为:

"date": "2018-08-01 14:32:57"

虽然时间格式正确了,但实际上当前时间是 “2018-08-01 22:32:57” ,早了8个小时。

因为,jackson在序列化时间时是按照国际标准时间GMT进行格式化的,而在国内默认时区使用的是CST时区,两者相差8小时。

所以,@JsonFormat 注解还要再加一个属性:

@JsonFormat(
    pattern = "yyyy-MM-dd HH:mm:ss",
    timezone = "GMT+8"
)
private Date date;

这样,结果就正确了。

因为 @JsonFormat 注解不是 Spring 自带的注解,所以使用该注解前需要添加 jackson 相关的依赖包。

当然,如果是 SpringBoot 项目就不需要自己手动添加依赖了,因为在 spring-boot-start-web 下已经包含了 jackson 相关依赖。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Mybatis-Plus中的selectByMap使用实例

    Mybatis-Plus中的selectByMap使用实例

    Mybatis-Plus来对数据库进行增删改查时,将里面的函数试了个遍,接下来我就将使用selectByMap函数的简单测试实例写出来,方便没有使用过的朋友们快速上手,感兴趣的可以了解一下
    2021-11-11
  • 关于ThreadLocal对request和response的用法说明

    关于ThreadLocal对request和response的用法说明

    这篇文章主要介绍了关于ThreadLocal对request和response的用法说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • 深入理解Hibernate中的flush机制

    深入理解Hibernate中的flush机制

    这篇文章主要介绍了深入理解Hibernate中的flush机制,本文是对flush机制深入研究得出的一些结论总结,需要的朋友可以参考下
    2015-01-01
  • 深入讲解我们说的CAS自旋锁到底是什么

    深入讲解我们说的CAS自旋锁到底是什么

    这篇文章主要给大家介绍了关于我们说的CAS自旋锁到底是什么的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-05-05
  • Spring security如何重写Filter实现json登录

    Spring security如何重写Filter实现json登录

    这篇文章主要介绍了Spring security 如何重写Filter实现json登录,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Java Swing实现餐厅点餐系统源码(收藏版)

    Java Swing实现餐厅点餐系统源码(收藏版)

    这篇文章主要介绍了Java Swing实现餐厅点餐系统源码,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-02-02
  • mybatis如何批量修改数据

    mybatis如何批量修改数据

    这篇文章主要介绍了mybatis如何批量修改数据方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Springboot+mybatis plus找不到mapper.xml的问题解决

    Springboot+mybatis plus找不到mapper.xml的问题解决

    本文主要介绍了Springboot+mybatis plus找不到mapper.xml的问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05
  • SpringMVC实现通过邮件找回密码功能

    SpringMVC实现通过邮件找回密码功能

    本篇文章主要介绍的是SpringMVC实现通过邮件找回密码功能,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧。
    2016-10-10
  • springboot+Oauth2实现自定义AuthenticationManager和认证path

    springboot+Oauth2实现自定义AuthenticationManager和认证path

    本篇文章主要介绍了springboot+Oauth2实现自定义AuthenticationManager和认证path,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09

最新评论