Spring Boot中是如何處理日期時間格式的

更新時間：2020年11月12日 08:50:50 作者：鐘潘

這篇文章主要介紹了Spring Boot中是如何處理日期時間格式的，幫助大家更好的理解和學習spring boot框架，感興趣的朋友可以了解下

在springboot中開發(fā)RESTful接口，經常會遇到日期時間轉換相關的問題，例如我們明明輸入看起來很正常的日期時間字符串，但是系統(tǒng)卻報錯無法解析：

JSON parse error: Cannot deserialize value of type java.time.OffsetDateTime from String “2020-06-06 14:26:31”

或者接口返回的日期時間字符串是一個很奇怪的字符串：

2020-06-04 14:41:54.767135400+08:00

如何正確的處理日期時間，本文將一探究竟。

日期時間格式標準

有兩個標準組織對日期時間格式進行規(guī)范，一個是IETF，一個是ISO。雖然IETF的定義更早，但是它存在一些問題，ISO的定義使用更普遍。但是不管哪種定義，我們常常使用的yyyy-MM-dd HH:mm:ss這種格式都不是標準的，你是否非常驚訝呢。

IETF

RFC822->RFC2822->RFC5322

日期時間的本文表示最早是在電子郵件消息中被討論和定義，可以追溯到Internet剛誕生之時，ARPANET使用的文本信息格式中所定義，也就是RFC822，發(fā)布于1982年。此后經過若干次修訂，定型是RFC2822，最新版是RFC5322。

通過幾個例子來了解下這種格式長什么樣子。

最常見的樣子如下，通過linux命令date可以打?。?/p>

date --rfc-email

Thu, 04 Jun 2020 13:54:52 +0800

有些格式已經不建議使用，RFC2822定義為過時的格式，如：

年份使用4位以下數字
時區(qū)使用時區(qū)名，如UT，GMT

RFC1123

RFC1123并不定義日期時間格式，而是描述應用程序之間通信協(xié)議的需求，包括各種應用層協(xié)議，如TELNET，F(xiàn)TP，SMTP等，涉及到日期時間格式的正是SMTP，它引用了RFC822，并說明了年份修改為2到4個數字，建議時區(qū)總是使用數字。

RFC1036

同樣RFC1306也不定義日期時間格式，而是描述USENET中對日期時間的要求，同樣引用了RFC822。

綜上IETF的時間格式主要為電子郵件定義，但是只要以可讀文本方式表示時間都可以使用。IETF的定義帶有明顯的時代和地區(qū)特征，并不具有國際通用性，也不便于閱讀和解析，因此又出現(xiàn)了ISO的日期時間格式。

ISO8601,RFC3339

ISO的日期時間格式有助于避免由許多不同的國家符號引起的國際通信混亂，并提高了計算機用戶界面的可移植性。第一版發(fā)布于1988年。

RFC3339是ISO8601的概要版本。

先通過例子了解一下他們長什么樣子。

date --iso-8601=ns

2020-06-04T14:41:54,767135400+08:00

date --rfc-3339=ns

2020-06-04 14:41:54.767135400+08:00

以上是最常見的樣子，ISO8601相對于RFC5322有幾個主要變化：

多了秒的小數部分，用.或,連接
精度上可以從年到秒的小數部分都可以，例如2020、2020-06、2020-06-04都是合法的
日期和時間之間增加了連接字符T
可以表示一年的第幾周的星期幾，例如2020-W01-1表示2020年第一周的星期一
UTC時區(qū)可以簡寫為Z
年月日或時分秒之間的連接符可省略

RFC3339和ISO8601的區(qū)別：

RFC3339允許將日期和時間之間的連接符T換為空格
秒的小數部分通常使用.連接
未使用一年的第幾周的星期幾的表示

Java日期時間編程接口

Java的發(fā)展過程中出現(xiàn)過幾個不同的日期時間編程接口。java8之前的日期時間接口存在眾所周知的問題，這時只能尋求第三方庫庫來解決，這就是joda，java8大量借鑒了joda，推出了新的日期時間庫。自此，java8日期時間接口成為首選。

	java8之前	java8	joda
本地時間	java.util.Date	java.time.LocalDate java.time.LocalTime java.time.LocalDateTime	org.joda.time.LocalDate org.joda.time.LocalTime org.joda.time.LocalDateTime
帶時區(qū)時間		java.time.OffsetTime java.time.OffsetDateTime java.time.ZonedDateTime	org.joda.time.DateTime
格式化和解析	java.text.DateFormat	java.time.format.DateTimeFormatter	org.joda.time.format.DateTimeFormatter
舉例	Date date = new Date(); SimpleDateFormat fmt = new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”); String str = fmt.format(date); date = fmt.parse(“2020-06-06 15:13:25”);	LocalDateTime date = LocalDateTime.now(); DateTimeFormatter fmt = DateTimeFormatter.ofPattern(“yyyy-MM-dd HH:mm:ss”); String str = fmt.format(date); TemporalAccessor acc = fmt.parse(“2020-06-06 15:13:25”); date = LocalDateTime.from(acc);	LocalDateTime date = LocalDateTime.now(); DateTimeFormatter fmt = DateTimeFormat.forPattern(“pattern”); String str = fmt.print(date); date = fmt.parseLocalDate(“2020-06-06 15:13:25”);

