Работа с query параметрами в Spring Boot контроллере

Быстрый ответ

Для того чтобы извлекать параметры запроса в контроллере Spring Boot, используйте аннотацию @RequestParam. Предлагаем рассмотреть примеры её применения для одиночного параметра, необязательного параметра, а также для извлечения нескольких параметров:

Использование для одного параметра:

Java

Скопировать код

@GetMapping("/endpoint")
public String getParam(@RequestParam String id) {
    return "ID: " + id;
}

Применение для необязательного параметра: установите атрибут required=false:

Java

Скопировать код

@GetMapping("/endpoint")
public String getOptionalParam(@RequestParam(required=false) String id) {
    return "ID: " + (id != null ? id : "отсутствует");
}

Для работы с несколькими параметрами используйте Map<String, String>:

Java

Скопировать код

@GetMapping("/endpoint")
public String getMultipleParams(@RequestParam Map<String, String> allParams) {
    return "Список всех параметров: " + allParams;
}

Кинга Идем в IT: пошаговый план для смены профессии

Как обрабатывать необязательные и множественные параметры?

Эффективное использование необязательных параметров

Чтобы представить параметры запроса как необязательные, примените конструкцию Optional<> в @RequestParam, что поможет избегать проблем при их отсутствии:

Java

Скопировать код

@GetMapping("/endpoint")
public String getOptionalParam(@RequestParam Optional<String> optParam) {
    return "Необязательный параметр: " + optParam.orElse("Не указан");
}

Подробнее об этом расскажет наш спикер на видео

Обработка сразу всех параметров

Вместо указания каждого параметра вручную Вы можете собрать их все в одном Map для краткости кода:

Java

Скопировать код

@GetMapping("/endpoint")
public String getAllParams(@RequestParam Map<String, String> paramsMap) {
    StringBuilder builder = new StringBuilder("Полученные параметры: ");
    paramsMap.forEach((key, value) -> builder.append(key).append("=").append(value).append("; "));
    return builder.toString();
}

Сочетание маршрутизации и параметров запроса в одном методе

Вы можете эффективно использовать как переменные пути, так и параметры запроса в одном методе обработки:

Java

Скопировать код

@GetMapping("/items/{category}")
public String itemsByCategory(@PathVariable String category, 
                              @RequestParam Map<String, String> filters) {
    return "Категория: " + category + ". Применённые фильтры: " + filters;
}

Визуализация

Представьте обработку запросов в Spring Boot как станцию, а параметры запросов – это пассажиры, у каждого из которых есть своя собственная цель путешествия:

Java

Скопировать код

@RequestMapping(value = "/trains")
public ResponseEntity<?> arrive(@RequestParam String destination) {
    return new ResponseEntity<>("Поезд направляется в " + destination, HttpStatus.OK);
}

Итак, к нам приходит поезд, нагруженный пассажирами:

Markdown

Скопировать код

До: [👩🏽‍💼 destination='Paris', 👨‍💼 destination='Berlin', 👩‍💼 destination='Rome']
После: 👩🏽‍💼 отправляется в Париж, 👨‍💼 отправляется в Берлин, 👩‍💼 отправляется в Рим

Лучшие практики обрабатывания параметров запроса

Применение валидации и обработка исключений

С помощью Spring Validation можно обеспечить надежность обработки параметров и снизить вероятность ошибок:

Java

Скопировать код

@GetMapping("/endpoint")
public String validatedParam(@RequestParam @Min(1) @Max(100) int number) {
    return "Проверенное число: " + number;
}

Использование разных конечных точек

Рекомендуем использовать уникальные URL для разграничения запросов:

Java

Скопировать код

@GetMapping("/search/byName")
public String searchByName(@RequestParam String name) {
    // Реализация поиска по имени
}

@GetMapping("/search/byTag")
public String searchByTag(@RequestParam String tag) {
    // Реализация поиска по тегу
}

Использование инструментов для документирования API

Инструменты документирования, например, Swagger, значительно упрощают взаимодействие с API и понимание его работы:

Java

Скопировать код

@ApiOperation(value = "Get item by ID", notes = "Provide an ID to look up a specific item")
@GetMapping("/item")
public ResponseEntity<?> getItemById(@RequestParam String id) {
    // Реализация получения товара
    return ResponseEntity.ok().body(item);
}

Тестирование конечных точек

Важно всегда проверять корректность работы ваших конечных точек, используя, например, Postman или curl:

Bash

Скопировать код

curl -X GET 'http://localhost:8080/endpoint?param1=value1&param2=value2'

Обеспечение прозрачности кода

Всегда уточняйте, какие параметры ожидает метод и каким образом они будут использоваться – это сильно упростит поддержку кода и создание API.

Проверь как ты усвоил материалы статьи

Пройди тест и узнай насколько ты лучше других читателей

Какой аннотацией в Spring Boot контроллере можно извлекать параметры запроса?

1 / 5

Свежие материалы

Критика и альтернативы компиляции: интерпретаторы и гибридные подходы

30 августа 2024

Лучшие каналы для изучения Java

6 сентября 2024

Видео уроки по C++

6 сентября 2024