How Can I Bind Complex Objects from GET Request Parameters in Spring MVC?

Parsing Complex Objects from GET @RequestParam in Spring MVC

Consider a scenario where you need to implement a filter form in a page that queries a table. The filter criteria is submitted to a controller action through a GET request, typically in the format: http://foo.com/system/controller/action?page=1&prop1=x&prop2=y&prop3=z.

To handle such scenarios, Spring MVC typically requires you to define a controller method with multiple @RequestParam parameters to retrieve each property individually:

@RequestMapping(value = "/action")
public @ResponseBody List<MyObject> myAction(
    @RequestParam(value = "page", required = false) int page,
    @RequestParam(value = "prop1", required = false) String prop1,
    @RequestParam(value = "prop2", required = false) String prop2,
    @RequestParam(value = "prop3", required = false) String prop3) { ... }

Suppose you have defined a MyObject class with properties prop1, prop2, and prop3. To simplify the parameter handling, you may desire to bind all the request properties directly to an instance of MyObject.

@RequestMapping(value = "/action")
public @ResponseBody List<MyObject> myAction(
    @RequestParam(value = "page", required = false) int page,
    MyObject myObject) { ... }

Can Binding to Complex Objects be Achieved?

Yes, it is possible to bind request parameters to complex objects using Spring MVC.

How to Bind to Complex Objects

To achieve this binding, simply remove the @RequestParam annotation from the object parameter:

@RequestMapping(value = "/action")
public @ResponseBody List<MyObject> myAction(
    @RequestParam(value = "page", required = false) int page,
    MyObject myObject) { ... }

With this modification, Spring MVC will automatically bind the request parameter values to the corresponding properties of the MyObject instance.

The above is the detailed content of How Can I Bind Complex Objects from GET Request Parameters in Spring MVC?. For more information, please follow other related articles on the PHP Chinese website!