[Spring] - formBackingObject()와 @ModelAttribute

formBackingObject()에 대한 설명

formBackingObject()는 Spring MVC에서 주로 **SimpleFormController**를 사용할 때, 폼 데이터를 처리하기 위해 사용됩니다. 이 메서드는 폼을 처리하는 컨트롤러가 요청에 대해 빈 객체를 생성하거나 초기화된 데이터를 제공할 때 사용됩니다.

formBackingObject()는 요청이 들어왔을 때 새로운 폼 객체를 반환하거나 기존 데이터를 로드하여 폼에 바인딩하는 역할을 합니다. 예를 들어, 사용자가 폼을 처음 제출할 때는 비어있는 객체를 제공하고, 수정 폼을 제출할 때는 기존 데이터를 불러와서 해당 객체를 제공합니다.

formBackingObject()의 역할:

1. 초기값 설정: 사용자가 폼을 처음 열 때 기본값을 설정할 수 있습니다.
2. 기존 데이터 로드: 이미 존재하는 데이터를 기반으로 폼을 채울 수 있습니다.

 

@ModelAttribute를 통한 처리

Spring 3.x부터는 @ModelAttribute를 사용하여 컨트롤러 메서드에서 폼 객체를 자동으로 바인딩할 수 있습니다. 이전에는 SimpleFormController의 formBackingObject() 메서드를 사용했지만, Spring 4.x와 5.x에서는 어노테이션 기반의 처리로 점차 변화하고 있습니다.

 

@ModelAttribute의 역할:

• @ModelAttribute는 폼 데이터를 자동으로 바인딩하며, 뷰에서 참조할 수 있는 객체를 생성합니다.
• @ModelAttribute는 컨트롤러 메서드에서 사용되는 바인딩된 폼 객체를 자동으로 반환하거나 뷰에 전달할 수 있습니다.

@ModelAttribute를 사용하면, Spring이 요청 파라미터를 자동으로 모델 객체에 바인딩하여 제공하고, 폼 객체를 뷰로 전달하는 과정을 간소화할 수 있습니다.

 

예시 코드: @ModelAttribute 사용

@Controller
@RequestMapping("/apps/user/register")
public class UserRegistrationController {

    @Autowired
    private IUserService userService;

    @Autowired
    private IDepartmentService departmentService;

    /**
     * @ModelAttribute를 사용하여 등록 폼에 대한 초기 데이터를 준비합니다.
     * 로그인 정보를 기반으로 부서 정보 등을 설정할 수 있습니다.
     */
    @ModelAttribute("userForm")
    public UserForm getUserForm(HttpServletRequest request) {
        // 세션에서 로그인 정보 가져오기
        LoginInfoBean loginInfo = (LoginInfoBean) WebUtils.getSessionAttribute(request, EEPublic.SESSION_LOGIN_INFO);
        
        // 로그인된 사용자의 부서 정보 가져오기
        String accountId = loginInfo.getAccountId();
        Department department = departmentService.getDepartmentByAccountId(accountId);

        // 폼 객체 생성
        UserForm userForm = new UserForm();
        userForm.setAccountId(accountId);
        userForm.setDepartment(department.getName());

        return userForm;
    }

    /**
     * GET 요청을 처리하는 메서드.
     * 등록 폼을 보여줄 때 사용됩니다.
     */
    @GetMapping
    public String showRegistrationForm(Model model) {
        // 부서 목록을 가져오기
        List<Department> departments = departmentService.getAllDepartments();

        // 폼 데이터와 부서 목록을 모델에 추가
        model.addAttribute("departments", departments);

        return "user/registrationForm"; // 등록 폼 JSP로 이동
    }

    /**
     * POST 요청을 처리하는 메서드.
     * 사용자 등록을 처리하고 성공 시 다른 페이지로 리다이렉트합니다.
     */
    @PostMapping
    public String submitRegistrationForm(@ModelAttribute("userForm") UserForm userForm) {
        // 폼에서 제출된 데이터로 사용자를 등록하는 서비스 호출
        userService.registerUser(userForm);

        // 등록 후 사용자를 다른 페이지로 리다이렉트
        return "redirect:/apps/user/registrationSuccess";
    }
}

