在springboot中開(kāi)發(fā)RESTful接口，經(jīng)常會(huì)遇到日期時(shí)間轉(zhuǎn)換相關(guān)的問(wèn)題，例如我們明明輸入看起來(lái)很正常的日期時(shí)間字符串，但是系統(tǒng)卻報(bào)錯(cuò)無(wú)法解析：

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

或者接口返回的日期時(shí)間字符串是一個(gè)很奇怪的字符串：

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

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

日期時(shí)間格式標(biāo)準(zhǔn)

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

IETF

RFC822->RFC2822->RFC5322

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

通過(guò)幾個(gè)例子來(lái)了解下這種格式長(zhǎng)什么樣子。

最常見(jiàn)的樣子如下，通過(guò)linux命令date可以打?。?/p>

date --rfc-email

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

有些格式已經(jīng)不建議使用，RFC2822定義為過(guò)時(shí)的格式，如：

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

RFC1123

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

RFC1036

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

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

ISO8601,RFC3339

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

RFC3339是ISO8601的概要版本。

先通過(guò)例子了解一下他們長(zhǎng)什么樣子。

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

以上是最常見(jiàn)的樣子，ISO8601相對(duì)于RFC5322有幾個(gè)主要變化：

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

RFC3339和ISO8601的區(qū)別：

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

Java日期時(shí)間編程接口

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

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

sprintboot中如何處理日期時(shí)間

確切的說(shuō)是如何處理json和java日期時(shí)間對(duì)象之間的轉(zhuǎn)換。

springboot極大的簡(jiǎn)化了springmvc的開(kāi)發(fā)，對(duì)于開(kāi)發(fā)RESTful接口也是一樣，開(kāi)箱即用。這是通過(guò)autoconfigure和starter實(shí)現(xiàn)的。

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

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

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

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

其中有三個(gè)點(diǎn)對(duì)jackson進(jìn)行配置：Jackson2ObjectMapperBuilder，Jackson2ObjectMapperBuilderCustomizer和ObjectMapper，以上所有配置最終都是影響ObjectMapper。

• Jackson2ObjectMapperBuilder是ObjectMapper的工廠，只有一個(gè)，所以這里使用了@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會(huì)調(diào)用Jackson2ObjectMapperBuilderCustomizer對(duì)builder進(jìn)行定制，即上述customize方法，Jackson2ObjectMapperBuilderCustomizer可以有多個(gè)

@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，只能有一個(gè)，所以你需要指定@Primary，默認(rèn)是通過(guò)builder創(chuàng)建

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

那么對(duì)于日期時(shí)間的處理，springboot的默認(rèn)行為是怎么樣的呢，默認(rèn)的代碼配置在上述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屬性，如果不為空就會(huì)設(shè)置builder.dateFormat，如果是一個(gè)類（當(dāng)然是從java.text.DateFormat派生），那么初始化為這個(gè)類的實(shí)例，否則認(rèn)為配置的yyyy-MM-dd HH:mm:ss這種格式化字符串，然后創(chuàng)建SimpleDateFormat實(shí)例。

另外springmvc本身還有一個(gè)MappingJackson2HttpMessageConverter，其實(shí)也是配置Jackson2ObjectMapperBuilder。

本文作者： 鐘潘
本文鏈接： http://zhongpan.tech/2020/06/04/033-time-format-processing-in-springboot/

以上就是Spring Boot中是如何處理日期時(shí)間格式的的詳細(xì)內(nèi)容，更多關(guān)于Spring Boot中日期時(shí)間格式處理的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論