Spring map GET request parameters to POJO automatically

Question

I have method in my REST controller that contains a lot of parameters. For example:

@RequestMapping(value = "/getItem", method = RequestMethod.GET)
public ServiceRequest<List<SomeModel>> getClaimStatuses(
        @RequestParam(value = "param1", required = true) List<String> param1,
        @RequestParam(value = "param2", required = false) String param2,
        @RequestParam(value = "param3", required = false) List<String> param3,
        @RequestParam(value = "param4", required = false) List<String> param4,
        @RequestParam(value = "param5", required = false) List<String> param5) {
    // ......
}

and I would like to map all GET request parameters to a POJO object like:

public class RequestParamsModel {

   public RequestParamsModel() {

   }

   public List<String> param1;
   public String param2;
   public List<String> param3;
   public String param4;
   public String param5;
}

I need something like we can do using @RequestBody in REST Controller.

Is it possible to do in Spring 3.x ?

Thanks!

http://stackoverflow.com/a/16942352/4074715 – Predrag Maric Oct 28 '14 at 15:39 — Predrag Maric, Oct 28 '14 at 15:39

score 33 · Accepted Answer · edited Jan 18 '19 at 07:22

33

Possible and easy, make sure that your bean has proper accessors for the fields. You can add proper validation per property, just make sure that you have the proper jars in place. In terms of code it would be something like

import javax.validation.constraints.NotNull;

public class RequestParamsModel {

    public RequestParamsModel() {}

    private List<String> param1;
    private String param2;
    private List<String> param3;
    private String param4;
    private String param5;

    @NotNull
    public List<String> getParam1() {
        return param1;
    }
    //  ...
}

The controller method would be:

import javax.validation.Valid;

@RequestMapping(value = "/getItem", method = RequestMethod.GET)
public ServiceRequest<List<SomeModel>> getClaimStatuses(@Valid RequestParamsModel model) {
    // ...
}

And the request, something like:

/getItem?param1=list1,list2&param2=ok

edited Jan 18 '19 at 07:22

laffuste

16,287
8
84
91

answered Oct 28 '14 at 15:53

Master Slave

27,771
4
57
55

What is the package for the NotNull annotation? – Kevin Guanche Darias Dec 09 '16 at 09:48
1

its `javax.validation.constraints.NotNull` – Master Slave Dec 09 '16 at 12:41
Thread is probably dead but I got a question. How does the spring know to map the request params to the class, in this case, RequestParamsModel if we did not use @RequestParam annotation here? – Kalyan M Jul 18 '19 at 12:10
@KalyanM Not sure, but I guess it works by convention – Pablo Lozano Jan 13 '20 at 16:05

score 2 · Answer 2 · answered Oct 28 '14 at 15:54

2

Are you trying to do

@RequestMapping(value = "/getItem", method = RequestMethod.GET)
public ServiceRequest<List<SomeModel>> getClaimStatuses(@ModelAttribute RequestParamsModel requestParamModel) {
...
}

answered Oct 28 '14 at 15:54

Serge Ballesta

143,923
11
122
252

Yes. I have got empty requestParamModel. As I understood ModelAttribute is used for response model. – IgorOK Oct 28 '14 at 16:03
it works with ModelAttribute annotation and without, but RequestParamsModel must contain setter methods. Thanks! – IgorOK Oct 28 '14 at 16:48

Spring map GET request parameters to POJO automatically

2 Answers2

Linked