首页 > 编程语言 > @JsonFormat 实现日期格式自动格式化
2022
05-12

@JsonFormat 实现日期格式自动格式化

@JsonFormat 日期格式自动格式化

通常日期格式都是以时间戳的形式存放在数据库里，当前端页面通过接口查询时，我们会将一个对象的某些属性查出来返回给页面。

例如，某个类里面有个属性

Timestamp create_time

给这个对象实体类中的get方法加注解：@JsonFormat 来实现格式的自动转换：

依赖的jar包：jackson-annotations-2.8.5.jar

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
public Timestamp getCreate_time() {
        return create_time;
}

加注解前的返回值是一个时间戳，加了之后则按照注解的格式自动格式化。

@JsonFormat时间格式化注解使用

@JsonFormat注解是一个时间格式化注解

比如我们存储在mysql中的数据是date类型的，当我们读取出来封装在实体类中的时候，就会变成英文时间格式，而不是yyyy-MM-dd HH:mm:ss这样的中文时间，因此我们需要用到JsonFormat注解来格式化我们的时间。

JsonFormat注解是jackson包里面的一个注解，因此在使用的时候需要引入fasterxml maven的jar包，如下所示。

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.2</version>
</dependency>

引入fasterxml maven jar包之后，就可以在实体类属性上面使用@JsonFormat注解了，要注意的是，它只会在类似@ResponseBody返回json数据的时候，才会返回格式化的yyyy-MM-dd HH:mm:ss时间，你直接使用System.out.println()输出的话，仍然是类似“Fri Dec 01 21:05:20 CST 2017”这样的时间样式。

package demo;
import java.util.Date;
import com.fasterxml.jackson.annotation.JsonFormat;
public class Student {
    private int id;
    private String username;        
    @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
    private Date createDate;    
    //getter setter省略。。。            
}

当我们这样@ResponseBody输出json数据的时候，@JsonFormat注解标识的date属性就会自动返回yyyy-MM-dd HH:mm:ss样式的时间了，例如。

@PostMapping("/api/getStudent")
@ResponseBody
public Map<String,Object> findStudentById(Long stuId){
    Map<String,Object> resultMap = new HashMap<>();
    Student stu = StudentService.findStudentById(stuId);
    resultMap.put("result",stu);
    return resultMap;
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持自学编程网。

编程技巧