定制日期时间格式

定制日期时间格式

当我们和前端交互中传递时间时，我们可以指定时间的表示格式，以方便前端的数据展示和接收处理前端的时间参数

配置日期数据格式，可以通过配置文件的方式，也可以通过注解的方式

配置文件指定日期格式

我们定义一个接口，返回一个Date对象，测试在默认情况下的JSON转换会转换成什么格式

@RestController
public class MyController {

    @RequestMapping("/getDate")
    public Date getDate() {
        return new Date();
    }
}

测试结果如下

在Spring Boot的配置文件中加入以下配置，就可以指定返回前端的数据格式

spring:
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8

再次测试结果如下

如果我们要指定前端返回的日期参数的格式，可以使用以下配置

spring:
  mvc:
    format:
      date: yyyy/MM/dd

定义一个测试接口

@RestController
public class MyController {

    @RequestMapping("/setInfo")
    public Date setInfo(@RequestParam("date") Date date) {
        return date;
    }
}

测试结果如下

也可以使用以下配置来指定前端返回的日期参数的格式

spring:
  mvc:
    format:
      date-time: yyyy-MM-dd HH:mm:ss

但是注意用这个配置的时候需要使用/来分割日期，而不是使用-

@JsonFormat注解

Spring Boot底层默认使用Jackson作为JSON转换工具，当我们使用Spring Boot做web开发时，也可以使用Jackson的@JsonFormat注解来指定返回给前端的格式，不过用法不同，使用注解的方式需要在实体类的属性上指定

@Data
public class Person {
    private String name;
    @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
    private Date birth;
}

定义一个测试接口测试返回的日期格式

@RestController
public class MyController {

    @RequestMapping("/getInfo")
    public Person getInfo() throws ParseException {
        Person person = new Person();
        person.setName("cong");
        Date birth = new SimpleDateFormat("yyyy-MM-dd").parse("1996-03-29");
        person.setBirth(birth);
        return person;
    }
}

@JsonFormat注解也可以用来指定接收前端日期参数的格式

@RestController
public class MyController {

    @RequestMapping("/setInfo")
    public Date setInfo(@JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8") Date date) {
        return date;
    }
}

注意这种使用方式需要使用/来分割日期，而不是使用-

如果使用fastjson作为JSON转换工具，则使用@JSONField注解，使用方式相同

@DateTimeFormat注解

使用@DateTimeFormat注解，也可以指定接收前端日期参数的格式，使用方法是在实体类的属性上添加注解

@Data
public class Person {
    private String name;
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private Date birth;
}

创建测试接口

@RestController
public class MyController {

    @RequestMapping("/setInfo")
    public Person setInfo(Person person) {
        return person;
    }
}

测试结果如下