如何在 Spring Boot 控制器中检索查询参数？

Question

我正在使用 Spring Boot 开发一个项目。我有一个接受 GET 请求的控制器。

目前我正在接受对以下类型 URL 的请求：

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

但我想接受使用查询参数的请求：

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

这是我的控制器的代码：

@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;
}

Answer 1

在同一端点接受路径变量和查询参数：

@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;
    }

网址如下：http://localhost:8080/hello/testUser?city=Pune&Pin=411058&state=Maha

Answer 2

在同一个/user 端点中同时接受@PathVariable 和@RequestParam：

@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);
    }
}

使用 curl 进行测试：

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

Answer 3

在 Spring boot: 2.1.6 中，你可以像下面这样使用：

    @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 是来自 Swagger api 的注解，用于记录 api。

Answer 4

使用 @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;
}

Answer 5

虽然 afraisse 接受的答案在使用 @RequestParam 方面是绝对正确的，但我会进一步建议使用 Optional，因为您不能始终确保使用正确的参数。此外，如果您需要 Integer 或 Long，只需使用该数据类型即可避免稍后在 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 ....
}

Answer 6

我也对此感兴趣，并在 Spring Boot 站点上看到了一些示例。

   // 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