How to globally configure `@DateTimeFormat` pattern in Spring Boot?

Question

Im my Spring Boot application, I have some controllers that accept a date as query parameter:

@RestController
public class MyController {

  @GetMapping
  public ResponseEntity<?> getDataByDate(
      @RequestParam(value = "date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
      final LocalDate date) {
    return ResponseEntity.ok();
  }
}

This works well, and I can even mark the parameter as optional using @RequestParam(value = "date", required = false) and then use an Optional<LocalDate>. Spring will handle all this and pass an empty Optional when the parameter is missing.

Since I have several controllers using dates as query parameters, I want to configure this behavior for all LocalDate query parameters. I have tried the spring.mvc.date-pattern property, but it only seems to work for java.util.Date.

So after searching the web, the best I came up with is a ControllerAdvice I adopted from this answer. The problem with this solution is, that is can not handle Optional<LocalDate> anymore. It feels like this is the wrong way to configure the behavior in Spring Boot.

So my question is: How do I globally configure the pattern for LocalDate used as query parameters in an idiomatic way in Spring Boot?

That looks like the way to do it globally using a ControllerAdvice. See also https://stackoverflow.com/questions/40644368/setting-default-datetimeformat-annotation-in-spring. — selvinsource, Aug 01 '17 at 15:03
As I said, this solution does not handle `Optional` and it does not feel idiomatic to me. There should be some configuration property to easily set this. — britter, Aug 01 '17 at 15:23
It looks like this it not easily possible. See https://github.com/spring-projects/spring-boot/issues/5523 — britter, Aug 01 '17 at 16:35
so you could implement `org.springframework.core.convert.converter.GenericConverter` and doing the conversion yourself — joshiste, Aug 01 '17 at 20:19

score 11 · Accepted Answer · answered Aug 02 '17 at 06:52

This is currently not easily possible (e.g. by setting a simple configuration property), see #5523. The best solution I found so far is to register a Formatter<LocalDate>. This will also work with optional parameters modeled as Optional<LocalDate>:

  @Bean
  public Formatter<LocalDate> localDateFormatter() {
    return new Formatter<LocalDate>() {
      @Override
      public LocalDate parse(String text, Locale locale) throws ParseException {
        return LocalDate.parse(text, DateTimeFormatter.ISO_DATE);
      }

      @Override
      public String print(LocalDate object, Locale locale) {
        return DateTimeFormatter.ISO_DATE.format(object);
      }
    };
  }

It may become possible to set this using a configuration property when my proposal in #9930 has been merged.

I've written a blog post about this: https://blog.codecentric.de/en/2017/08/parsing-of-localdate-query-parameters-in-spring-boot/ — britter, Aug 07 '17 at 07:19

Alexey Stepanov · Answer 2 · 2021-08-27T10:26:03.003

3

You can use spring.mvc.format.date, spring.mvc.format.time and spring.mvc.format.date-time

For example:
spring.mvc.format.time=HH:mm:ss
spring.mvc.format.date=iso
spring.mvc.format.date-time=iso-offset

as in the example above, you can use shortcuts iso аnd iso-offset from spring boot 2.4.1

edited Aug 27 '21 at 10:26

answered Dec 28 '20 at 12:49

Alexey Stepanov

561
6
15

Grigory Kislin · Answer 3 · 2018-09-21T19:57:05.910

2

@britter: thanks.

spring.mvc.date-format= # Date format to use. For instance, dd/MM/yyyy works fine with Spring Boot 2.1.0.x

See # SPRING MVC (WebMvcProperties) properties.

UPDATE: But it doen't work for Spring Data Rest params ...

edited Sep 21 '18 at 19:57

answered Sep 20 '18 at 13:01

Grigory Kislin

16,647
10
125
197

How to globally configure `@DateTimeFormat` pattern in Spring Boot?

3 Answers3

Linked