Spring Framework form 처리

7.9. 폼 제출 처리 

1) 지금까지의 Form 처리 방식

- 입력 페이지에 접근한다.
- 입력 데이터를 입력한 후 Submit
- 입력된 데이터에 대한 유효성 체크와 입력 데이터를 도메인 모델 클래스에 저장(Data Binding)
- 데이터 유효성 체크와 Data Binding이 문제없이 완료되면 사용자가 입력한 데이터를 데이터베이스에 저장하거나 수정한다.

Spring에서는 이와 같은 일련의 과정 전체를 지원하기 위하여 SimpleFormController를 지원하고 있다. SimpleFormController는 하나의 페이지에 대한 Form 처리를 진행할 경우 유용하게 사용될 수 있다.
Spring 프레임워크에서 지원하는 SimpleFormController는 GET과 POST에 따라 실행하는 작업을 달리하게 된다. GET 방식의 요청에 대해서는 입력 페이지, 수정 페이지로 이동하게 되며, POST 방식일 경우에는 입력 작업과 수정 작업을 진행하게 된다.
따라서 GET 방식일 경우에는 입력 페이지로 이동하는 과정이기 때문에 Data Binding이나 유효성 체크와 같은 작업은 실행되지 않는다. 그러나 POST 방식일 경우에는 입력 폼에서 전달된 데이터를 실질적으로 데이터베이스에 반영하는 과정이기 때문에 입력폼에서 전달된 데이터가 유효한지 체크하는 과정을 거치게 된다.
GET 방식과 POST 방식에 따라 SimpleFormController의 메써드가 호출되는 Workflow를 살펴보면 다음과 같다.

■ SimpleFormController가 Get 요청일 경우

■ SimpleFormController가 Post 요청일 경우

2) 폼 제출 처리

폼을 보여주기 위해 AbstractController 상속하고 폼을 처리하기 위해 AbstractCommandController를 상속한다면 서로 다른 컨트롤러를 관리해야 하는 단점이있다. 이를 개선한 것이 폼 컨트롤러이다.
HTTP GET 요청을 받았을 때에는 폼을 보여주고 HTTP POST 요청을 받았을 때에는 폼을 처리하는 기능이 추가된, 한 단계 더 발전된 컨트롤러이다. 게다가 폼을 처리하는 중에 어떤 에러라도 발생되면, 폼을 다시 보여줌으로써 사용자가 에러를 수정하여 다시 폼을 제출할 수 있도록 해준다.

public class RegisterStudentController extends SimpleFormController {
    public RegisterStudentController() {
        setCommandClass(Student.class);
    }

    protected void doSubmitAction(Object command) throws Exception {
        Student student = (Student) command;
        studentService.registerStudent(student);
    }

    private StudentService studentService;

    public void setStudentService(StudentService studentService) {
        this.studentService = studentService;
    }
}

doSubmitAction() 메소드는 주입된 StudentService 참조의 enrollStudent() 메소드에 명령 객체를 전달함으로써 폼 제출(HTTP POST 요청)을 처리한다. 이 컨트롤러가 어떻게 등록 폼을 보여주는지에 대한 정의는 되어있지 않다.
SimpleFormController는 뷰와 관련된 자세한 사항을 컨트롤러의 자바 코드로부터 가급적이면 분리시키도록 설계되었다. ModelAndView 객체를 사용하는 대신 컨텍스트 설정 파일에서 컨트롤러를 설정할 수 있다.

<bean id="registerStudentController" class="com.springinaction.training.mvc.RegisterStudentController">
    <property name="formView"><value>registerStudent</value></property>
    <property name="successView"><value>registerSuccess</value></property>
    <property name="studentService"><ref bean="studentService"/></property>
</bean>

formView : 컨트롤러가 HTTP GET 요청을 받았을 때나 또는 에러 발생시 보여줘야 할 뷰의 논리적인 이름.
successView : 성공적으로 폼이 제출됐을 때 보여줘야 할 뷰의 논리적인 이름.

