Как проверить имя параметра GET запроса в Sping?

Question

[Jake Taylor]

Для маппинга GET запроса использую аннотацию @GetMapping:

@GetMapping(params = {ParameterName.SORT_BY})
    public List<GiftCertificate> findAllSorted(@RequestParam(value = ParameterName.SORT_BY) Set<ColumnName> columnNames) {

return service.findAllSorted(columnNames);
    }

ParameterName.SORT_BY - это обычный enum.

По запросу:

http://localhost:8080/gift-certificates?sort_by=name

я попадаю в данный метод, всё нормально. Но почему и по запросу, в котором имеется параметр, которого нету в маппинге:

http://localhost:8080/gift-certificates?sort_ABRAKADABRA_by=name

попадает запрос в этот метод:

@GetMapping
    public List<GiftCertificate> findAll() {
        return service.findAll();
    }

Почему и как сделать проверку параметров GET запроса?

Answer 1

[BorLaze]

Вот ешкин кот, я же тебе в предыдущем вопросе дал направление на почитать!

Еще раз - что делают декларации в твоем коде:
gift-certificates, я так понимаю, это глобальный префикс для контроллера

@GetMapping(params = {ParameterName.SORT_BY}) означает: вызови этот метод, когда урл выглядит как gift-certificates?sort_by

Когда урл не подходит, берется общий - @GetMapping - который отвечает за gift-certificates, поскольку все параметры после знака вопроса опциональны.

Если же тебе надо как-то отловить параметры с произвольными именами - тогда проштудируй вот эту статью - там как раз разобраны типичные случаи (в частности, пункт 6).

Comments

[Jake Taylor]

Да я это уже читал. Вопрос в том, почему пустая аннотация @GetMapping принимает в себя даже GET запрос с не существующими параметрами типа

http://localhost:8080/gift-certificates?sort_ABRAKADABRA_by=name

и как от этого избавиться.

[BorLaze]

я не уверен на 100%, но попробуй как-то так

@GetMapping(params = {ParameterName.SORT_BY})
// gift-certificates?sort_by=name
public List<GiftCertificate> findAll(@RequestParam(value = ParameterName.SORT_BY) Set<ColumnName> columnNames) {...}

@GetMapping
// gift-certificates
public List<GiftCertificate> findAll() {...}

@GetMapping
// gift-certificates?sort_ABRAKADABRA_by=name
public List<GiftCertificate> findAll(@RequestParam Map<String,String> allParams) {...}

Если два последних метода все-таки будут пересекаться, тогда оставить только третий, и проверять в нем размер allParams - если мапа пустая, тогда возвращать service.findAll(), если же нет - обрабатывать переданные аргументы

[Jake Taylor]

BorLaze, так а толку обрабатывать параметры, которые пользователь от балды введет в GET запрос в строку браузера (просто побаловаться). Почему 404 не показывает?

[BorLaze]

потому что то, что идет после знака вопроса - это не часть урла

Если я правильно понял доку, можно попробовать такое:

@GetMapping(params = {!ParameterName.SORT_BY})
// gift-certificates?sort_ABRAKADABRA_by=name
@ResponseStatus(value = HttpStatus.NOT_FOUND)
public List<GiftCertificate> response404() {return null;}

может, и получится вернуть 404, если параметр не sort_by

[Орхан Гасанлы]

Jake Taylor, так вам и не нужно обрабатывать все параметры get запроса. Вообще, в урле могут быть куча параметров. Например, параметры для работы яндекс вебмастера, гугл вебмастера (всякие utm метки и т.д.). Вам нужно лишь получить и обработать лишь свои параметры.

[Jake Taylor]

BorLaze, я вот это тоже читал, только тут.
И я попробовал с помощью регулярных выражений типа:

@GetMapping(params = "!*")
@GetMapping(params = "!.")

Но не выходит.

Согласно документации:
> Finally, "!myParam" style expressions indicate that the specified parameter is not supposed to be present in the request.

я могу в аннотации указать @GetMapping(params = "!abrakadabra") и это будет значить, что аннотированный метод выполнится лишь в том случае, если GET запрос не будет содержать параметр abrakadabra. Но это не работает в таком варианте @GetMapping(params = "!")

[Jake Taylor]

Орхан Гасанлы, я и не хочу обрабатывать все параметры)
Я хочу чтобы запрос попал в метод в тех случаях, когда url был без любых параметров:

@GetMapping
// gift-certificates
public List<GiftCertificate> findAll() {...}

А вот если в GET запросе будут любые несуществующие в маппинге параметры (потому что маппинга много), то чтобы выбрасывало 404.

[BorLaze]

Тогда так:

@GetMapping(value = "path", params = "withParam")
    public ResponseEntity<String> withParam(@RequestParam(value = "withParam") Integer withParam) {
        return new ResponseEntity<>("withParam = " + withParam, HttpStatus.OK);
    }

    @GetMapping(value = "path", params = "!withParam")
    public ResponseEntity<String> notWithParam(@RequestParam Map<String, String> allParams) {
        if (allParams.isEmpty()) {
            return new ResponseEntity<>("pathRoot", HttpStatus.OK);
        }
        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }

Что оно делает и как:
- при обращении к path?withParam=0 вызывается метод withParam, поскольку у него в аннотации прописан этот аргумент
- при любом другом параметре (типа path?withParamXXX=1) или без него (просто path) вызывается второй метод notWithParam. В нем мы проверяем - если это действительно вариант вызова без параметров, действуем как в случае чистого гет; иначе (означает вызов с неопределенным параметром) бросаем 404

Может, если еще какие-то, более цивильные способы решить вопрос, но в 12 ночи уже как-то думать не хочется :-)

ЗЫ: к сожалению, если даже прописать метод с чистым @GetMapping, мы в него не попадаем - @GetMapping(params = "!withParam") его перекроет.

[Jake Taylor]

BorLaze, А если у меня много параметров есть в маппинге (param1, param2, param3, param4). Теперь их все нужно прописывать? Как-то не выглядит

@GetMapping(value = "path", params = {"!param1", "!param2", "!param3", "!param4"})
    public ResponseEntity<String> notWithParam(@RequestParam Map<String, String> allParams) {
        if (allParams.isEmpty()) {
            return new ResponseEntity<>("pathRoot", HttpStatus.OK);
        }
        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }

[BorLaze]

Jake Taylor, тогда только руками

@GetMapping(value = "path")
    public ResponseEntity<String> pathRoot(@RequestParam Map<String, String> allParams) {
        if(allParams.isEmpty()) {
            return new ResponseEntity<>("pathRoot", HttpStatus.OK);
        }
        if(__all_params_allowed__) {
            return new ResponseEntity<>("withParam", HttpStatus.OK);
        }
        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }

делаешь один метод, объявляешь в нем мапу параметров и проверяешь - если она пустая, то реагируешь как на вызов без параметров
если все параметры разрешенные - обрабатываешь
иначе, если попадается что-то левое - возвращаешь 404

других способов я не вижу

[Jake Taylor]

BorLaze, вариант рабочий, но может есть что проще?

[BorLaze]

Jake Taylor, сомневаюсь

конструкция @GetMapping(params= вообще выглядит каким-то костылем, если честно.

потому что урл определяется частью ДО знака вопроса - соответственно, и 404 возвращается, когда ресурс не найден, а не тогда, когда ему передаются какие-то неправильные аргументы

[Jake Taylor]

BorLaze, Да, согласен. Я неправильно по 404 сказал. Тогда можно кастомное исключение в exception handler'e ловить