Initial support for JDK 8 Date-Time (JSR-310)

This is largely derived from our existing Joda-Time support, with corresponding classes wherever possible. Issue: SPR-9641
2013-04-23 13:59:19 +02:00
parent cd996ba18f
commit 1733237579
14 changed files with 1529 additions and 2 deletions
--- a/spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormatterFactoryBeanTests.java
+++ b/spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormatterFactoryBeanTests.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2002-2012 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.format.datetime.standard;
+
+import java.time.format.DateTimeFormatter;
+import java.time.format.FormatStyle;
+
+import org.junit.Test;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+
+/**
+ * @author Phillip Webb
+ * @author Sam Brannen
+ */
+public class DateTimeFormatterFactoryBeanTests {
+
+	private DateTimeFormatterFactoryBean factory = new DateTimeFormatterFactoryBean();
+
+	@Test
+	public void isSingleton() throws Exception {
+		assertThat(factory.isSingleton(), is(true));
+	}
+
+	@Test
+	@SuppressWarnings("rawtypes")
+	public void getObjectType() throws Exception {
+		assertThat(factory.getObjectType(), is(equalTo((Class) DateTimeFormatter.class)));
+	}
+
+	@Test
+	public void getObject() throws Exception {
+		factory.afterPropertiesSet();
+		assertThat(factory.getObject().toString(), is(equalTo(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM).toString())));
+	}
+
+	@Test
+	public void getObjectIsAlwaysSingleton() throws Exception {
+		factory.afterPropertiesSet();
+		DateTimeFormatter formatter = factory.getObject();
+		assertThat(formatter.toString(), is(equalTo(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM).toString())));
+		factory.setStylePattern("LL");
+		assertThat(factory.getObject(), is(sameInstance(formatter)));
+	}
+}
--- a/spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormatterFactoryTests.java
+++ b/spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormatterFactoryTests.java
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2002-2012 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.format.datetime.standard;
+
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.FormatStyle;
+import java.util.Locale;
+import java.util.TimeZone;
+
+import org.junit.Test;
+
+import org.springframework.format.annotation.DateTimeFormat.ISO;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+
+/**
+ * @author Phillip Webb
+ * @author Sam Brannen
+ */
+public class DateTimeFormatterFactoryTests {
+
+	// Potential test timezone, both have daylight savings on October 21st
+	private static final TimeZone ZURICH = TimeZone.getTimeZone("Europe/Zurich");
+	private static final TimeZone NEW_YORK = TimeZone.getTimeZone("America/New_York");
+
+	// Ensure that we are testing against a timezone other than the default.
+	private static final TimeZone TEST_TIMEZONE = ZURICH.equals(TimeZone.getDefault()) ? NEW_YORK : ZURICH;
+
+
+	private DateTimeFormatterFactory factory = new DateTimeFormatterFactory();
+
+	private LocalDateTime dateTime = LocalDateTime.of(2009, 10, 21, 12, 10, 00, 00);
+
+
+	@Test
+	public void createDateTimeFormatter() throws Exception {
+		assertThat(factory.createDateTimeFormatter().toString(), is(equalTo(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM).toString())));
+	}
+
+	@Test
+	public void createDateTimeFormatterWithPattern() throws Exception {
+		factory = new DateTimeFormatterFactory("yyyyMMddHHmmss");
+		DateTimeFormatter formatter = factory.createDateTimeFormatter();
+		assertThat(formatter.format(dateTime), is("20091021121000"));
+	}
+
+	@Test
+	public void createDateTimeFormatterWithNullFallback() throws Exception {
+		DateTimeFormatter formatter = factory.createDateTimeFormatter(null);
+		assertThat(formatter, is(nullValue()));
+	}
+
+	@Test
+	public void createDateTimeFormatterWithFallback() throws Exception {
+		DateTimeFormatter fallback = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.LONG);
+		DateTimeFormatter formatter = factory.createDateTimeFormatter(fallback);
+		assertThat(formatter, is(sameInstance(fallback)));
+	}
+
+	@Test
+	public void createDateTimeFormatterInOrderOfPropertyPriority() throws Exception {
+		factory.setStylePattern("SS");
+		assertThat(applyLocale(factory.createDateTimeFormatter()).format(dateTime), is("10/21/09 12:10 PM"));
+
+		factory.setIso(ISO.DATE);
+		assertThat(applyLocale(factory.createDateTimeFormatter()).format(dateTime), is("2009-10-21"));
+
+		factory.setPattern("yyyyMMddHHmmss");
+		assertThat(factory.createDateTimeFormatter().format(dateTime), is("20091021121000"));
+	}
+
+	@Test
+	public void createDateTimeFormatterWithTimeZone() throws Exception {
+		factory.setPattern("yyyyMMddHHmmss Z");
+		factory.setTimeZone(TEST_TIMEZONE);
+		ZoneId dateTimeZone = TEST_TIMEZONE.toZoneId();
+		ZonedDateTime dateTime = ZonedDateTime.of(2009, 10, 21, 12, 10, 00, 00, dateTimeZone);
+		String offset = (TEST_TIMEZONE.equals(NEW_YORK) ? "-0400" : "+0200");
+		assertThat(factory.createDateTimeFormatter().format(dateTime), is("20091021121000 " + offset));
+	}
+
+	private DateTimeFormatter applyLocale(DateTimeFormatter dateTimeFormatter) {
+		return dateTimeFormatter.withLocale(Locale.US);
+	}
+
+}
--- a/spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormattingTests.java
+++ b/spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormattingTests.java
@@ -0,0 +1,422 @@
+/*
+ * Copyright 2002-2013 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.format.datetime.standard;
+
+import java.lang.reflect.Method;
+import java.time.Instant;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.time.ZoneId;
+import java.time.format.DateTimeFormatter;
+import java.time.format.FormatStyle;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import org.springframework.beans.MutablePropertyValues;
+import org.springframework.context.i18n.LocaleContextHolder;
+import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
+import org.springframework.core.convert.support.DefaultConversionService;
+import org.springframework.format.annotation.DateTimeFormat;
+import org.springframework.format.annotation.DateTimeFormat.ISO;
+import org.springframework.format.support.FormattingConversionService;
+import org.springframework.validation.DataBinder;
+
+import static org.junit.Assert.*;
+
+/**
+ * @author Keith Donald
+ * @author Juergen Hoeller
+ * @author Phillip Webb
+ */
+public class DateTimeFormattingTests {
+
+	private FormattingConversionService conversionService;
+
+	private DataBinder binder;
+
+	@Before
+	public void setUp() {
+		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
+		setUp(registrar);
+	}
+
+	private void setUp(DateTimeFormatterRegistrar registrar) {
+		conversionService = new FormattingConversionService();
+		DefaultConversionService.addDefaultConverters(conversionService);
+
+		registrar.registerFormatters(conversionService);
+
+		DateTimeBean bean = new DateTimeBean();
+		bean.getChildren().add(new DateTimeBean());
+		binder = new DataBinder(bean);
+		binder.setConversionService(conversionService);
+
+		LocaleContextHolder.setLocale(Locale.US);
+		DateTimeContext context = new DateTimeContext();
+		context.setTimeZone(ZoneId.of("-05:00"));
+		DateTimeContextHolder.setDateTimeContext(context);
+	}
+
+	@After
+	public void tearDown() {
+		LocaleContextHolder.setLocale(null);
+		DateTimeContextHolder.setDateTimeContext(null);
+	}
+
+	@Test
+	public void testBindLocalDate() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDate", "10/31/09");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("10/31/09", binder.getBindingResult().getFieldValue("localDate"));
+	}
+
+	@Test
+	public void testBindLocalDateWithSpecificStyle() throws Exception {
+		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
+		registrar.setDateStyle(FormatStyle.LONG);
+		setUp(registrar);
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDate", "October 31, 2009");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("October 31, 2009", binder.getBindingResult().getFieldValue("localDate"));
+	}
+
+	@Test
+	public void testBindLocalDateWithSpecificFormatter() throws Exception {
+		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
+		registrar.setDateFormatter(DateTimeFormatter.ofPattern("yyyyMMdd"));
+		setUp(registrar);
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDate", "20091031");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("20091031", binder.getBindingResult().getFieldValue("localDate"));
+	}
+
+	@Test
+	public void testBindLocalDateArray() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDate", new String[]{"10/31/09"});
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+	}
+
+	@Test
+	public void testBindLocalDateAnnotated() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateAnnotated", "Oct 31, 2009");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("Oct 31, 2009", binder.getBindingResult().getFieldValue("localDateAnnotated"));
+	}
+
+	@Test
+	public void testBindLocalDateAnnotatedWithError() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateAnnotated", "Oct -31, 2009");
+		binder.bind(propertyValues);
+		assertEquals(1, binder.getBindingResult().getFieldErrorCount("localDateAnnotated"));
+		assertEquals("Oct -31, 2009", binder.getBindingResult().getFieldValue("localDateAnnotated"));
+	}
+
+	@Test
+	public void testBindNestedLocalDateAnnotated() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("children[0].localDateAnnotated", "Oct 31, 2009");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("Oct 31, 2009", binder.getBindingResult().getFieldValue("children[0].localDateAnnotated"));
+	}
+
+	@Test
+	public void testBindLocalDateAnnotatedWithDirectFieldAccess() {
+		binder.initDirectFieldAccess();
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateAnnotated", "Oct 31, 2009");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("Oct 31, 2009", binder.getBindingResult().getFieldValue("localDateAnnotated"));
+	}
+
+	@Test
+	public void testBindLocalDateAnnotatedWithDirectFieldAccessAndError() {
+		binder.initDirectFieldAccess();
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateAnnotated", "Oct -31, 2009");
+		binder.bind(propertyValues);
+		assertEquals(1, binder.getBindingResult().getFieldErrorCount("localDateAnnotated"));
+		assertEquals("Oct -31, 2009", binder.getBindingResult().getFieldValue("localDateAnnotated"));
+	}
+
+	@Test
+	public void testBindLocalTime() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localTime", "12:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("12:00 PM", binder.getBindingResult().getFieldValue("localTime"));
+	}
+
+	@Test
+	public void testBindLocalTimeWithSpecificStyle() throws Exception {
+		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
+		registrar.setTimeStyle(FormatStyle.MEDIUM);
+		setUp(registrar);
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localTime", "12:00:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("12:00:00 PM", binder.getBindingResult().getFieldValue("localTime"));
+	}
+
+	@Test
+	public void testBindLocalTimeWithSpecificFormatter() throws Exception {
+		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
+		registrar.setTimeFormatter(DateTimeFormatter.ofPattern("HHmmss"));
+		setUp(registrar);
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localTime", "130000");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("130000", binder.getBindingResult().getFieldValue("localTime"));
+	}
+
+	@Test
+	public void testBindLocalTimeAnnotated() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localTimeAnnotated", "12:00:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("12:00:00 PM", binder.getBindingResult().getFieldValue("localTimeAnnotated"));
+	}
+
+	@Test
+	public void testBindLocalDateTime() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateTime", "10/31/09 12:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("10/31/09 12:00 PM", binder.getBindingResult().getFieldValue("localDateTime"));
+	}
+
+	@Test
+	public void testBindLocalDateTimeAnnotated() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateTimeAnnotated", "Oct 31, 2009 12:00:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("Oct 31, 2009 12:00:00 PM", binder.getBindingResult().getFieldValue("localDateTimeAnnotated"));
+	}
+
+	@Test
+	public void testBindDateTimeWithSpecificStyle() throws Exception {
+		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
+		registrar.setDateTimeStyle(FormatStyle.MEDIUM);
+		setUp(registrar);
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("localDateTime", "Oct 31, 2009 12:00:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("Oct 31, 2009 12:00:00 PM", binder.getBindingResult().getFieldValue("localDateTime"));
+		Method testMethod = LocalVariableTableParameterNameDiscoverer.class.getMethod("getParameterNames", Method.class);
+		System.out.println(testMethod.getParameters()[0].getName());
+		System.out.println(new LocalVariableTableParameterNameDiscoverer().getParameterNames(testMethod)[0]);
+	}
+
+	@Test
+	public void testBindDateTimeAnnotatedPattern() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("dateTimeAnnotatedPattern", "10/31/09 12:00 PM");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("10/31/09 12:00 PM", binder.getBindingResult().getFieldValue("dateTimeAnnotatedPattern"));
+	}
+
+	@Test
+	public void testBindISODate() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("isoDate", "2009-10-31");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("2009-10-31", binder.getBindingResult().getFieldValue("isoDate"));
+	}
+
+	@Test
+	public void testBindISOTime() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("isoTime", "12:00:00.000-05:00");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("12:00:00", binder.getBindingResult().getFieldValue("isoTime"));
+	}
+
+	@Test
+	public void testBindISODateTime() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("isoDateTime", "2009-10-31T12:00:00.000Z");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("2009-10-31T12:00:00", binder.getBindingResult().getFieldValue("isoDateTime"));
+	}
+
+	@Test
+	public void testBindInstant() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("instant", "2009-10-31T12:00:00.000Z");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertEquals("2009-10-31T12:00Z", binder.getBindingResult().getFieldValue("instant"));
+	}
+
+
+	@SuppressWarnings("unused")
+	public static class DateTimeBean {
+
+		private LocalDate localDate;
+
+		@DateTimeFormat(style="M-")
+		private LocalDate localDateAnnotated;
+
+		private LocalTime localTime;
+
+		@DateTimeFormat(style="-M")
+		private LocalTime localTimeAnnotated;
+
+		private LocalDateTime localDateTime;
+
+		@DateTimeFormat(style="MM")
+		private LocalDateTime localDateTimeAnnotated;
+
+		@DateTimeFormat(pattern="M/d/yy h:mm a")
+		private LocalDateTime dateTimeAnnotatedPattern;
+
+		@DateTimeFormat(iso=ISO.DATE)
+		private LocalDate isoDate;
+
+		@DateTimeFormat(iso=ISO.TIME)
+		private LocalTime isoTime;
+
+		@DateTimeFormat(iso=ISO.DATE_TIME)
+		private LocalDateTime isoDateTime;
+
+		private Instant instant;
+
+		private final List<DateTimeBean> children = new ArrayList<DateTimeBean>();
+
+		public LocalDate getLocalDate() {
+			return localDate;
+		}
+
+		public void setLocalDate(LocalDate localDate) {
+			this.localDate = localDate;
+		}
+
+		public LocalDate getLocalDateAnnotated() {
+			return localDateAnnotated;
+		}
+
+		public void setLocalDateAnnotated(LocalDate localDateAnnotated) {
+			this.localDateAnnotated = localDateAnnotated;
+		}
+
+		public LocalTime getLocalTime() {
+			return localTime;
+		}
+
+		public void setLocalTime(LocalTime localTime) {
+			this.localTime = localTime;
+		}
+
+		public LocalTime getLocalTimeAnnotated() {
+			return localTimeAnnotated;
+		}
+
+		public void setLocalTimeAnnotated(LocalTime localTimeAnnotated) {
+			this.localTimeAnnotated = localTimeAnnotated;
+		}
+
+		public LocalDateTime getLocalDateTime() {
+			return localDateTime;
+		}
+
+		public void setLocalDateTime(LocalDateTime localDateTime) {
+			this.localDateTime = localDateTime;
+		}
+
+		public LocalDateTime getLocalDateTimeAnnotated() {
+			return localDateTimeAnnotated;
+		}
+
+		public void setLocalDateTimeAnnotated(LocalDateTime localDateTimeAnnotated) {
+			this.localDateTimeAnnotated = localDateTimeAnnotated;
+		}
+
+		public LocalDateTime getDateTimeAnnotatedPattern() {
+			return dateTimeAnnotatedPattern;
+		}
+
+		public void setDateTimeAnnotatedPattern(LocalDateTime dateTimeAnnotatedPattern) {
+			this.dateTimeAnnotatedPattern = dateTimeAnnotatedPattern;
+		}
+
+		public LocalDate getIsoDate() {
+			return isoDate;
+		}
+
+		public void setIsoDate(LocalDate isoDate) {
+			this.isoDate = isoDate;
+		}
+
+		public LocalTime getIsoTime() {
+			return isoTime;
+		}
+
+		public void setIsoTime(LocalTime isoTime) {
+			this.isoTime = isoTime;
+		}
+
+		public LocalDateTime getIsoDateTime() {
+			return isoDateTime;
+		}
+
+		public void setIsoDateTime(LocalDateTime isoDateTime) {
+			this.isoDateTime = isoDateTime;
+		}
+
+		public Instant getInstant() {
+			return instant;
+		}
+
+		public void setInstant(Instant instant) {
+			this.instant = instant;
+		}
+
+		public List<DateTimeBean> getChildren() {
+			return children;
+		}
+	}
+
+}