在Spring Boot中格式化JSON日期

1.概述

在本博文中，我们将展示如何在Spring Boot应用程序中格式化JSON日期字段。我们将探讨使用Jackson格式化日期的各种方法，Jackson被Spring Boot用作默认的JSON处理器。

2.在日期字段上使用@JsonFormat

2.1设置格式

我们可以使用@JsonFormat注解来格式化特定字段：

package com.example.domain;

import java.io.Serializable;
import java.time.LocalDate;
import java.time.LocalDateTime;

import com.fasterxml.jackson.annotation.JsonFormat;

public class User implements Serializable{
	
	private Integer userId;
	
	private String userName;
	
	private String passWord;	
	@JsonFormat(pattern = "yyyy-MM-dd")
	private LocalDate birthday;
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
	private LocalDateTime createTime;

}

在birthday字段上，我们使用的格式只显示日期，而在 createTime字段中我们也包含时间。 这里我们使用了Java 8日期类型，它们非常便于处理时态类型。当然，如果我们需要使用像java.util.Date 这样的遗留类型 ，我们可以以相同的方式使用注释：

public class User implements Serializable{
	
	private Integer userId;
	
	private String userName;
	
	private String passWord;	
	@JsonFormat(pattern = "yyyy-MM-dd")
	private Date birthday;
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
	private Date createTime;

}

最后，让我们看看使用给定日期格式的@JsonFormat 呈现的输出 ：

{    
    "birthday":"2019-02-03",
    "createTime":"2019-02-03 10:08:02"
}

2.2设置时区

另外，如果我们需要使用特定的时区，我们可以设置@JsonFormat的timezone属性：

@JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
private LocalDate birthday;

如果类型已包含时区，则不需要使用它，例如使用 java.time.ZonedDatetime.

3.配置默认格式

虽然@JsonFormat本身很强大，但对格式和时区进行硬编码可能会让我们陷入困境。 如果我们要为应用程序中的所有日期配置默认格式，则更灵活的方法是在application.properties中配置它：

#配置日期格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
#日期的时区
spring.jackson.time-zone=GMT+8

尽管设置这样的默认格式非常方便直接，但这种方法存在缺陷。不幸的是，它不适用于Java 8日期类型，如 LocalDate 和 LocalDateTime - 我们只能使用它来格式化java.util.Date或 java.util.Calendar类型的字段 。 但是，我们很快就会看到希望。

4.自定义Jackson的ObjectMapper

因此，如果我们想使用Java 8日期类型 并 设置默认日期格式，那么我们需要查看创建一个 Jackson2ObjectMapperBuilderCustomizer bean：

package com.example.config;

import java.time.format.DateTimeFormatter;

import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;

@Configuration
public class DateFormatConfig {
	
	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)));
		};
	}

}

上面的示例显示了如何在我们的应用程序中配置默认格式。我们必须定义一个bean并覆盖其自定义方法以设置所需的格式。 虽然这种方法可能看起来有点麻烦，但它的优点在于它适用于Java 8和遗留日期类型。