[Spring] MVC 패턴

MVC 패턴의 등장

역할
하나의 서블릿이나 JSP만으로 비즈니스 로직 + 뷰 렌더링까지 처리 -> 너무 많은 역할을 담당함 -> 유지보수가 어려워짐

변경의 라이프 사이클
UI 수정과 비즈니스 로직의 변경의 라이프 사이클이 다름

기능 특화
JSP와 같은 뷰 템플릿은 화면을 렌더링하는데 최적화 -> 해당 부분의 업무만 담당하는 것이 효과적

Model View Controller
하나의 서블릿이나 JSP로 처리 -> 컨트롤러(Controller) + 뷰(View)의 영역으로 서로 역할을 나눔

컨트롤러: HTTP 요청을 받아서 파라미터 검증, 비즈니스 로직 실행, 뷰에 전달할 결과 데이터 조회 후 모델에 세팅
모델: 뷰에 출력할 데이터를 담아둠
뷰: 모델에 담겨있는 데이터를 사용해 화면을 그림

SpringMVC의 구조

동작순서

핸들러 조회: 핸들러 매핑을 통해 요청된 URL에 매핑된 핸들러(컨트롤러)를 조회
핸들러 어댑터 조회: 핸들러를 실행할 수 있는 핸들러 어댑터를 조회
핸들러 어댑터 실행: 핸들러 어댑터를 실행
핸들러 실행: 핸들러 어댑터가 실제 핸들러를 실행
ModelAndView 반환: 핸들러 어댑터는 핸들러가 반환하는 정보를 ModelAndView로 변환해서 반환
viewResolver 호출: 뷰 리졸버를 찾고 실행
View 반환: 뷰 리졸버는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체 반환
뷰 렌더링: 뷰 객체를 통해서 뷰를 렌더링

예제코드

해당 부분의 정확한 구현 코드는 깃허브에서 확인할 수 있다.
아래 코드는 대략적인 구조를 설명하기 위해 일부만 첨부하였다.

ModelView

package hello.servlet.web.frontcontroller;

import java.util.HashMap;
import java.util.Map;

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;
    }
}

뷰에 전달할 Model 객체를 담은 ModelView

View

package hello.servlet.web.frontcontroller;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Map;

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 req, HttpServletResponse resp) throws ServletException, IOException {
        modelToRequestAttribute(model, req);
        RequestDispatcher dispatcher = req.getRequestDispatcher(viewPath);
        dispatcher.forward(req, resp);
    }

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

RequestDispatcher.forward()를 통해 뷰를 렌더링하면서 model 객체를 넘겨줌

HandlerAdapter

package hello.servlet.web.frontcontroller.v5;

import hello.servlet.web.frontcontroller.ModelView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public interface MyHandlerAdapter {
    boolean supports(Object handler);
    ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler);
}

핸들러 어댑터 인터페이스
boolean supports(Object handler) : handler는 컨트롤러, 어댑터가 해당 컨트롤러를 처리 가능한 지 판단
ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) : 어댑터가 실제 컨트롤러를 호출하고 ModelView를 반환

DispatchServlet

package hello.servlet.web.frontcontroller.v5;

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v3.MemberFormControllerV3;
import hello.servlet.web.frontcontroller.v3.MemberListControllerV3;
import hello.servlet.web.frontcontroller.v3.MemberSaveControllerV3;
import hello.servlet.web.frontcontroller.v4.ControllerV4;
import hello.servlet.web.frontcontroller.v4.MemberFormControllerV4;
import hello.servlet.web.frontcontroller.v4.MemberListControllerV4;
import hello.servlet.web.frontcontroller.v4.MemberSaveControllerV4;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@WebServlet(name = "frontControllerServletV5", urlPatterns = "/front-controller/v5/*")
public class FrontControllerServletV5 extends HttpServlet {

    private final Map<String, Object> handlerMappingMap = new HashMap<>();
    private final List<MyHandlerAdapter> handlerAdapters = new ArrayList<>();

    public FrontControllerServletV5() {
        initHandlerMappingMap();
        initHandlerAdapters();
    }