뷰 리졸버는 이들 값을 사용해 사용자에게 결과를 랜더링 하여 보여줄 View 객체를 검색할 것이다. ModelAndView 객체를 리턴할 필요성이 없어짐으로 인해 모델 데이터를 뷰에 전달하는것은 불가능하다. 이는 성공적으로 처리된 후에 모델 데이터를 보여줄 것인지 여부에 따라 문제가 될 수도 있고 그렇지 않을 수도 있다.
만약 데이터를 전송하여 뷰에 의해 보여지도록 해야할 경우라면 doSubmitAction() 대신 onSubmit() 메소드를 재정의해서 사용해야 한다.

■ 폼 입력값 검증

org.springframework.validation.Validator 인터페이스는 Spring MVC에서의 유효성 검증을 도모한다.

public interface Validator {
    void validate(Object obj, Errors errors);
    boolean supports(Class clazz);
}

supports() 메소드는 Spring이 주어진 클래스에 대해 검증기를 사용할지 여부를 결정하는데 사용된다.

<bean id="registerStudentController" class="com.springinaction.training.mvc.RegisterStudentController">
    ...

    <property name="validator">
        <bean class="com.springinaction....." />
    </property>
</bean>

3) 마법사를 통한 복잡한 폼의 처리

사용자로 하여금 다수의 페이지에 걸친 복잡한 입력 폼들을 거치도록 해야 할 경우 사용 된다. 주목할 점은 최종적으로는 하나의 폼으로서 처리된다는 것이다.
AbstractWizardFormController 클래스를 확장하여 사용되며, processFinish() 메소드를 통해 폼 입력 완료 시 폼을 종료시키기 위해 호출된다. AbstractWizardFormController가 마법사의 작업 흐름 관리와 관련된 대부분의 일을 처리하는데 서블릿명-servlet.xml 파일에 설정해야 한다.

<bean id="feedbackController" class="com.springinaction.training.mvc.FeedbackWizardController">
    <property name="feedbackService">
        <ref bean="feedbackService">
    </property>
    <property name="pages">
        <list>
            <value>general</value>
            <value>instructor</value>
            <value>course</value>
            <value>facilities</value>
        </list>
    </property>
</bean>

뷰의 논리적인 이름 목록을 pages 특성에 지정함으로써 어떤 페이지들이 폼을 구성하는지 마법사가 알 수 있도록 해준다.
이들 이름은 최종적으로 뷰 리졸버에 의해 View 객체에 삽입된다.

■ 폼 페이지의 단계 밟기

처음 보여질 페이지는 pages 특성에 설정된 첫 번째 값(general)이 된다.
AbstractWizardFormControlle는 어떤 페이지를 보여줘야 할지를 결정하기 위해서 자신의 getTargetPage() 메소드에 의뢰한다. 이 메소드는 int 타입의 결과를 리턴하며 pages 특성에 주어진 0부터 시작하는 페이지들의 목록에 있어서의 인덱스 값이다.
기본적으로 구현된 getTargetPage()는 '_target'으로 시작하고 숫자로 끝나는 이름의 요청 파라미터를 기초로 다음 페이지를 결정한다.
즉, _target0, _target1 ....

■ 마법사 완료하기

마법사의 작업이 완료되면 processFinish() 메소드가 호출되어야 하는데 이를 컨트롤러에게 알려주기 위해서는 '_finish'라고 하는 요청 파라미터가 사용된다.

■ 마법사 취소하기

진행중인 마법사를 취소하기 위해서는 '_cancel' 파라미터를 사용한다.

AbstractWizardFormControlle가 이 파라미터를 수신하면, 제어권을 processCancel() 메소드로 전달할 것이다.
processCancel()은 기본적으로 취소 작업이 지원되지 않는다는 것을 나타내는 예외를 던진다. 따라서 이 메소드를 재정의하여 사용자가 '취소' 버튼을 눌렀을 때 다른 어떤 페이지로 이동토록 해야 한다.

