Spring Boot中是如何处理日期时间格式的

  • Z时代
  • 2024-01-10
  • 分类：综合

在springboot中开发RESTful接口，经常会遇到日期时间转换相关的问题，例如我们明明输入看起来很正常的日期时间字符串，但是系统却报错无法解析：

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

如何正确的处理日期时间，本文将一探究竟。

日期时间格式标准

有两个标准组织对日期时间格式进行规范，一个是IETF，一个是ISO。虽然IETF的定义更早，但是它存在一些问题，ISO的定义使用更普遍。但是不管哪种定义，我们常常使用的yyyy-MM-dd HH:mm:ss这种格式都不是标准的，你是否非常惊讶呢。

IETF

RFC822->RFC2822->RFC5322

日期时间的本文表示最早是在电子邮件消息中被讨论和定义，可以追溯到Internet刚诞生之时，ARPANET使用的文本信息格式中所定义，也就是RFC822，发布于1982年。此后经过若干次修订，定型是RFC2822，最新版是RFC5322。

通过几个例子来了解下这种格式长什么样子。

最常见的样子如下，通过linux命令date可以打印：

date --rfc-email

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

有些格式已经不建议使用，RFC2822定义为过时的格式，如：

  • 年份使用4位以下数字

  • 时区使用时区名，如UT，GMT

RFC1123

RFC1123并不定义日期时间格式，而是描述应用程序之间通信协议的需求，包括各种应用层协议，如TELNET，FTP，SMTP等，涉及到日期时间格式的正是SMTP，它引用了RFC822，并说明了年份修改为2到4个数字，建议时区总是使用数字。

RFC1036

同样RFC1306也不定义日期时间格式，而是描述USENET中对日期时间的要求，同样引用了RFC822。

综上IETF的时间格式主要为电子邮件定义，但是只要以可读文本方式表示时间都可以使用。IETF的定义带有明显的时代和地区特征，并不具有国际通用性，也不便于阅读和解析，因此又出现了ISO的日期时间格式。

ISO8601,RFC3339

ISO的日期时间格式有助于避免由许多不同的国家符号引起的国际通信混乱，并提高了计算机用户界面的可移植性。第一版发布于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时区可以简写为Z

  • 年月日或时分秒之间的连接符可省略

RFC3339和ISO8601的区别：

  • RFC3339允许将日期和时间之间的连接符T换为空格

  • 秒的小数部分通常使用.连接

  • 未使用一年的第几周的星期几的表示

Java日期时间编程接口

Java的发展过程中出现过几个不同的日期时间编程接口。java8之前的日期时间接口存在众所周知的问题，这时只能寻求第三方库库来解决，这就是joda，java8大量借鉴了joda，推出了新的日期时间库。自此，java8日期时间接口成为首选。

java8之前java8joda
本地时间java.util.Datejava.time.LocalDate

java.time.LocalTime

java.time.LocalDateTime

org.joda.time.LocalDate

org.joda.time.LocalTime

org.joda.time.LocalDateTime

带时区时间java.time.OffsetTime

java.time.OffsetDateTime

java.time.ZonedDateTime

org.joda.time.DateTime
格式化和解析java.text.DateFormatjava.time.format.DateTimeFormatterorg.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”);

以上各种日期时间编程接口都提供了格式化和解析接口，实现字符串和日期时间对象之间的互相转换，我们可以定制日期格式，例如常用的格式yyyy-MM-dd HH:mm:ss，那么格式化和解析都会按照这个格式，解析时如果不符合格式就会异常。

sprintboot中如何处理日期时间

确切的说是如何处理json和java日期时间对象之间的转换。

springboot极大的简化了springmvc的开发，对于开发RESTful接口也是一样，开箱即用。这是通过autoconfigure和starter实现的。

首先引入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。可见json的实现默认是使用的jackson。其中jackson-datatype-jsr310就包含了java8日期时间的序列化、反序列化方法。

其次springboot应用，也就是使用了@SpringBoot" title="SpringBoot">SpringBootApplication注解，通过autoconfigure对jackson进行了自动配置。实现代码在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创建

@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这种格式化字符串，然后创建SimpleDateFormat实例。

另外springmvc本身还有一个MappingJackson2HttpMessageConverter，其实也是配置Jackson2ObjectMapperBuilder。

本文作者： 钟潘

本文链接： http://zhongpan.tech/2020/06/04/033-time-format-processing-in-springboot/

以上是 Spring Boot中是如何处理日期时间格式的 的全部内容， 来源链接： utcz.com/z/356868.html

回到顶部