Regex Validation not triggering an Error in Spring Boot Controller

Question

I want my RestController to return an error when the input of date is set(required = false) but with the wrong regex(f. e. 10-2019)

  @GetMapping
  @Timed
  public ResponseEntity<ResponseBodyWrapper<List<ListData>>> getList(
     @RequestParam(name = "date", required = false) @Pattern(regexp = "[0-9]{4}-[0-9]{1,2}") String date) {
    // Logic
  }

However, the validation isnt taking place. I was expecting an error but none was thrown, the error occured later, when i tried to build a new Object with the wrong input

cassiomolin · Accepted Answer · 2019-09-17 07:36:35Z

6

Fix the validation with `@Validated`

When you want the validation to be triggered, the controller class must be annotated with @Validated:

@Validated
@RestController
public class MyController {
   ...
}

Quoting the documentation:

To be eligible for Spring-driven method validation, all target classes need to be annotated with Spring’s @Validated annotation.

Don't use `@Timed`

I find it weird the fact your controller method is annotated with @Timed. This is a test-specific annotation and it's not meant to be used in the actual code:

Test-specific annotation to indicate that a test method has to finish execution in a specified time period.

You may also want to review your dependencies and ensure they use the correct scope.

Consider `YearMonth` instead of `String`

As you seem to be receiving a year and month value in your controller method, it's better to use YearMonth instead of String:

A year-month in the ISO-8601 calendar system, such as 2007-12.

Your controller method can be like:

@GetMapping
public ResponseEntity<Foo> getList(@RequestParam(name = "date", required = false) YearMonth date) {
    ...
}

edited Sep 17, 2019 at 7:36

answered Sep 12, 2019 at 10:28

cassiomolin

133k36 gold badges301 silver badges383 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Felpower Over a year ago

Thank you @Validated worked We are not using org.springframework.test.annotation@Timed for testing we are using io.micrometer.core.annotation@Timed for our Grafana Thank you very much, we are now using YearMonth instead of String, this way it is way more reliable and reusable. Only thing, because we don't use ISO-Standard we had to implement an Pattern Converter with Regex: ^(\\d{4})-(1[0-2]|[1-9]|0[1-9])$

Tai Vu Jan 16 at 11:06

Thank you, the @Validated works for me, saved me hours of searching other configs.

Vicent Morera Orchilles · Accepted Answer · 2019-09-12 10:25:24Z

2

You need to add the @Validated annotation to the class:

@RestController
@Validated
public class myRestController{

@Timed
  public ResponseEntity<ResponseBodyWrapper<List<ListData>>> getList(
     @RequestParam(name = "date", required = false) @Pattern(regexp = "[0-9]{4}-[0-9]{1,2}") String date) {
    // Logic
  }
}

References: https://www.baeldung.com/javax-validation-method-constraints point 3.

edited Sep 12, 2019 at 10:25

answered Sep 12, 2019 at 8:48

Vicent Morera Orchilles

3442 silver badges6 bronze badges

3 Comments

Felpower Over a year ago

Does not work for me unfortunatelly, still same behavior

Vicent Morera Orchilles Over a year ago

Do you have your controller class annotated as @Validated ? Can you try with this change? As I edited on my Answer, you don't need @Valid annotation if you are using @Validated on the class

Felpower Over a year ago

Yes thank you, that was the problem, forgot the @Validated annotation

Collectives™ on Stack Overflow

Regex Validation not triggering an Error in Spring Boot Controller

2 Answers 2

Fix the validation with `@Validated`

Don't use `@Timed`

Consider `YearMonth` instead of `String`

2 Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Fix the validation with @Validated

Don't use @Timed

Consider YearMonth instead of String

2 Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related

Fix the validation with `@Validated`

Don't use `@Timed`

Consider `YearMonth` instead of `String`