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

1. 准备

定义一个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;
    }
}

2. 定义一个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 类型的,类型无法转换。

3. 入参格式化

这时,就可以使用 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

否则会抛出异常。

4. 出参格式化

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

"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 相关依赖。

  • 3
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
@JsonFormat和@DateTimeFormat是两个常用于日期时间格式的注解。 @JsonFormat是Jackson库中的注解,用于在序列和反序列过程中指定日期时间的格式。它可以应用于属性、方法、字段和构造函数上。通过@JsonFormat注解,可以指定日期时间的格式、时区、语言等信息。例如: ```java @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private Date createTime; ``` @DateTimeFormatSpring框架中的注解,用于在数据绑定过程中将字符串转换成日期类型。它通常用于Controller层的方法数或实体类的字段上。通过@DateTimeFormat注解,可以指定接收的字符串日期时间的格式。例如: ```java @RequestMapping("/save") public String save(@DateTimeFormat(pattern = "yyyy-MM-dd") Date date) { // ... } ``` 区别: 1. 注解来源不同:@JsonFormat来自Jackson库,@DateTimeFormat来自Spring框架。 2. 使用场景不同:@JsonFormat主要用于序列和反序列过程中指定日期时间格式,@DateTimeFormat主要用于将字符串转换成日期类型。 3. 应用对象不同:@JsonFormat可以应用于属性、方法、字段和构造函数上,@DateTimeFormat主要应用于Controller层的方法数或实体类的字段上。 4. 功能不同:@JsonFormat可以指定日期时间的格式、时区、语言等信息,@DateTimeFormat只能指定接收的字符串日期时间的格式。 总结来说,@JsonFormat用于控制日期时间在序列和反序列过程中的格式,而@DateTimeFormat用于将字符串日期时间转换成具体的日期类型。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值