Spring Boot中格式化JSON日期

---

前言

今天博主将为大家分享SpringBoot（小笔记）：Spring Boot中格式化JSON日期，不喜勿喷，如有异议欢迎讨论！

---

概述

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

---

在日期字段上使用@JsonFormat

设置格式

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

public class Cntact{// other fields
		@JsonFormat(pattern = "yyyy-MM-dd")
		private LocalDate birthday;
		@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
		private LocalDateTime lastUpdate;
	}

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

public class ContactWithJavaUtilDate{
		// other fields
		@JsonFormat(pattern = "yyyy-MM-dd")
		private	Date birthday;
		@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
		private Date lastUpdate;
		// standard getters and setters
	}

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

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

我们可以看到，使用@JsonFormat 注释是格式化特定日期字段的绝佳方法。 但是，我们只应在需要字段的特定格式时使用它。如果我们想要在我们的应用程序中使用所有日期的通用格式，那么如何实现这一目标的方式更好，我们稍后会看到。

设置时区

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

@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone="Europe/Zagreb")
private LocalDateTime lastUpdate;

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

配置默认格式

---

配置默认格式

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

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

如果我们想在JSON日期中使用特定时区，那么还有一个属性：

spring.jackson.time-zone=Europe/Zagreb

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

---

自定义Jackson的ObjectMapper

因此，如果我们想使用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)));
			};

		}

	}

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

---

到这里SpringBoot（小笔记）：Spring Boot中格式化JSON日期，分享完毕了，快去试试吧！

---

最后

• 更多参考精彩博文请看这里：《陈永佳的博客》

• 喜欢博主的小伙伴可以加个关注、点个赞哦，持续更新嘿嘿！

---