Формирование ответов: @ResponseBody, @ModelAttribute

В веб-разработке есть два направления движения данных:

1. Клиент → Сервер (обработка запросов).
2. Сервер → Клиент (формирование ответов).

И если на первое направление мы уже посмотрели, то второе требует нашего пристального внимания. Давайте разберемся, как сервер может "отвечать" клиенту и почему это важно для успешного взаимодействия.

Варианты ответов

1. HTML-страницы.
   • Сервер возвращает HTML-код, который браузер рендерит пользователю.
2. JSON/XML.
   • Сериализованные данные для клиентов (например, в REST API).
3. Файлы или другие ресурсы.
   • Например, изображения, PDF или ZIP-файлы.

В Spring MVC мы можем гибко формировать ответы благодаря мощной системе аннотаций и инструментов.

Аннотация @ResponseBody

Если вы пришли из мира REST API, то фраза "JSON-ответы" должна быть для вас как музыка. Эта аннотация как раз отвечает за отправку данных в формате JSON или XML из контроллера клиенту.

По сути, @ResponseBody говорит Spring: "Хватит играть в эти красивые стендапчики с HTML-страницами. Просто отправь данные клиенту, без лишней драматургии". То есть она отменяет разрешение представления (view resolution), и вместо этого возвращает данные непосредственно в HTTP-ответ.

Пример: Отправка JSON-ответа

Вот простейший пример:

@RestController
@RequestMapping("/api")
public class UserController {

    @GetMapping("/user")
    public User getUser() {
        return new User(1, "John Doe");
    }
}

Здесь мы используем @RestController, которая, по сути, является сокращением для @Controller + @ResponseBody. Это значит, что каждый метод возвращает JSON-ответ. Если вы вернете объект, Spring автоматически преобразует его в JSON (сериализует) благодаря встроенной библиотеке Jackson.

Как это работает? Spring умеет сериализовать объекты в JSON благодаря библиотеки Jackson. Она включена "из коробки", поэтому никаких дополнительных телодвижений не нужно. Но если вам захочется сериализовать объект в XML, то потребуется немного доработок.

Пример: Использование @ResponseBody без @RestController

Если по какой-то причине вы используете обычный контроллер, а не @RestController, ничего страшного! Просто добавьте @ResponseBody к методу.

@Controller
@RequestMapping("/api")
public class UserController {

    @ResponseBody
    @GetMapping("/user")
    public User getUser() {
        return new User(1, "Jane Doe");
    }
}

Эта аннотация говорит Spring, что данные нужно возвращать напрямую, а не искать представления.

А можно вернуть не только JSON?

Конечно. Если вы хотите вернуть, например, строку или любой другой тип данных, @ResponseBody с радостью это сделает.

@Controller
@RequestMapping("/api")
public class ExampleController {

    @ResponseBody
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Spring MVC!";
    }
}

Клиент получит просто строку: Hello, Spring MVC!.

Типичные ошибки при использовании @ResponseBody

1. Ошибка: "Cannot serialize object". Это случается, если объект не может быть преобразован в JSON. Например, у него нет public-геттеров, или вы забыли подключить Jackson.
2. Возврат HTML случайно. Если вы забудете @ResponseBody или используете @Controller без нее, Spring может попытаться найти HTML-страницу с именем, совпадающим с возвращаемым значением (например, "user" для метода getUser).

Аннотация @ModelAttribute

Если @ResponseBody — это ваш лучший друг для REST API, то @ModelAttribute незаменим для работы с классическим MVC, где используется HTML и серверные шаблоны.

Аннотация @ModelAttribute помогает вам передавать данные из контроллера в представление. Она загружает объект в модель (это мы про org.springframework.ui.Model!), чтобы затем передать его в шаблон.

Пример: передача объекта в представление

Предположим, у нас есть HTML-страница, отображающая информацию о пользователе. Сначала нужно передать данные:

@Controller
@RequestMapping("/users")
public class UserController {

    @GetMapping("/profile")
    public String userProfile(Model model) {
        User user = new User(1, "Jane Doe");
        model.addAttribute("user", user);
        return "userProfile";
    }
}

Здесь мы добавляем объект user в модель, а затем возвращаем имя представления (userProfile), которое его отобразит. Представление может быть, например, Thymeleaf-шаблоном.

Использование @ModelAttribute

Но зачем вручную добавлять в модель, если есть @ModelAttribute?

@Controller
@RequestMapping("/users")
public class UserController {

    @ModelAttribute("user")
    public User getUser() {
        return new User(1, "Jane Doe");
    }

    @GetMapping("/profile")
    public String userProfile() {
        return "userProfile";
    }
}

Spring вызовет метод с @ModelAttribute автоматически при любом запросе контроллера, и объект будет добавлен в модель под указанным именем (user). Это сокращает код и делает ваш контроллер более чистым.

Пример: работа с формами

@ModelAttribute также используется для привязки данных из форм в Java-объекты.

@Controller
@RequestMapping("/users")
public class UserController {

    @GetMapping("/register")
    public String showRegistrationForm(Model model) {
        model.addAttribute("user", new User());
        return "register";
    }

    @PostMapping("/register")
    public String processRegistration(@ModelAttribute("user") User user) {
        System.out.println("Registered user: " + user);
        return "registrationSuccess";
    }
}

• GET-запрос отображает форму для регистрации с пустым объектом User.
• POST-запрос автоматически связывает данные из формы с объектом User.

Типичные ошибки при использовании @ModelAttribute

1. Ошибка: "NullPointerException". Если вы забыли добавить объект в модель, представление не сможет отрендерить данные.
2. Ошибка привязки данных. Если у вас есть сложный объект и данные из формы не могут быть проставлены, Spring выбросит ошибку. Убедитесь, что все поля формы соответствуют полям объекта.

Когда использовать @ResponseBody и @ModelAttribute?

Теперь вы вооружены знаниями о том, как формировать ответы в Spring MVC. Помните: @ResponseBody — лучший выбор для REST API, а @ModelAttribute спасёт вас в мире форм и серверной генерации HTML.