在SpringBoot中我们定义模型,模型中包含 Date类型的数据时,使用SpringBoot查询返回后是时间戳格式的,但是我们前端实际是需要一个可读性很好的时间格式数据,我们说一下怎么去进行格式化SpringBoot请求返回的JSON数据的格式化,我们会使用以下方式进行讲解.
使用@JsonFormat
使用该注解很简单,我们只需要在实体类中的字段上增加@JsonFormat注解即可,比如我们的实体类是public class ForMatModel {
@JsonFormat(pattern="yyyy-MM-dd")
private Date createTime;
@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
private LocalDateTime updateTime;
}
在示例中我们将createTime字段格式化为 yyyy-MM-dd那么我们得到的回显信息便是2019-06-05
updateTime字段我们使用的是Java8日期类型,我们将时间格式化为 yyyy-MM-dd HH:mm:ss那么我们得到的回显信息便是2019-06-05 18:51:40pattern格式可以传递任意正常可以使用的SimpleDateFormat所使用的格式表达式
我们调用给定日期格式的@JsonFormat呈现的输出为{
"createTime": "2019-06-05",
"updateTime": "2019-06-05 18:51:40"
}使用@JsonFormat注解格式化特定日期字段是一个很好的选择,这样使代码也很美观.
但是,我们只应在需要字段的特定格式时使用它。如果我们想要在我们的应用程序中使用所有日期的通用格式,那么该方式就不实用了.
当然我们还可以为@JsonFormat设置时区,格式为@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss", timezone="Asia/Chongqing")
private LocalDateTime updateTime;
如果类型使用的是java.time.ZonedDatetime,那么我们不需要使用它,因为该类型已包含时区。
配置默认格式(全局通用)
虽然@JsonFormat很强大,但对格式和时区进行硬编码可能会让我们会觉得很麻烦和复杂,这样会使代码相似度很高。
如果我们要为程序的所有日期配置默认格式,更灵活的方法是在 application.properties中配置它:spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
如果需要加时区的话,配置:spring.jackson.time-zone=Asia/Chongqing这样设置的默认格式非常方便直接,但这种方法存在缺陷。它不适用于Java8日期类型,如 LocalDate和LocalDateTime - 我们只能使用它来格式化java.util.Date或java.util.Calendar类型的字段 。
自定义ObjectMapper-Jackson
如果我们想使用Java 8日期类型并设置默认日期格式,那么我们需要查看创建一个 Jackson2ObjectMapperBuilderCustomizer bean:@Configuration
public class ContactAppConfig {
private static final String dateFormat = "yyyy-MM-dd";
private static final String dateTimeFormat = "yyyy-MM-dd HH:mm:ss";
@Bean
public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
return builder -> {
builder.simpleDateFormat(dateTimeFormat);
builder.serializers(new LocalDateSerializer(DateTimeFormatter.ofPattern(dateFormat)));
builder.serializers(new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(dateTimeFormat)));
};
}
}
我们使用代码全局配置了默认的时间格式化规则,这种方法看起来有点麻烦,但它的优点在于它适用于Java8和旧版日期类型.
我们有以上3中解决方案,可以根据自身的需求进行响应的方案选择:如果只需要部分时间类型转换建议使用@JsonFormat
全局时间类型转换,且编译环境为JDK1.8以下,可以使用application.properties配置
全局并不区分编译环境使用自定义ObjectMapper