本文主要解决如下问题
- 1.对于日期对象，不同开发者有不同传参习惯和不同接收参数的习惯，如传字符串、时间戳，接收时用注解@Format去完成格式转换 或者 new Date("入参时间戳")。
- 2.无论上述那种方式传参和接收参数，都需要因为日期对象侵入或多或少的代码和注解，继而影响代码整体美观。
- 3.JDK8之后引入新时间类，因此注解方式不能很好的应对新时间API
所以为了解决上述三种情况，一般在项目开发前做技术要求时会统一时间类型的处理方式，本文将使用三种方式对入参和出参格式化为字符串或时间戳格式，并指出各自优缺点。
传送链接：
- 日期时间对象全局字符串出入参：https://www.jianshu.com/p/545859a91bcd
- 日期时间对象全局时间戳出入参：https://www.jianshu.com/p/bf9ad578bebc
1.全注解方式参数处理
注解方式处理依赖于spring.jackson的入参转换：
优点： 配置少；灵活（可指定参数处理）
缺点：需要转换的参数都要加注解，增加代码量；入参不能使用时间戳，Java8时间类型不能转换为时间戳。
注：@DateTimeFormat用于入参转换，@JsonFormat用于入参出参转换
1. 准备
定义一个pojo，它有一个 java.util.Date 类型的属性 date。
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.util.Date;
/**
* description
*
* @author wgb
* @date 2021/1/14 15:57
*/
@Data
public class VeryDTO {
/**
* date
*/
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date date;
/**
* localDate
*/
@JsonFormat(pattern = "yyyy-MM-dd")
private LocalDate localDate;
/**
* localDateTime
*/
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime localDateTime;
/**
* localTime
*/
@JsonFormat(pattern = "HH:mm:ss")
private LocalTime localTime;
/**
* 附加属性
*/
private String name;
}
定义一个Controller
import com.vip.tools.format.anno.dto.VeryDTO;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.util.Date;
/**
* 时间格式化 控制器
*
* @author wgb
* @date 2021/1/15 13:25
*/
@RestController
@RequestMapping(value = "/annotation_format")
public class AnnoDateFormatController {
/**
* 格式化测试
*
* @return
*/
@PostMapping("/test")
public VeryDTO format(@RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") Date date
, @RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate localDate
, @RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime localDateTime
, @RequestParam @DateTimeFormat(pattern = "HH:mm:ss") LocalTime localTime, @RequestBody VeryDTO dto) {
System.out.println(date);
System.out.println(localDate);
System.out.println(localDateTime);
System.out.println(localTime);
System.out.println(dto);
return dto;
}
}
2. 入参格式化
2.1 参数注解
使用 Spring 的 @DateTimeFormat 注解格式化入参
请求URL：http://localhost:9600/annotation_format/test?date=2020-01-25 12:00:23&localDate=2020-01-25&localDateTime=2020-01-25 12:00:23&localTime=12:00:23
Body参数
{
"date": "2020-12-31 23:59:59",
"localDate": "2020-12-31",
"localDateTime": "2020-12-31 23:59:59",
"localTime": "23:59:59",
"name": "TEST"
}
将在控制台上打印：
Sat Jan 25 12:00:23 CST 2020
2020-01-25
2020-01-25T12:00:23
12:00:23
VeryDTO(date=Thu Dec 31 23:59:59 CST 2020, localDate=2020-12-31, localDateTime=2020-12-31T23:59:59, localTime=23:59:59, name=TEST)
3. 出参格式化
3.1 使用 jackson 的 @JsonFormat注解格式化出参
- 虽然时间格式正确了，但实际上当前时间是 “2018-08-01 22:32:57” ，早了8个小时。因为，jackson在序列化时间时是按照国际标准时间GMT进行格式化的，而在国内默认时区使用的是CST时区，两者相差8小时。
所以，@JsonFormat 注解还要再加一个属性：timezone
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss"，timezone = "GMT+8")
private Date date;
这样，结果就正确了。
响应结果：
{
"date": "2020-12-31 23:59:59",
"localDate": "2020-12-31",
"localDateTime": "2020-12-31 23:59:59",
"localTime": "23:59:59",
"name": "TEST"
}
因为 @JsonFormat 注解不是 Spring 自带的注解，所以使用该注解前需要添加 jackson 相关的依赖包。当然，如果是 SpringBoot 项目就不需要自己手动添加依赖了，因为在 spring-boot-start-web 下已经包含了 jackson 相关依赖。
3.2 在yml中统一配置出参格式化（推荐）
另一种出参格式化就是在yml中配置Jackson全局属性
application.yml配置文件
server:
port: 9600
spring:
jackson:
# 全局设置@DateTimeFormat/@JsonFormat的格式pattern,可以被@DateTimeFormat/@JsonFormat覆盖
date-format: yyyy-MM-dd HH:mm:ss
# 设置全局时区
time-zone: GMT+8
serialization:
# 返回的java.util.date转换成timestamp,可以被@JsonFormat覆盖
write-dates-as-timestamps: true
以上就是以全注解配合Jackson配置完成时间对象的出入参格式化。