    private void initHandlerMappingMap() {
        handlerMappingMap.put("/front-controller/v5/v3/members/new-form", new MemberFormControllerV3());
        handlerMappingMap.put("/front-controller/v5/v3/members/save", new MemberSaveControllerV3());
        handlerMappingMap.put("/front-controller/v5/v3/members", new MemberListControllerV3());

        handlerMappingMap.put("/front-controller/v5/v4/members/new-form", new MemberFormControllerV4());
        handlerMappingMap.put("/front-controller/v5/v4/members/save", new MemberSaveControllerV4());
        handlerMappingMap.put("/front-controller/v5/v4/members", new MemberListControllerV4());
    }

    private void initHandlerAdapters() {
        handlerAdapters.add(new ControllerV3HandlerAdapter());
        handlerAdapters.add(new ControllerV4HandlerAdapter());
    }

    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        Object handler = getHandler(req);
        if(handler == null) {
            resp.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }

        MyHandlerAdapter adapter = getHandlerAdapter(handler);
        ModelView mv = adapter.handle(req, resp, handler);

        MyView view = viewResolver(mv.getViewName());
        view.render(mv.getModel(), req, resp);
    }

    private Object getHandler(HttpServletRequest req) {
        String requestURI = req.getRequestURI();
        return handlerMappingMap.get(requestURI);
    }

    private MyHandlerAdapter getHandlerAdapter(Object handler) {
        for (MyHandlerAdapter adapter : handlerAdapters) {
            if (adapter.supports(handler)) {
                return adapter;
            }
        }
        throw new IllegalArgumentException("handler adapter를 찾을 수 없습니다. handler=" + handler);
    }

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

MVC 패턴의 그림에서 DispatcherServlet 역할을 담당

1. Object handler = getHandler(req);

: URL을 통해 핸들러 조회

해당 요청의 URL에 매핑되는 핸들러(컨트롤러)가 없으면 NOT_FOUND(404) 반환

2. MyHandlerAdapter adapter = getHandlerAdapter(handler);

: adapter.supports(handler)가 true이면 해당 핸들러 어댑터 반환

해당 핸들러(컨트롤러)를 처리할 수 있는 어댑터를 반환

3. adapter.handle(req, resp, handler);

: 핸들러 어댑터를 실행

핸들러가 ModelView를 반환하지 않는 경우 어댑터에서 ModelView 생성해서 반환

4. Controller controller = (Controller) handler; handler.process(...)

: (어댑터 내부) 핸들러 실행

어댑터 내부에서 핸들러(컨트롤러) 호출

5. ModelView mv = adapter.handler(req, resp, handler);

: 어댑터에서 핸들러의 반환 정보를 ModelView로 반환

6. viewResolver(mv.getViewName())

: View의 논리적 이름을 받아서 실제 물리적 이름으로 반환해줌

7. MyView view = viewResolver(mv.getViewName());

: 렌더링 역할을 담당할 뷰 객체 반환

8. view.render(mv.getModel(), req, resp);

: model객체를 뷰에 넘겨주면서 뷰 렌더링

메서드 내부에서 DispatcherServlet.forward() 호출

HttpSerlvetRequest 대신 Map을 받아서 ModelView를 반환

Controller Interface

package hello.servlet.web.frontcontroller.v3;

import hello.servlet.web.frontcontroller.ModelView;

import java.util.Map;

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

HttpSerlvetRequest 대신 Map을 받아서 ModelView를 반환하는 인터페이스

Controller

package hello.servlet.web.frontcontroller.v3;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.ModelView;

import java.util.List;
import java.util.Map;

public class MemberListControllerV3 implements ControllerV3 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

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

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

        return mv;
    }
}

컨트롤러가 직접 ModelView를 생성해서 반환
해당 ModelView에 직접 값 세팅

ControllerHandlerAdapter

package hello.servlet.web.frontcontroller.v5;

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.v3.ControllerV3;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

public class ControllerV3HandlerAdapter implements MyHandlerAdapter{
    @Override
    public boolean supports(Object handler) {
        return (handler instanceof ControllerV3);
    }

    @Override
    public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        ControllerV3 controller = (ControllerV3) handler;
        Map<String, String> paramMap = createParamMap(request);
        return controller.process(paramMap);
    }

    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;
    }
}

핸들러(컨트롤러)를 실행할 핸들러 어댑터
직접 ModelView를 생성해서 반환하므로 핸들러 실행결과를 어댑터 실행 결과로 그대로 넘겨줌

HttpSerlvetRequest 대신 paramMap과 model을 map으로 받고 viewName을 반환