Spring SimpleFormController. Пример

Для того, чтобы управлять формами в Spring, Вам необходимо унаследовать класс контроллера от SimpleFormController. В нашем примере мы создадим форму для регистрации пользователя для того, чтобы понять как это работает. SimpleFormController - понятие устаревшее в рамках Spring 3.0. Поэтому, если Вы собираетесь использовать Spring 3.0 или выше, необходимо проставить соответствующие аннотации.

package firststeps.spring.web; import org.springframework.web.servlet.ModelAndView; import org.springframework.web.servlet.mvc.SimpleFormController; import firststeps.spring.domain.User; import firststeps.spring.service.UserService; @SuppressWarnings("deprecation") public class UserController extends SimpleFormController { private UserService userService; public UserController() { setCommandClass(User.class); setCommandName("user"); } public void setUserService(UserService userService) { this.userService = userService; } @Override protected ModelAndView onSubmit(Object command) throws Exception { User user = (User) command; userService.add(user); return new ModelAndView("userSuccess", "user", user); } }

В это примере используется Spring 3.0, поэтому в коде встречаются аннотации SuppressWarnings. Мы наследуем UserController от SimpleFormController,  что дает классу контроллера возможность управления формами. Обычно форма ассоциирована с определенным доменным объектом, в нашем случае, классом User. В Spring, этот доменный объект именуется командным объектом по умолчанию. Для того, чтобы сослаться на командный объект на странице jsp, необходимо установить командный класс с использованием метода setCommandClass(). Предположим, что класс User имеет свойство name и для того, чтобы сослаться на него из jsp страницы, будем использовать "command.name". Можно также изменить это имя с использованием метода setCommandName(). В нашем примере мы устанавливаем имя пользователя и будем ссылаться на него с использованием "user.name" в jsp странице. 

Необходимо иметь метод для управления формой в тот момент, когда она будет отправлена на сервер. В нашем примере мы используем метод onSubmit() для этих целей. Этот метод имеет доступ к командному объекту. Сперва мы приводим класс командного объекта к User (наш доменный объект), а затем регистрируем пользователя посредством вызова метода add() в сервисном классе и возвращаем объект ModelAndView.

Все значения полей формы будут отправлены в формате String. Spring содержит несколько редакторов свойств для конвертирования строковых значений в нужные. В случае, если у вас есть кастомный тип данных, то необходимо сперва создать редактор свойств для управления этим процессом. 

package firststeps.spring.domain; public class User { private String name; private String password; private String gender; private String country; private String aboutYou; private String[] community; private Boolean mailingList; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public String getGender() { return gender; } public void setGender(String gender) { this.gender = gender; } public String getCountry() { return country; } public void setCountry(String country) { this.country = country; } public String getAboutYou() { return aboutYou; } public void setAboutYou(String aboutYou) { this.aboutYou = aboutYou; } public String[] getCommunity() { return community; } public void setCommunity(String[] community) { this.community = community; } public Boolean getMailingList() { return mailingList; } public void setMailingList(Boolean mailingList) { this.mailingList = mailingList; } }

User Service интерфейс

package firststeps.spring.service; import firststeps.spring.domain.User; public interface UserService { public void add(User user); }

Реализация User Service

package firststeps.spring.service; import firststeps.spring.domain.User; public class UserServiceImpl implements UserService { @Override public void add(User user) { // Persist the user object here. System.out.println("User added successfully"); } }

Затем создадим форму регистрации пользователя с использованием тегов. Для использования тегов формы, необходимо сперва включить библиотеку тегов Spring.

<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form"%> <html> <head> <title>Registration Page</title> </head> <body> <form:form method="POST" commandName="user"> <table> <tr> <td>User Name :</td> <td> <form:input path="name" /> </td> </tr> <tr> <td>Password :</td> <td> <form:password path="password" /> </td> </tr> <tr> <td>Gender :</td> <td> <form:radiobutton path="gender" value="M" label="M" /> <form:radiobutton path="gender" value="F" label="F" /> </td> </tr> <tr> <td>Country :</td> <td> <form:select path="country"> <form:option value="0" label="Select" /> <form:option value="1" label="India" /> <form:option value="2" label="USA" /> <form:option value="3" label="UK" /> </form:select> </td> </tr> <tr> <td>About you :</td> <td> <form:textarea path="aboutYou" /> </td> </tr> <tr> <td>Community :</td> <td> <form:checkbox path="community" value="Spring" label="Spring" /> <form:checkbox path="community" value="Hibernate" label="Hibernate" /> <form:checkbox path="community" value="Struts" label="Struts" /> </td> </tr> <tr> <td></td> <td> <form:checkbox path="mailingList" label="Would you like to join our mailinglist?" /> </td> </tr> <tr> <td colspan="2"> <input type="submit"> </td> </tr> </table> </form:form> </body> </html>

Атрибут path используется для связи полей формы с доменным объектом. Мы использовали HTTP POST для отправки формы. Для того, чтобы связать поля формы с доменным объектом, командный объект должен иметь одинаковое имя на jsp странице и в классе контроллера. Для установки имени командного объекта на странице jsp, используется атрибут commandName тега form.

Далее, web.xml:

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>SpringExample6</display-name> <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet </servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>*.htm</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>redirect.jsp</welcome-file> </welcome-file-list> </web-app>

Теперь создаем конфигурационный файл бинов для Spring:

<?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" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/jsp/" p:suffix=".jsp" /> <bean id="userService" class="firststeps.spring.service.UserServiceImpl" /> <bean name="/userRegistration.htm" class="firststeps.spring.web.UserController" p:userService-ref="userService" p:formView="userForm" p:successView="userSuccess" /> </beans>

Как видите, мы использовали пространство имен "p". "p" - простое в использовании, с помощью него свойства могут быть представлены в виде атрибутов, а не элементов. 

Для инъекции простых типов данных, мы используем "p", а для инъекции ссылок мы добавляем суффикс "-ref". 

Например, p:formView используется для инъекции значения свойства view на форме, а p:userService-ref для инъекции в сервис пользователя.

Во время запроса HTTP GET сгенерится formView. Затем, когда форма будет отправлена (во время HTPP POST), вызовется метод onSubmit() в классе UserController. В случае успешного завершения метода сгенерируется successView. В случае, если произойдут ошибки трансформации или валидации, formView отобразится пользователю. 

Запустим пример посредством redirect.jsp. Файл redirect.jsp перенаправит запрос к "userRegistration.htm". 

<%@page contentType="text/html" pageEncoding="UTF-8"%> <% response.sendRedirect("userRegistration.htm"); %>

Заполним форму и отправим ее.

Вызовется метод onSubmit() в классе UserController, а управление передастся на представление "userSuccess". В примере мы используем InternalResourceViewResolver, поэтому отобразится userSuccess.jsp. 

Страница userSuccess.jsp:

<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%> <html> <head> <title>Success Page</title> </head> <body> User Details <hr> User Name : ${user.name} <br/> Gender : ${user.gender} <br/> Country : ${user.country} <br/> About You : ${user.aboutYou} <br/> Community : ${user.community[0]} ${user.community[1]} ${user.community[2]}<br/> Mailing List: ${user.mailingList} </body> </html>