Spring之@JsonFormat与@DateTimeFormat注解的使用

偏执的太偏执、 2021-11-17 22:24 434阅读 0赞

# 1、配置方式 #

spring boot在application.yml，给出默认的格式

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

# 2、注解方式 #

前端传到后台时间参数格式的规范要求；后台返给前端序列化成json串，要求的时间展示格式。也可以通过以下两个注解来实现：

注解**@JsonFormat：**主要是后台到前台的时间格式的转换

注解**@DateTimeFormat：**主要是前后到后台的时间格式的转换

声明：关于@JsonFormat的使用，一定要导入正确完整的包。

## 2.1、注解@JsonFormat ##

1）pom.xml引入依赖

<dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-annotations</artifactId>
                <version>2.8.8</version>
            </dependency>
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
                <version>2.8.8</version>
            </dependency>
            <dependency>
                <groupId>org.codehaus.jackson</groupId>
                <artifactId>jackson-mapper-asl</artifactId>
                <version>1.9.13</version>
            </dependency>

2）实体或VO添加注解

@ApiModelProperty("入职时间")
        @JsonFormat(timezone = "GMT+8",pattern = "yyyy-MM-dd")
        private Date entryTime;

@JsonFormat(timezone = "GMT+8"，pattern="yyyy-MM-dd"）

timezone：时区，设置为东八区，避免时间在转换中有误差

pattern:要转换成的时间格式

说明：@JsonFormat注解，可以置于属性上方，也可以置于属性对应get方法上方。

3.完成上面两步之后，我们用对应的实体类来接收数据库查询出来的结果时就完成了时间格式的转换，再返回给前端时就是一个符合我们设置的时间格式了

## 2.2、注解@DateTimeFormat ##

1）@DateTimeFormat的使用和@jsonFormat差不多，首先需要引入是spring还有jodatime,spring我就不贴了

<dependency>
                <groupId>joda-time</groupId>
                <artifactId>joda-time</artifactId>
                <version>2.3</version>
            </dependency>

2）在controller层我们使用spring mvc 表单自动封装映射对象时，我们在对应的接收前台数据的对象的属性上加@@DateTimeFormat

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

代码中给出了两个属性，从前端传至后台，后台返给前端，都需对时间进行格式的转换，即可同时使用。