How do I retrieve query parameters in a Spring Boot controller?

Question

I am developing a project using Spring Boot. I've a controller which accepts GET requests.

Currently I'm accepting requests to the following kind of URLs:

http://localhost:8888/user/data/002

but I want to accept requests using query parameters:

http://localhost:8888/user?data=002

Here's the code of my controller:

@RequestMapping(value="/data/{itemid}", method = RequestMethod.GET)
public @ResponseBody
item getitem(@PathVariable("itemid") String itemid) {   
    item i = itemDao.findOne(itemid);              
    String itemname = i.getItemname();
    String price = i.getPrice();
    return i;
}

@RequestParam (good starting point: the official guide)

kryger
– kryger

2015-08-25 10:45:26 +00:00
Commented Aug 25, 2015 at 10:45 — kryger
– kryger, Commented Aug 25, 2015 at 10:45

my- · Accepted Answer · 2020-02-16 20:48:51Z

317

Use @RequestParam

@RequestMapping(value="user", method = RequestMethod.GET)
public @ResponseBody Item getItem(@RequestParam("data") String itemid){

    Item i = itemDao.findOne(itemid);              
    String itemName = i.getItemName();
    String price = i.getPrice();
    return i;
}

edited Feb 16, 2020 at 20:48

my-

64610 silver badges17 bronze badges

answered Aug 25, 2015 at 11:11

afraisse

3,5921 gold badge15 silver badges13 bronze badges

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

7 Comments

Mehandi Hassan Over a year ago

then what is the URL of this method can you please tell ? What should i have to change

Mehandi Hassan Over a year ago

sorry bro this URL is not working localhost:8888/user?data=001 I have enter this URL

afraisse Over a year ago

Remove value="/" from the request mapping annotation. Btw this is really poor design. If you're going to access an item for a user then the rest way would be user/items/{itemId}.

samsri Over a year ago

