Jak pobrać parametry zapytania w Spring Boot?

122

Rozwijam projekt przy użyciu Spring Boot. Mam kontroler, który akceptuje żądania GET .

Obecnie akceptuję żądania na następujące rodzaje adresów URL:

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

ale chcę akceptować żądania przy użyciu parametrów zapytania :

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

Oto kod mojego kontrolera:

@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;
}
Mehandi Hassan
źródło
7
@RequestParam(dobry punkt wyjścia: oficjalny przewodnik )
kryger

Odpowiedzi:

198

Użyj @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;
}
afraisse
źródło
1
jaki jest adres URL tej metody, możesz powiedzieć? Co powinienem zmienić
Mehandi Hassan
przepraszam stary, ten adres URL nie działa localhost: 8888 / użytkownik? data = 001
Wprowadziłem
3
Usuń wartość = „/” z adnotacji mapowania żądania. Przy okazji to naprawdę kiepski projekt. Jeśli masz zamiar uzyskać dostęp do elementu dla użytkownika, resztą będzie użytkownik / items / {itemId} .
afraisse
18
Używanie @RequestParam as public @ResponseBody item getitem(@RequestParam("data") String itemid){wymaga, aby parametr zapytania danych był zawsze obecny. Zamiast tego, jeśli użyjesz go w ten sposób public @ResponseBody item getitem(@RequestParam Map<String, String> queryParameters){, spowoduje to, że dane będą opcjonalne
samsri
3
... Powinienem był zamieścić odpowiedź zamiast zostawiać komentarz pod pytaniem! : -o
kryger
9

Chociaż zaakceptowana przez afraisse odpowiedź jest absolutnie poprawna pod względem użycia @RequestParam, sugerowałbym ponadto użycie opcjonalnego <>, ponieważ nie zawsze można zapewnić, że używany jest właściwy parametr. Ponadto, jeśli potrzebujesz liczby całkowitej lub długiej, po prostu użyj tego typu danych, aby uniknąć późniejszego rzutowania typów w 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 ....
}
Andrew Grothe
źródło
skąd masz opcjonalne?
Joey Gough
1
@JoeyGough wprowadzony w Javie 8. docs.oracle.com/javase/8/docs/api/java/util/Optional.html
Andrew Grothe,
2

W Spring boot: 2.1.6, możesz użyć jak poniżej:

    @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 to adnotacja pochodząca z interfejsu API Swagger, służy do dokumentowania interfejsu API.

Shashank
źródło
required = truedomyślnie
DV82XL
0

To też mnie zainteresowało i znalazłem kilka przykładów na stronie 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);
    }

Zobacz także tutaj

TKPhillyBurb
źródło