[Spring] Spring MVC : MVC 프레임워크 구현 - Model 도입

Model 도입 목적

• 서블릿 종속성 제거
  현재 구조는 프론트 컨트롤러뿐 만 아니라 실제 비즈니스 로직을 수행하는 컨트롤러도 서블릿 기술을 사용하고 있다. 그런데 컨트롤러를 실행할 때, 요청 파라미터 정보를 Java의 Map으로 전달한다면 컨트롤러는 서블릿을 사용하지 않을 수 있다. 즉, 컨트롤러에서 서블릿 종속성을 제거함으로써 구현 코드를 단순화하고 테스트 코드를 쉽게 작성할 수 있다.

• 뷰 이름 중복 제거 WEB-INF/views .jsp
  컨트롤러에서 지정하는 뷰 이름의 앞, 뒤에 중복이 있는 것을 확인할 수 있다. 컨트롤러는 뷰의 논리적 경로를 반환하고, 실제 경로는 프론트 컨트롤러에서 처리하도록 구현한다. 이로 인해 향후 뷰의 위치가 수정되어도 프론트 컨트롤만 수정하면 된다.

  • 실제 경로 -> 논리적 경로 : WEB-INF/views/members.jsp -> members

구조 및 동작

컨트롤러를 호출하는 부분은 이전 버전과 동일하지만 컨트롤러에 전달할 매개변수와 컨트롤러의 반환값이 다르다. 컨트롤러의 서블릿 종속성을 제거하기 위해 HttpServletRequest 객체가 아닌 Java의 Map을 매개변수로 전달하며 반환값으로 ModelView 객체를 사용한다. ModelView는 뷰의 논리적 경로와 뷰를 렌더링 하는 데 필요한 데이터를 담는 모델을 가지고 있다.

ModelView 클래스

public class ModelView {
    private String viewName;
    private Map<String, Object> model = new HashMap<>();

    public ModelView(String viewName) {
        this.viewName = viewName;
    }

    public String getViewName() {
        return viewName;
    }

    public void setViewName(String viewName) {
        this.viewName = viewName;
    }

    public Map<String, Object> getModel() {
        return model;
    }

    public void setModel(Map<String, Object> model) {
        this.model = model;
    }
}

• 뷰의 논리적 경로와 렌더링에 필요한 데이터를 담는 모델을 필드로 갖는다.
• 모델은 단순히 Java의 Map이므로 뷰에 필요한 데이터를 key, value로 저장하면 된다.

ControllerV3 - 인터페이스

public interface ControllerV3 {
    ModelView process(Map<String, String> prarmMap);
}

• 이 컨트롤러는 서블릿 기술을 사용하지 않는다. 따라서 구현이 매우 단순해지고 테스트 하기도 쉽다.
• HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 paramMap에 담아서 호출하고, 응답 결과로 뷰 이름과 뷰를 렌더링하기 위해 필요한 Model 데이터를 포함하는 ModelView 객체를 반환하면 된다.

MemberFormControllerV3 - 구현체

public class MemberFormControllerV3 implements ControllerV3 {

    @Override
    public ModelView process(Map<String, String> prarmMap) {
        return new ModelView("new-form");
    }
}

public class MemberSaveControllerV3 implements ControllerV3 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public ModelView process(Map<String, String> paramMap) {
        String username = paramMap.get("username");
        int age = Integer.parseInt(paramMap.get("age"));

        Member member = new Member(username, age);
        memberRepository.save(member);

        ModelView modelView = new ModelView("save-result");
        modelView.getModel().put("member", member);

        return modelView;
    }
}

public class MemberListControllerV3 implements ControllerV3 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public ModelView process(Map<String, String> prarmMap) {
        List<Member> members = memberRepository.findAll();

        ModelView modelView = new ModelView("members");
        modelView.getModel().put("members", members);

        return modelView;
    }
}

• new-form, save-result, members : ModelView 객체를 생성할 때 각 view의 논리적인 이름으로 생성하고, 실제 경로는 프론트 컨트롤러에서 처리한다.
• paramMap.get("username") : 사용자의 요청 정보는 map으로 조회할 수 있다.
• modelView.getModel().put("members", members) : 모델은 단순한 map이므로 모델에 뷰에서 필요한 member 객체를 담고 반환한다.

FrontControllerServletV3 - 프론트 컨트롤러

@WebServlet(name = "frontControllerServletV3", urlPatterns = "/front-controller/v3/*")
public class FrontControllerServletV3 extends HttpServlet {

    private Map<String, ControllerV3> controllerMap = new HashMap<>();

    public FrontControllerServletV3() {
        controllerMap.put("/front-controller/v3/members/new-form", new MemberFormControllerV3());
        controllerMap.put("/front-controller/v3/members/save", new MemberSaveControllerV3());
        controllerMap.put("/front-controller/v3/members", new MemberListControllerV3());
    }

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String requestURI = request.getRequestURI();

        ControllerV3 controllerV3 = controllerMap.get(requestURI);
        if (controllerV3 == null) {
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }

        Map<String, String> paramMap = createParamMap(request);
        ModelView modelView = controllerV3.process(paramMap);

        String viewName = modelView.getViewName();
        MyView view = viewResolver(viewName);

        view.render(modelView.getModel(), request, response);
    }

    private MyView viewResolver(String viewName) {
        return new MyView("/WEB-INF/views/" + viewName + ".jsp");
    }

    private Map<String, String> createParamMap(HttpServletRequest request) {
        Map<String, String> paramMap = new HashMap<>();
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> paramMap.put(paramName, request.getParameter(paramName)));

        return paramMap;
    }
}

• createParamMap(request) : HttpServletReqeust 객체에서 파라미터 정보를 Java의 Map으로 변환한다. 그리고 해당 Map을 컨트롤러에 전달하면서 호출한다.
• viewResolver() : 컨트롤러에서 ModelView에 저장된 뷰의 논리적 경로를 실제 경로로 변환한다. 그리고 뷰의 실제 경로가 저장된 MyView 객체를 반환한다.
• view.render(modelView.getModel(), request, response) : 뷰 객체는 모델에 저장된 데이터를 활용해서 HTML 화면을 렌더링한다.

MyView 클래스

public class MyView {
    private String viewPath;

    public MyView(String viewPath) {
        this.viewPath = viewPath;
    }

    public void render(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }

    public void render(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        modelToRequestAttribute(model, request);

        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }

    private void modelToRequestAttribute(Map<String, Object> model, HttpServletRequest request) {
        model.forEach((key, value) -> request.setAttribute(key, value));
    }
}

• 뷰의 실제 경로를 저장한다.
• modelToRequestAttribute() : Map 형태의 모델에 있는 정보를 request 객체에 저장한다. JSP는 request.getAttribute()로 데이터를 조회하기 때문이다.
• render(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) : 모델에 있는 정보를 reuest 객체에 저장하고, 뷰의 실제 경로를 이용하여 포워딩하여 JSP를 렌더링한다.