Using @RequestParam as public @ResponseBody item getitem(@RequestParam("data") String itemid){ requires data query parameter to be always present. Instead if you use it this way public @ResponseBody item getitem(@RequestParam Map<String, String> queryParameters){ , it makes data to be optional

Leponzo Over a year ago

@samsri, or just use @RequestParam(name = "data", required = false)

|

my- · Accepted Answer · 2020-02-16 20:16:08Z

35

While the accepted answer by afraisse is absolutely correct in terms of using @RequestParam, I would further suggest to use an Optional<> as you cannot always ensure the right parameter is used. Also, if you need an Integer or Long just use that data type to avoid casting types later on in the DAO.

@RequestMapping(value="/data", method = RequestMethod.GET)
public @ResponseBody
Item getItem(@RequestParam("itemid") Optional<Integer> itemid) { 
    if( itemid.isPresent()){
         Item i = itemDao.findOne(itemid.get());              
         return i;
     } else ....
}

edited Feb 16, 2020 at 20:16

my-

64610 silver badges17 bronze badges

answered May 19, 2019 at 23:31

Andrew Grothe

2,3941 gold badge34 silver badges56 bronze badges

6 Comments

Joey Gough Over a year ago

where did you get Optional from?

Andrew Grothe Over a year ago

@JoeyGough introduced in Java 8. docs.oracle.com/javase/8/docs/api/java/util/Optional.html

slim Over a year ago

It's a bad idea to put Optional in parameter. Don't use Optional in parameters. For this problem, you can use required = false.

slim Over a year ago

@hemanth5636, because you can have 3 possible values and not 2 ... (rules.sonarsource.com/java/RSPEC-3553)

Jose Martinez Over a year ago

But in this case Spring MVC will always populate it. So it will never be null.

|

daparic · Accepted Answer · 2020-11-11 09:52:00Z

21

To accept both @PathVariable and @RequestParam in the same /user endpoint:

@GetMapping(path = {"/user", "/user/{data}"})
public void user(@PathVariable(required=false,name="data") String data,
                 @RequestParam(required=false) Map<String,String> qparams) {
    qparams.forEach((a,b) -> {
        System.out.println(String.format("%s -> %s",a,b));
    }
  
    if (data != null) {
        System.out.println(data);
    }
}

Testing with curl:

curl 'http://localhost:8080/user/books'
curl 'http://localhost:8080/user?book=ofdreams&name=nietzsche'

answered Nov 11, 2020 at 9:52

daparic

4,6222 gold badges47 silver badges46 bronze badges

2 Comments

ansh sachdeva Over a year ago

what if you want to pass negatives, like &name!=nietzsche ?

Ismail Yavuz Over a year ago

You can simply introduce another request parameter and put the unwanted name there :)

satish gupta · Accepted Answer · 2021-04-20 18:26:39Z

9

To accept both Path Variable and query Param in the same endpoint:

@RequestMapping(value = "/hello/{name}", method = RequestMethod.POST)
    public String sayHi(
            @PathVariable("name") String name, 
            @RequestBody Topic topic,
            //@RequestParam(required = false, name = "s") String s, 
            @RequestParam Map<String, String> req) {
        
        return "Hi "+name +" Topic : "+ topic+" RequestParams : "+req;
    }

URL looks like : http://localhost:8080/hello/testUser?city=Pune&Pin=411058&state=Maha

answered Apr 20, 2021 at 18:26

satish gupta

911 silver badge1 bronze badge

Comments

Shashank · Accepted Answer · 2020-07-27 03:17:24Z

5

In Spring boot: 2.1.6, you can use like below:

    @GetMapping("/orders")
    @ApiOperation(value = "retrieve orders", response = OrderResponse.class, responseContainer = "List")
    public List<OrderResponse> getOrders(
            @RequestParam(value = "creationDateTimeFrom", required = true) String creationDateTimeFrom,
            @RequestParam(value = "creationDateTimeTo", required = true) String creationDateTimeTo,
            @RequestParam(value = "location_id", required = true) String location_id) {

        // TODO...

        return response;

@ApiOperation is an annotation that comes from Swagger api, It is used for documenting the apis.

answered Jul 27, 2020 at 3:17

Shashank

7578 silver badges16 bronze badges

1 Comment

DV82XL Over a year ago

required = true by default

TKPhillyBurb · Accepted Answer · 2019-04-09 14:19:07Z

I was interested in this as well and came across some examples on the Spring Boot site.

   // get with query string parameters e.g. /system/resource?id="rtze1cd2"&person="sam smith" 
// so below the first query parameter id is the variable and name is the variable
// id is shown below as a RequestParam
    @GetMapping("/system/resource")
    // this is for swagger docs
    @ApiOperation(value = "Get the resource identified by id and person")
    ResponseEntity<?> getSomeResourceWithParameters(@RequestParam String id, @RequestParam("person") String name) {

        InterestingResource resource = getMyInterestingResourc(id, name);
        logger.info("Request to get an id of "+id+" with a name of person: "+name);

        return new ResponseEntity<Object>(resource, HttpStatus.OK);
    }

See here also

Procrastinator · Accepted Answer · 2024-04-30 06:07:00Z

0

When using the @GetMapping annotation, you typically use @RequestParam in the request instead of @RequestBody. If you want to use @RequestBody, you should use the @PostMapping annotation in the API method.

edited Apr 30, 2024 at 6:07

Procrastinator

2,67445 gold badges31 silver badges37 bronze badges

answered Apr 28, 2024 at 3:56

Devang Jadav

1

Comments

Orubel · Accepted Answer · 2025-04-27 17:41:42Z

0

Almost all of these require ANNOTATIONS.

For a manual/programmatic approach, use the following:

LinkedHashMap<String, String> post = parsePutParams(IOUtils.toString(request.getInputStream(), StandardCharsets.UTF_8))

answered Apr 27 at 17:41

Orubel

3514 silver badges16 bronze badges

Collectives™ on Stack Overflow

How do I retrieve query parameters in a Spring Boot controller?

8 Answers 8

7 Comments

6 Comments

2 Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

7 Comments

6 Comments

2 Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related