以上各種日期時間編程接口都提供了格式化和解析接口，實現(xiàn)字符串和日期時間對象之間的互相轉換，我們可以定制日期格式，例如常用的格式y(tǒng)yyy-MM-dd HH:mm:ss，那么格式化和解析都會按照這個格式，解析時如果不符合格式就會異常。

sprintboot中如何處理日期時間

確切的說是如何處理json和java日期時間對象之間的轉換。

springboot極大的簡化了springmvc的開發(fā)，對于開發(fā)RESTful接口也是一樣，開箱即用。這是通過autoconfigure和starter實現(xiàn)的。

首先引入spring-boot-starter-web依賴。

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
</dependency>

spring-boot-starter-web會引入spring-boot-starter-json，spring-boot-starter-json又會引入jackson-databind，jackson-datatype-jdk8和jackson-datatype-jsr310?？梢妀son的實現(xiàn)默認是使用的jackson。其中jackson-datatype-jsr310就包含了java8日期時間的序列化、反序列化方法。

其次springboot應用，也就是使用了@SpringBootApplication注解，通過autoconfigure對jackson進行了自動配置。實現(xiàn)代碼在sprint-boot-autoconfigure的JacksonAutoConfiguration.java文件中。

其中有三個點對jackson進行配置：Jackson2ObjectMapperBuilder，Jackson2ObjectMapperBuilderCustomizer和ObjectMapper，以上所有配置最終都是影響ObjectMapper。

Jackson2ObjectMapperBuilder是ObjectMapper的工廠，只有一個，所以這里使用了@ConditionalOnMissingBean

@Configuration(proxyBeanMethods = false)
	@ConditionalOnClass(Jackson2ObjectMapperBuilder.class)
	static class JacksonObjectMapperBuilderConfiguration {

		@Bean
		@Scope("prototype")
		@ConditionalOnMissingBean
		Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder(ApplicationContext applicationContext,
				List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
			Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
			builder.applicationContext(applicationContext);
			customize(builder, customizers);
			return builder;
		}

Jackson2ObjectMapperBuilder會調用Jackson2ObjectMapperBuilderCustomizer對builder進行定制，即上述customize方法，Jackson2ObjectMapperBuilderCustomizer可以有多個

@Configuration(proxyBeanMethods = false)
	@ConditionalOnClass(Jackson2ObjectMapperBuilder.class)
	@EnableConfigurationProperties(JacksonProperties.class)
	static class Jackson2ObjectMapperBuilderCustomizerConfiguration {

		@Bean
		StandardJackson2ObjectMapperBuilderCustomizer standardJacksonObjectMapperBuilderCustomizer(
				ApplicationContext applicationContext, JacksonProperties jacksonProperties) {
			return new StandardJackson2ObjectMapperBuilderCustomizer(applicationContext, jacksonProperties);
		}

最后你可以直接配置ObjectMapper，只能有一個，所以你需要指定@Primary，默認是通過builder創(chuàng)建

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(Jackson2ObjectMapperBuilder.class)
static class JacksonObjectMapperConfiguration {
 
	@Bean
	@Primary
	@ConditionalOnMissingBean
	ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
		return builder.createXmlMapper(false).build();
	}
 
}

那么對于日期時間的處理，springboot的默認行為是怎么樣的呢，默認的代碼配置在上述StandardJackson2ObjectMapperBuilderCustomizer中。

static final class StandardJackson2ObjectMapperBuilderCustomizer
		implements Jackson2ObjectMapperBuilderCustomizer, Ordered {
   ......
	private void configureDateFormat(Jackson2ObjectMapperBuilder builder) {
		// We support a fully qualified class name extending DateFormat or a date
		// pattern string value
		String dateFormat = this.jacksonProperties.getDateFormat();
		if (dateFormat != null) {
			try {
				Class<?> dateFormatClass = ClassUtils.forName(dateFormat, null);
				builder.dateFormat((DateFormat) BeanUtils.instantiateClass(dateFormatClass));
			}
			catch (ClassNotFoundException ex) {
				SimpleDateFormat simpleDateFormat = new SimpleDateFormat(dateFormat);
				// Since Jackson 2.6.3 we always need to set a TimeZone (see
				// gh-4170). If none in our properties fallback to the Jackson's
				// default
				TimeZone timeZone = this.jacksonProperties.getTimeZone();
				if (timeZone == null) {
					timeZone = new ObjectMapper().getSerializationConfig().getTimeZone();
				}
				simpleDateFormat.setTimeZone(timeZone);
				builder.dateFormat(simpleDateFormat);
			}
		}
	}

其邏輯是首先讀取spring.jackson.date-format屬性，如果不為空就會設置builder.dateFormat，如果是一個類（當然是從java.text.DateFormat派生），那么初始化為這個類的實例，否則認為配置的yyyy-MM-dd HH:mm:ss這種格式化字符串，然后創(chuàng)建SimpleDateFormat實例。

另外springmvc本身還有一個MappingJackson2HttpMessageConverter，其實也是配置Jackson2ObjectMapperBuilder。