Spring: Контроллеры, основанные на аннотациях / Annotation Controller. Пример

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

При использовании контроллеров, базирующихся на аннотациях, нет необходимости наследоваться от специальных классов или реализовывать какие-то интерфейсы. Единственное, что необходимо сделать - это превратить простой java класс в Spring контроллер с помощью аннотации @Controller.

Рассмотрим листинг описания класса UserController:

package firststeps.spring.web; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.SessionAttributes; import firststeps.spring.domain.User; import firststeps.spring.service.UserService; @Controller @RequestMapping("/userRegistration.htm") @SessionAttributes("user") public class UserController { private UserService userService; @Autowired public void setUserService(UserService userService) { this.userService = userService; } @RequestMapping(method = RequestMethod.GET) public String showUserForm(ModelMap model) { User user = new User(); model.addAttribute(user); return "userForm"; } @RequestMapping(method = RequestMethod.POST) public String onSubmit(@ModelAttribute("user") User user) { userService.add(user); return "redirect:userSuccess.htm"; } }

Аннотация @Controller используется для магического превращения любого java класса в класс контроллера. Аннотация @RequestMapping используется для маппинга веб запроса "/userRegistration.htm" на класс UsserController. Аннотация @SessionAttributes используется для сохранения объекта модели в сессии. В нашем случае, объектом модели выступает user.

При использовании аннотации @Autowired, контейнер может связывать бины автоматически. Но, по умолчанию, автоматическое связывание происходит по типу. В нашем случае будет выбран любой класс, который совместим с UserService. В классе контроллера необходимо указать два метода: один для управления HTTP GET запросом, а другой - для HTTP POST. Эти методы могут иметь произвольные имена. Когда форма отрисовуется впервые, вызывается метод showUserForm(), а затем, когда форма отсылается обратно на сервер, для обработки запроса вызывается onSubmit().

Аннотация @RequestMapping используется для идентификации типа HTTP запроса. 

Командный объект, ассоциированные с формой, инициализуется в методе showUserForm().  Метод showUserForm() имеет доступ к ModelMap, в методе showUserForm(), создает командный объект и добавляет его к ModelMap. Для того, чтобы добавить атрибут в ModelMap, можно использовать метод addAttribute(). Этот метод автоматически сгенерирует имена атрибутов для каждого элемента. В нашем случае, объект user, по умолчанию, будет принимать имена как "user" (Можно переопределить дефолтное значение). 

После того, как форма заполнена и отправлена, вызывается метод onSubmit(). Можно получить доступ к командному объекту с использованием аннотации @ModelAttribute. В нашем случае, имя командного объекта - user. После получения командного объекта, вызывается сервисные метод для регистрации пользователя и перенаправления управления на страницу "userSuccess.jsp".

Как можно заметить, мы перенаправляем запрос к "userSuccess.htm", вместо простого возвращения "userSuccess". Это необходимо, поскольку если мы просто вернем "userSuccess", отобразится страница userSuccess.jsp, но как только обновится страница после отправления формы, произойдет то, чего мы не совсем ожидали.

Запрос "userSuccess.htm" спроецирован на класс UserSuccessController; метод redirect() вызывается и передает управление странице userSuccess.jsp. 

Код UserSuccessController:

package firststeps.spring.web; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class UserSuccessController { @RequestMapping("/userSuccess.htm") public String redirect() { return "userSuccess"; } }

Для того, чтобы включить автоматическое определение контроллеров в Spring, необходимо задать базовый пакет с контроллерами, используя элемент <context:component-scan> в конфигурационном файле Spring. DefaultAnnotationHandlerMapping  и AnnotationMethodHandlerAdapter заранее зарегистрированы в контексте веб-приложения.  Но нам необходимо  явно зарегистрировать их, в случае если у нас зарегистрированы любые другие маппинги:

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans <a href="http://www.springframework.org/schema/beans/spring-beans.xsd" title="http://www.springframework.org/schema/beans/spring-beans.xsd">http://www.springframework.org/schema/beans/spring-beans.xsd</a> <a href="http://www.springframework.org/schema/context" title="http://www.springframework.org/schema/context">http://www.springframework.org/schema/context</a> http://www.springframework.org/schema/context/spring-context.xsd"> <bean id="viewResolver" class="org.springframework.web.servlet.view. InternalResourceViewResolver" p:prefix="/WEB-INF/jsp/" p:suffix=".jsp" /> <bean id="userService" class="com.vaannila.service.UserServiceImpl" /> <context:component-scan base-package="com.vaannila.web" /> <bean class="org.springframework.web.servlet.mvc.annotation. DefaultAnnotationHandlerMapping" /> <bean class="org.springframework.web.servlet.mvc.annotation. AnnotationMethodHandlerAdapter" /> </beans>