Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I use @Valid with Spring MVC's @RequestBody parameters?

Tags:

I'm having an issue with using @Valid on a parameter to a handler method on my @Controller. My code looks like this:

@RequestMapping(value=BIBBLE_BOBBLE_URI_PATTERN + "/widgets", method=RequestMethod.POST)
@ResponseBody
@ResponseStatus(HttpStatus.CREATED)
public Widget saveNewWidget(
        @PathVariable final String username,
        @PathVariable final String bibbleBobbleName,
        @Valid @RequestBody final Widget widget,
        final BindingResult results,
        final HttpServletRequest request,
        final HttpServletResponse response)

where Widget is the class for one of my domain objects. I'm using the @RequestBody annotation to indicate that the payload of the request maps to widget (in my tests, the requests are JSON, though Jackson is on my classpath so I could also use XML).

As you can see, the BindingResult parameter follows directly after the Widget parameter, but I get the following error:

java.lang.IllegalStateException: Errors/BindingResult argument declared without preceding model attribute. Check your handler method signature!

How do I apply the @Valid annotation to a @RequestBody parameter and then get the results?

P.S. I'm using annotation-driven to handle wiring up the controllers, do content-negotiation, etc.

like image 436
Hank Gay Avatar asked May 25 '11 18:05

Hank Gay


People also ask

What is the use of @valid annotation in Spring boot?

The @Valid annotation ensures the validation of the whole object. Importantly, it performs the validation of the whole object graph. However, this creates issues for scenarios needing only partial validation. On the other hand, we can use @Validated for group validation, including the above partial validation.

Where can we use @valid annotation?

Use @Valid on Complex Types If the Input class contains a field with another complex type that should be validated, this field, too, needs to be annotated with @Valid .

How do you create a particular field in a RequestBody as mandatory?

Basically you will need to add a group attribute value to your annotation constraints. Something like: class ProfileModel { @NotEmpty @Email private String emailAddress; @Size(max=30) private String firstName; @Email(groups= UpdateEmail.


2 Answers

Are you using Spring 3.1? It is a newly added feature in Spring version 3.1. Please see Validation For @RequestBody Method Arguments

like image 104
Ritesh Avatar answered Oct 09 '22 11:10

Ritesh


This is an issue in spring 3.0 and it is fixed in 3.1 M2.

https://jira.springsource.org/browse/SPR-6709

If you are using spring 3.0, based on some threads and extensive reading, here is the best approach for this problem. An aspect oriented approach so that we can back out when you upgrade it to the version of spring which fixes this issue.

An aspect which intercepts calls to method which uses @RequestMapping annotation and for each parameter which has @Valid annotation on it, call the corresponding validator in the aspect.

like image 32
Chandra Avatar answered Oct 09 '22 11:10

Chandra