설명

1. @ModelAttribute:
   • getUserForm() 메서드에서 @ModelAttribute 어노테이션을 사용하여 UserForm 객체를 반환합니다.
   • 이 객체는 컨트롤러 메서드가 실행되기 전에 Spring에 의해 자동으로 모델에 추가되고, 뷰에서 참조할 수 있습니다.
   • @ModelAttribute 메서드는 폼 객체를 준비하고, 뷰에서 사용할 데이터를 제공하는 데 사용됩니다.
2. @GetMapping:
   • showRegistrationForm() 메서드는 GET 요청을 처리하며, 사용자 등록 폼을 반환합니다.
   • 등록 폼에 필요한 부서 목록을 가져와 모델에 추가하고, JSP 뷰로 전달합니다.
3. @PostMapping:
   • submitRegistrationForm() 메서드는 POST 요청을 처리하며, 폼 데이터를 제출받아 UserForm 객체에 자동으로 바인딩된 데이터를 사용합니다.
   • 폼 데이터를 통해 사용자를 등록하고, 등록 완료 후 다른 페이지로 리다이렉트합니다.

 

JSP에서 @ModelAttribute 사용 예시

폼 데이터를 처리하는 JSP 파일에서 @ModelAttribute로 바인딩된 데이터를 사용할 수 있습니다.

<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>

<form:form modelAttribute="userForm" action="/apps/user/register" method="post">
    <label for="accountId">Account ID</label>
    <form:input path="accountId" id="accountId" />

    <label for="department">Department</label>
    <form:select path="department">
        <form:options items="${departments}" itemValue="name" itemLabel="name" />
    </form:select>

    <button type="submit">Register</button>
</form:form>

@ModelAttribute의 특징과 장점

• 자동 바인딩: @ModelAttribute를 사용하면, HTTP 요청 파라미터를 자동으로 객체에 바인딩합니다.
• 객체의 모델화: @ModelAttribute는 폼 객체와 모델 객체를 연결해줍니다. 이 객체는 뷰에서 참조할 수 있습니다.
• 선처리: @ModelAttribute가 메서드 레벨에서 사용될 때, 해당 메서드는 컨트롤러 메서드 실행 전에 자동으로 호출되어, 객체를 초기화하거나 데이터를 준비하는 데 사용됩니다.

@ModelAttribute의 동작 순서

1. 뷰에 객체 제공: @ModelAttribute가 적용된 메서드는, 모델에 객체를 자동으로 추가하고, 이 객체는 뷰에서 사용될 수 있습니다.
2. 폼 바인딩: 사용자가 폼을 제출하면, @ModelAttribute 어노테이션이 적용된 메서드가 있는 컨트롤러 메서드에서 폼 데이터를 객체로 바인딩하여 사용할 수 있게 합니다.

 

버전별 변화

• Spring 2.x: SimpleFormController가 주로 사용되었으며, formBackingObject()와 onSubmit() 메서드를 통해 폼 데이터와 처리를 담당했습니다.
• Spring 3.x: @ModelAttribute가 도입되어 어노테이션 기반 컨트롤러가 주류로 자리 잡았습니다. SimpleFormController의 사용은 점차 감소하고, @ModelAttribute를 통해 폼 객체 바인딩 및 데이터 처리 방식이 전환되었습니다.
• Spring 4.x / 5.x: @ModelAttribute를 활용한 RESTful 방식으로 발전하고, XML 설정 방식에서 JavaConfig 방식으로 전환되었습니다.

 

결론

• **@ModelAttribute**는 Spring 3.x 이후로 사용되는 중요한 어노테이션으로, 폼 객체 자동 바인딩, 모델 객체 준비 등을 담당합니다.
• SimpleFormController 대신 어노테이션 기반의 @ModelAttribute 방식이 더 많이 사용되며, 컨트롤러 메서드에서 직접 폼 객체를 관리하고 자동으로 바인딩하는 방식으로 발전했습니다.