Как обрабатывать методы Spring MVC без возвращаемого значения

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

Для указания отсутствия контента в контроллере Spring MVC используйте тип void в стандартном ответе 200 OK или ResponseEntity<Void> для установки пользовательских HTTP статусов.

Пример:

@GetMapping("/action")
public ResponseEntity<Void> performAction() {
  // Вставьте сюда вашу логику
  return ResponseEntity.noContent().build(); // Используйте .ok(), .notFound() и другие при необходимости
}

Работа в Spring MVC с методами, не возвращающими значение

Если вы оперируете методами контроллера, которым не требуется возвращать контент обычно благодаря обновлению данных или обработке больших форм, используйте тип возврата void. Это сигнал для Spring о том, что все выполнено корректно, и возвращать контент не требуется.

Уделите особое внимание HTTP статус кодам. Например, для POST запроса, обновляющего данные без необходимости ответа, идеальным статусом будет 204 No Content, который информирует клиента о успешной обработке его запроса, не содержащего ответа.

Показательный пример метода POST, возвращающего void:

@PostMapping("/updateSomeData")
public void updateData(@RequestBody SomeData data) {
  // Ваши действия с данными здесь. Все как у бармена, который не ожидает налички.
}

Если вам требуется вернуть объект и клиент ожидает JSON, то используйте аннотацию @ResponseBody.

@ResponseBody в помощь:

@GetMapping("/data")
public @ResponseBody SomeObject retrieveData() {
  // Отправляем объект клиенту. Это словно подарок в красивой упаковке!
  return new SomeObject();
}

Полный контроль над статусом и заголовками запроса предоставит вам ResponseEntity.

ResponseEntity на практике:

@PostMapping("/update")
public ResponseEntity<?> updateSomething(@RequestBody SomeData data) {
  // Здесь выполняется ваша логика. Сравните это с чтением инструкции перед началом работы.
  return new ResponseEntity<>(HttpStatus.OK); // Используйте .ok(), .created() и другие на ваше усмотрение.
}

Когда формат JSON является стандартом общения в вашем API, даже пустой ответ при успешно выполненной операции придаёт последовательность асинхронным вызовам, таким как $.getJSON(). Ваши клиенты ожидают постоянства и предсказуемости от вашего API.

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

Рассмотрим работу контроллера Spring MVC, который не возвращает значения.

🌐 Web-запрос достигает контроллера: "Привет, есть ли что-нибудь на эту тему?"

🚫 Логика контроллера принимает запрос, обрабатывает его, а затем... тишина.

"Представьте себе артиста (🤹‍♂️), который выступает, но вместо пышного финала просто склоняется (🙇‍♂️) и покидает сцену."

| Метод Контроллера | Ответ            |
| ------------------ |----------------- |
| Возвращает значение| 🎁 Подача результата!         |
| Метод Void         | 👋 Просто отмечает, что всё готово! |

Ваши действия в поезде 🚆:

🔊 "На следующей станции нужно выходить — город Значений" против "Катитесь до упора, без остановок".

"Бывает так, что ваше путешествие (🛤️) завершается лишь сообщением 'Безопасное прибытие!', и нет необходимости что-либо передавать (✋ пустота)."

Правильный выбор ответа для взаимодействия с клиентом

Гибкая настройка ответов с ResponseEntity

ResponseEntity – это универсальный инструмент, как швейцарский армейский нож. С его помощью вы можете создать любые ответы:

• Заголовки: Регулируйте кеширование, отправляйте cookies или устанавливайте специальные заголовки.
• Статус-код: В вашем распоряжении все HTTP статусы.
• Контент: При необходимости добавьте дополнительную информацию в ответ.

Использование подходящих статус-кодов

Очень важно, чтобы статус-коды вашего API всегда отражали суть операции. Распространённые статус коды для операций, не требующих ответа или void:

• 200 OK: Стандартный ответ для успешно выполненных операций
• 201 Created: Сигнализирует о том, что создание прошло успешно, часто используется при POST
• 204 No Content: Идеален для случаев, когда операция выполнена, но ответ возвращать не требуется
• 202 Accepted: Значит, что запрос принят в обработку, но ещё не выполнен

Создание надёжного дизайна API

Любое приложение со временем совершенствуется и развивается (извините, Питер Пэн 😋). Поэтому для согласованности API важно следовать некоторым принципам:

• Единообразие: Статус-коды и ответы должны следовать одним правилам
• Масштабируемость: Внесение улучшений не должно приводить к нестабильности существующего функционала
• Документация: Описание ответов и кодов статусов должно быть чётким и понятным для каждого конечного пункта

Полезные материалы

1. Документация REST API Spring Boot со Swagger — подробное руководство по документированию REST API на Spring Boot с использованием Swagger.
2. Реализация сценария без содержания (204) в Spring Web MVC — описание того, как в Spring MVC реализовать ситуацию, когда содержимое отсутствует.
3. Документация Spring Framework по @ResponseBody — официальное описание и практические рекомендации по использованию @ResponseBody в Spring MVC.
4. Spring MVC: Как возвращать настраиваемые статус-коды — советы по настройке статус-кодов HTTP в приложениях Spring MVC.
5. Обсуждение возврата void в контроллере Spring MVC — дискуссия на Stack Overflow о применении void в контроллере Spring MVC.