Can Spring MVC handle multivalue query parameter?

Question

Having this http://myserver/find-by-phones?phone=123&phone=345 request, is it possible to handle with something like this:

@Controller
public class Controller{
    @RequestMapping("/find-by-phones")
    public String find(List<String> phones){
       ...
    }
}

Can Spring MVC some how convert multi-value param phones to a list of Strings (or other objects?

Thanks.

Alex

find(@RequestParam(required=false, value="phone") List<String> phones) should work. This works for url?phone=123&phone=345 and also for url?phone=123,345 and for null parameter value like url or url?phone= I hope this helps anyone looking for this solution :) — Diablo
– Diablo, Commented Mar 16, 2016 at 14:45
If you have multiple parameters all of which can have multiple values, use a MultiValueMap. See stackoverflow.com/questions/22398892/… — chrisinmtown
– chrisinmtown, Commented Jan 16, 2018 at 19:58

fmucar · Accepted Answer · 2018-10-24 16:18:53Z

92

"Arrays" in @RequestParam are used for binding several parameters of the same name:

phone=val1&phone=val2&phone=val3

-

public String method(@RequestParam(value="phone") String[] phoneArray){
    ....
}

You can then convert it into a list using Arrays.asList(..) method

EDIT1:

As suggested by emdadul, latest version of spring can do like below as well:

public String method(@RequestParam(value="phone", required=false) List<String> phones){
    ....
}

edited Oct 24, 2018 at 16:18

answered Mar 19, 2012 at 10:33

fmucar

14.6k2 gold badges48 silver badges50 bronze badges

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

9 Comments

Bertie Over a year ago

if there is not a single param out there, will phoneArray be null or be an empty array ?

jtoberon Over a year ago

Spring can put the values directly into a list: @RequestParam(value="phone") List<String> phones. Not sure if/when this was changed, but it works in Spring 3.0.5.

Andrew Cassidy Over a year ago

@Nailgun can you set some sort of proper default parameter and generate an empty Array or do just have to handle the null? Thank you

Govinda Sakhare Over a year ago

what about form element name will it be phone[ ] or phone or phone[0],phone[1] ..... ? I have 25 mcq questions with 4 radio button for each question.

fmucar Over a year ago

Element name is going to be phone

|

Marquis Blount · Accepted Answer · 2017-12-16 08:10:33Z

11

Spring can convert the query param directly into a List or even a Set

for example:

 @RequestParam(value = "phone", required = false) List<String> phones

or

 @RequestParam(value = "phone", required = false) Set<String> phones

answered Dec 16, 2017 at 8:10

Marquis Blount

8,22510 gold badges48 silver badges68 bronze badges

Comments

mlecar · Accepted Answer · 2019-10-24 15:33:29Z

4

I had an issue with indexed querystring like

http://myserver/find-by-phones?phone[0]=123&phone[1]=345

and only handling with

MultiValueMap<String, String>

worked for me. Neither List or String[] were handling it properly.

I also tried

@RequestParam("phones[]")

but RequestParamMethodArgumentResolver is looking explicitly for phones[] ignoring indexes. So that is why I decided to let RequestParamMapMethodArgumentResolver handle it.

edited Oct 24, 2019 at 15:33

answered Oct 16, 2019 at 12:21

mlecar

8297 silver badges10 bronze badges

Collectives™ on Stack Overflow

Can Spring MVC handle multivalue query parameter?

3 Answers 3

9 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

9 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related