hello,大家好,欢迎来到银之庭。我是 Z,一个普通的程序员。今天我们来看一下如何在 SpringBoot 项目中,指定时间类型字段的返回格式。
1. SpringBoot 返回的默认格式
在不指定任何特殊配置的情况下,返回的 date 类型的字段会自动转成 UTC 格式字符串,形如 2020-09-20T13:51:34.050+00:00
。
2. 指定全局返回时间戳
在 application.yml
中增加如下配置,可指定全局把 date 类型字段转换成时间戳返回,时间戳为指定时间距 1970-01-01 00:00:00 的毫秒数。
spring: jackson: serialization: write-dates-as-timestamps: true
3. 指定全局返回的时间格式
在 application.yml
中增加如下配置,可指定全局 date 类型字段的返回格式。
spring: jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8
4. 指定单个字段返回的时间格式
我们还可以只指定某个字段的返回格式,只需要在该字段上加上 com.fasterxml.jackson.annotation.JsonFormat
注解,并指定 pattern
和 timezone
即可,示例如下:
package top.zhengliwei.timeFormat.model; import com.fasterxml.jackson.annotation.JsonFormat; import lombok.Builder; import lombok.Data; import java.util.Date; @Data @Builder public class TimeResponseDTO { @JsonFormat(pattern = "yyyy/MM/dd HH:mm:ss", timezone = "GMT+8") private Date nowTime; }
5. 指定单个字段序列化器
我们还可以指定某些字段在序列化为 json 时使用我们自定义的 json 序列化器。springboot 默认使用 jackson 作为 json 序列化和反序列化组件,所以我们只要按照 jackson 规范实现自定义序列化器并使用即可。
5.1 编写自定义 json 序列化器
自定义 json 序列化器需要继承 com.fasterxml.jackson.databind.JsonSerializer
抽象基类,并重写抽象方法 serialize
。一个自定义的时间类型序列化器如下:
package top.zhengliwei.timeFormat.util; import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.JsonSerializer; import com.fasterxml.jackson.databind.SerializerProvider; import java.io.IOException; import java.text.SimpleDateFormat; import java.util.Date; public class DateSerializer extends JsonSerializer<Date> { @Override public void serialize(Date value, JsonGenerator gen, SerializerProvider serializers) throws IOException, JsonProcessingException { SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); String dateStr = dateFormat.format(value); if (!"2000-01-01 00:00:00".equals(dateStr)) { gen.writeString(dateStr); } else { gen.writeString(""); } } }
5.2 使用自定义 json 序列化器
在我们需要使用这个序列化器的字段上用 com.fasterxml.jackson.databind.annotation.JsonSerialize
注解,指定序列化器的类即可,如下:
package top.zhengliwei.timeFormat.model; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import lombok.Builder; import lombok.Data; import top.zhengliwei.timeFormat.util.DateSerializer; import java.util.Date; @Data @Builder public class TimeResponseDTO { @JsonSerialize(using = DateSerializer.class) private Date nowTime; }
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于