Spring Bootの@JsonComponentでLocalDateTime型の値を受け取ろうとしてBindExceptionが発生する

Question

前提・実現したいこと

Spring Bootで、クエリストリングで受け取った日時の値をLocalDateTime型で受け取ろうとしていますが、値を受け取れず、BindExceptionが発生します。

同じように実装しているLocalDate型の変数は日付を受け取ることができます。

LocalDateTimeの場合は特別なやり方があるのでしょうか。

発生している問題・エラーメッセージ

アクセスしたURL: http://localhost:9080/?dateTime=2016/05/11%2012:34:56

org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'sampleParameter' on field 'dateTime': rejected value [2016/05/11 12:34:56]; codes [typeMismatch.sampleParameter.dateTime,typeMismatch.dateTime,typeMismatch.java.time.LocalDateTime,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [sampleParameter.dateTime,dateTime]; arguments []; default message [dateTime]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'java.time.LocalDateTime' for property 'dateTime'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [java.time.LocalDateTime] for value '2016/05/11 12:34:56'; nested exception is java.lang.IllegalArgumentException: Parse attempt failed for value [2016/05/11 12:34:56]]
	at org.springframework.web.method.annotation.ModelAttributeMethodProcessor.resolveArgument(ModelAttributeMethodProcessor.java:164) ~[spring-web-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:126) ~[spring-web-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:167) ~[spring-web-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:134) ~[spring-web-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:104) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:892) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:797) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1039) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:942) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1005) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:897) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:634) ~[tomcat-embed-core-9.0.19.jar:9.0.19]
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:882) ~[spring-webmvc-5.1.7.RELEASE.jar:5.1.7.RELEASE]
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:741) ~[tomcat-embed-core-9.0.19.jar:9.0.19]
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231) ~[tomcat-embed-core-9.0.19.jar:9.0.19]
// 中略
	at java.base/java.lang.Thread.run(Thread.java:834) ~[na:na]

2019-08-15 15:51:15.354  WARN 7076 --- [nio-9080-exec-6] .m.m.a.ExceptionHandlerExceptionResolver : Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'sampleParameter' on field 'dateTime': rejected value [2016/05/11 12:34:56]; codes [typeMismatch.sampleParameter.dateTime,typeMismatch.dateTime,typeMismatch.java.time.LocalDateTime,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [sampleParameter.dateTime,dateTime]; arguments []; default message [dateTime]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'java.time.LocalDateTime' for property 'dateTime'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [java.time.LocalDateTime] for value '2016/05/11 12:34:56'; nested exception is java.lang.IllegalArgumentException: Parse attempt failed for value [2016/05/11 12:34:56]]]

該当のソースコード

JsonComponents.java

package sample.components;

import java.io.IOException;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

import org.springframework.boot.jackson.JsonComponent;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

@JsonComponent
public class JsonComponents {

	//
	// LocalDateTime
	//

	static final DateTimeFormatter dateTimePattern = DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss");

	public static class LocalDateTimeJsonSerializer extends JsonSerializer<LocalDateTime> {

		@Override
		public void serialize(LocalDateTime value, JsonGenerator generator, SerializerProvider serializers)
				throws IOException {

			if (value == null) {
				generator.writeNull();
			} else {
				generator.writeString(dateTimePattern.format(value));
			}
		}
	}

	public static class LocalDateTimeJsonDeserializer extends JsonDeserializer<LocalDateTime> {

		@Override
		public LocalDateTime deserialize(JsonParser parser, DeserializationContext context)
				throws IOException, JsonProcessingException {

			var value = parser.getValueAsString();

			return value == null ? null : LocalDateTime.parse(value, dateTimePattern);
		}
	}

	//
	// LocalDate
	//

	static final DateTimeFormatter datePattern = DateTimeFormatter.ofPattern("yyyy/MM/dd");

	public static class LocalDateJsonSerializer extends JsonSerializer<LocalDate> {

		@Override
		public void serialize(LocalDate value, JsonGenerator generator, SerializerProvider serializers)
				throws IOException {

			if (value == null) {
				generator.writeNull();
			} else {
				generator.writeString(datePattern.format(value));
			}
		}
	}

	public static class LocalDateJsonDeserializer extends JsonDeserializer<LocalDate> {

		@Override
		public LocalDate deserialize(JsonParser parser, DeserializationContext context)
				throws IOException, JsonProcessingException {

			var value = parser.getValueAsString();

			return value == null ? null : LocalDate.parse(value, datePattern);
		}
	}
}

SampleController.java

package sample.controllers;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.LinkedHashMap;
import java.util.Map;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RestController;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;

@RestController
@Slf4j
public class SampleController {
	@GetMapping(path = "/")
	public Map<String, Object> getContents(@ModelAttribute SampleParameter param) {

		log.info("param={}", param);

		var responseBody = new LinkedHashMap<String, Object>();
		responseBody.put("succeeded", true);
		return responseBody;
	}

	@Data
	public static class SampleParameter {
		LocalDateTime dateTime;
		LocalDate date;
	}
}

試したこと

LocalDate型の変数dateもLocalDateTimeと同じように書いていますが、dateの方は問題なく値を受け取れます。

日付を受け取るときのURL: http://localhost:9080/?date=2016/05/11

そのときのレスポンスボディ {"succeeded":true}

補足情報（FW/ツールのバージョンなど）

Spring Boot 2.1.5.RELEASE, Java 11

Answer 1

同じように実装しているLocalDate型の変数は日付を受け取ることができます。

とのことですが、LocalDate型のリクエストパラメータを受け取るために特別な実装は不要と思います。確認するために一度JsonComponentsを無効（コメントアウト）にして、LocalDate型が受け取れるか確認してください。
（リクエストボディにJSONフォーマットのデータを受け取る場合は必要かもしれませんが、確認していません）

次にLocalDateTime型のリクエストパラメータですが、こちらは受け取るフィールドに@DateTimeFormatアノテーションを付与することで受け取ることができるようになると思います。

import org.springframework.format.annotation.DateTimeFormat;

@Data
static class SampleParameter {
  @DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss")
  LocalDateTime dateTime;
  LocalDate date;
}

いちいちLocalDateTime型のフィールドにアノテーションを付与したくないという場合、WebMvcConfigurerを実装した設定クラスでカスタマイズできます。
こうすることでフィールド毎に日付パターンを指定する必要はなくなります。

@Configuration
public class Config implements WebMvcConfigurer {

  @Override
  public void addFormatters(FormatterRegistry registry) {
    DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
    registrar.setDateTimeFormatter(DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss"));
    registrar.registerFormatters(registry);
  }

}

なお、上記のように日付型データのパターンを決めてしまうと、例えば"2016-05-11 17:25:49"のようなデータを受け取ることができなくなりますのでご留意ください。

Comments

[KakeiAkihiko]

LocalDateについてご指摘の通りでした。また、LocalDateTimeについても`@DateTimeFormat`で受け取ることができました。ご回答ありがとうございました。