protected ModelAndView processCancel(HttpServletRequest request,
                                        HttpServletResponse response, Object command, BindException
                                        bindException) throws Exception {
    return new ModelAndView("home");
}

만약 취소시키기 전에 정리해야 할 작업이 있다면 processCancel() 메소드 안에 ModelAndView()를 리턴하기 전에 설정해 줘야 한다.

■ 마법사 폼 검증하기

마법사 컨트롤러는 Validator 객체를 사용하여 명령 객체의 검증을 한번에 실시하는 대신 한번에 한 페이지만큼을 검증한다. 이는 페이지가 전환될 때마다 validatePage() 메소드를 호출함으로써 수행된다.

protected void validatePage(Object command, Errors errors, int page) {
    FeedbackSurvey feedback = (FeedbackSurvey) command;
    FeedbackValidator = (FeedbackValidator) getValidator();

    if(page == 0) {
        validator.validateEmail(feedback.getEmail(), errors);
    }
}

이 경우, 검증 대상이 증가함에 따라 validatePage() 메소드는 코드량이 증가하는 문제가 발생된다. 따라서 여기서 FeedbackValidator의 validateEmail()메소드를 호출 했듯이, 컨트롤러 검증기 객체에 세밀한 수준의 검증 메소드에 검증에 대한 책임을 위임하기를 권장한다. 이 모든 것은 컨트롤러를 설정할 때 validator 특성을 설정해야 함을 전제로 한다.

<bean id="feedbackController" class="com.springinaction.training.mvc.FeedbackWizardController">
    <property name="feedbackService">
        <ref bean="feedbackService">
    </property>
    <property name="pages">
        <list>
            <value>general</value>
            <value>instructor</value>
            <value>course</value>
            <value>facilities</value>
        </list>
    </property>
    <property name="validator">
        <bean class="com.springinaction.training.mvc.FeedbackValidator" />
    </property>
</bean>

여기서 유의해야 할 중요한 사항은, 다른 명령 컨트롤러들과는 달리 마법사 컨트롤러는 결코 Validator 객체의 표준 validate() 메소드를 호출하지 않는다는 사실이다.
이는 validate() 메소드가 명령 객체 전체를 검증하는 반면, 마법사 컨트롤러는 마법사의 명령 캨게가 한번에 한 페이지만큼 검증돼야 한다는 것을 알기 때문이다.
만약 어떤 이유에서든 processFinish()를 호출하기 이전에 명령 객체 전체를 검증해야할 필요가 있다면 다음과 같이 구현한다.

protected void validatePage(Object command, Errors errors, int page, boolean isFinish) {
    FeedbackSurvey feedback = (FeedbackSurvey) command;
    FeedbackValidator = (FeedbackValidator) getValidator();

    if(page == 0) {
        validator.validateEmail(feedback.getEmail(), errors);
    }

    if(isFinish) {
        validator.validate(command, errors);
    }
}

4) 단일 컨트롤러에서 다중 액션 처리하기

MultiActionController는 다중 액션을 수행할 수 있는 특별한 종류의 컨트롤러로서, 각 액션은 다양한 메소드와 붙을 수 있다. 예를 들어 강의 목록을 보여주는 courseUnsorted(), coursesSortedByDate(), coursesSortedByName() 이렇게 하나의 컨트롤러에 세 개의 메소드가 있을 경우 원하는 메소드를 통해 수행되려면 URL에서 파일명에 나타내는 부분에 의해서 선택된다.
즉, http://localhost/courseUnsorted.do, http://localhost/coursesSortedByDate.do, 
http://localhost/coursesSortedByName.do
이는 매우 직관적이긴 하지만, 메소드명이 노출되므로 좋은 방법이 아닐 수 있다.

■ 메소드 이름 결정

MultiActionController는 메소드 이름 리졸버에 기초해 메소드 이름을 결정할 수 있다.

