@JsonFormat、@JSONField、@DateTimeFormat详细解说_@jsonfield format_xinlianluohan的博客-CSDN博客
三者出处
1、JsonFormat来源于jackson,Jackson是一个简单基于Java应用库,Jackson可以轻松的将Java对象转换成json对象和xml文档,同样也可以将json、xml转换成Java对象。Jackson所依赖的jar包较少,简单易用并且性能也要相对高些,并且Jackson社区相对比较活跃,更新速度也比较快。
2、JSONField来源于fastjson,是阿里巴巴的开源框架,主要进行JSON解析和序列化。
3、DateTimeFormat是spring自带的处理框架,主要用于将时间格式化。
用法
DateTimeFormat:
因为其用法比较单一,只用于将字符串格式化成日期,在加入spring以后,直接使用注解@DateTimeFormat(pattern=”yyyy-MM-dd”)即可。@DateTimeFormat 注解有3个可选的属性:style,pattern和iso。
属性style: 允许我们使用两个字符的字符串来表明怎样格式化日期和时间。第一个字符表明了 日期的格式,第二个字符表明了时间的格式。下面的表格中列出了可用的选择以及相应的输出的例子:
描述 字符串值 示例输出
Tables Are Cool
短格式(这是缺省值) SS 8/30/64 11:24 AM
中等格式 MM Aug 30, 1964 11:24:41 AM
长格式 LL August 30, 1964 11:24:41 AM CDT
完整格式 FF Sunday, August 30,1964 11:24:41 AM CDT
使用短横线省略日期或时间 M- Aug 30, 1964
Pattern: 属性允许我们使用自定义的日期/时间格式。该属性的值遵循java标准的date/time格式规范。缺省的该属性的值为空,也就是不进行特殊的格式化。通常情况下我们都是使用这个 注解做自定义格式化的。
iso: 基本上用不上,这里不做讲解
JsonFormat
用法 为在属性值上 @JsonFormat(pattern=”yyyy-MM-dd”,timezone=”GMT+8”),如果直接使用 @JsonFormat(pattern=”yyyy-MM-dd”)就会出现2018-08-01 08:00:00的情况, 会相差8个小时,因为我们是东八区(北京时间)。所以我们在格式化的时候要指定时区(timezone )
JSONField
用法:目前最常用的属性是@JSONField(name=”resType”)和 @JSONField(format=”yyyy-MM-dd”)
name:@JSONField(name=”resType”)主要用于指定前端传到后台时对应的key值,如果bean中没有这个注解,则默认前端传过来的key是field本身,即如果是private String name,name前端对应的key就是name才能对应上。
format @JSONField(format=”yyyy-MM-dd”)主要用于格式化日期,比如前台传过来的时间是2018-07-12 17:44:08,但是通过这个注解,你存到数据库的时间就是2018-07-12 00:00:00.
区别
网上有说DateTimeFormat主要用于后台接受前台的值,而JsonFormat主要用于后台传值到前台,其实都一个用,没差的。其他的区别就是速度的问题了,这里有一篇其对数据的处理速度的对比,供大家参考。
https://github.com/eishay/jvm-serializers/wiki
实战讲解:
1. 准备
定义一个pojo,它有一个 java.util.Date 类型的属性 date。
-
import java.util.Date;
-
public class DateVo {
-
private Date date;
-
//省略set\get方法
-
}
定义一个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 类型的,类型无法转换。
2. 入参格式化
这时,就可以使用 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
否则会抛出异常。
3. 出参格式化
在上述示例中,调用接口的返回结果为:
"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 相关依赖。
参考:@JsonFormat、@JSONField、@DateTimeFormat的使用以及其区别 ||||返回json的时候的时间转化_hanpenghu的博客-CSDN博客
https://blog.csdn.net/zhou520yue520/article/details/81348926