- ParameterMethodNameResolver : 요청 파라미터를 기초로 하여 실행 메소드 이름을 결정한다.
- PropertiesMethodNameResolver : 키-값 쌍의 목록을 기초로하여 실행 메소드 이름을 결정한다.

<bean id="multiactionController" class="com.springinaction.training.mvc.ListCoursesController">
    <property name="methodNameResolver">
        <ref bean="methodNameResolver" />
    </property>
</bean>

■ 리졸버 선택

Struts의 DispatchAction과 유사한 것이 ParameterMethodNameResolver 이다.
즉 요청을 통해 전달된 파라미터에 기호하여 메소드를 선택할 수 있게 해준다.

<bean id="methodNameResolver" class="com.springinaction.web.servlet.mvc.multiaction.ParameterMethodNameResolver">
    <property name="paramName">
        <value>action</value>
    </property>
</bean>

paramName 특성은 실행 메소드의 이름을 담고 있는 요청 파라미터의 이름을 나타내며, 여기서는 action으로 설정돼있다.
즉, ...?action=coursesUnsorted 처럼 해준다. 이는 POST 방식으로도 가능하다.
메소드 이름을 결정하는 또 다른 방법은 URL 패턴을 메소드 이름과 매핑하는 것이다.

<bean id="methodNameResolver" class="com.springinaction.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">
    <property name="mappings">
        <props>
            <prop key="/courseList.do">coursesUnsorted</prop>
            <prop key="/coursesByDate.do">coursesSortedByDate</prop>
            <prop key="/coursesByName.do">coursesSortedByName</prop>
        </props>
    </property>
</bean>

5) 일회성 컨트롤러

public interface ThrowawayController {
    ModelAndView execute() throws Exception;
}

일회성 컨트롤러를 만들기 위해서 해야 할 일은 오직 이 인터페이스를 구현하고 execute() 메소드 안에 프로그램 로직을 구현하는 것이다.
HttpServletRequest나 명령 객체를 통해 파라미터를 얻는 대신, 일회성 컨트롤러는 스스로가 명령 객체로서 행동한다.

public class DisplayCourseController implements ThrowawayController {
    private Integer id;

    public void setId(Integer id) {
        this.id = id;
    }

    public ModelAndView excute() throws Exception {
        Course course = courseService.getCourse(id);
        return new ModelAndView("courseDetail", "course", course);
    }

    // INJECTED
    private CourseService courseService;
    public void setCourseService(CourseService courseService) {
        this.courseService = courseService;
    }
}

또한 일회성 컨트롤러를 DispatcherServlet의 설정 파일에 선언해야 한다.
<bean id="displayCourseController" class="com.springinaction.training.mvc.DisplayCourseController" singleton="false">
    <property name="courseService"><ref bean="courseService"/></property>
</bean>

singleton="false" 부분에 주목해야 한다. 기본적으로 모든 Bean은 singleton이기 때문에 singleton을 false로 지정하지 않는다면 DisplayCourseController는 요청들 사이에서 재사용될 것이다. 즉, 사용이 끝난 컨트롤러는 폐기할 것이며 각 요청에 대한 새로운 인스턴스를 생성시킬 것을 스프링에게 지시하는 것이다.
일회성 컨트롤러를 사용하기 위해 해야 할 일이 또 하나 있다. 핸들러 어댑터를 사용해 어떻게 요청을 컨트롤러에 전달할지를 DispatcherServlet이 알게 해줘야 하는 것이다.
ThrowawayController는 Controller와 동일한 계층도에 속하지 않기 때문에, DispatcherServlet에게 다른 핸들러 어댑터를 사용할 것을 반드시 알려줘야 한다.

<bean id="throwawayHandler" class="org.springframework.web.servlet.mvc.throwaway.ThrowawayControllerHandlerAdapter" />


[출처] - 이 종 화 (ingenuity.egloos.com) -