📋 Spring MVC - 4. MVC 프레임워크 만들기

2021-05-04글

MVC 프레임워크 만들기

프론트 컨트롤러 패턴

프론트 컨트롤러도 서블릿이다.
요청을 모두 받고 요청에 맞는 컨트롤러를 호출한다.

특징

프론트 컨트롤러 서블릿 하나로 클라이언트의 요청을 받고, 요청에 맞는 컨트롤러를 찾아서 호출한다.
입구를 하나로 묶는다.
프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿을 사용하지 않아도 된다.

스프링 웹 MVC와 프론트 컨트롤러

스프링 웹 MVC의 핵심도 바로 FrontController이다. (DispatcherServlet이 프론트 컨트롤러 패턴으로 되어있다.)

ControllerV1을 인터페이스로 만들고 이를 구현한 Controller들을 만든다.

public class MemberFormControllerV1 implements ControllerV1 {
    @Override
    public void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String viewPath = "/WEB-INF/views/new-form.jsp";
        RequestDispatcher requestDispatcher = request.getRequestDispatcher(viewPath); // 컨트롤러에서 뷰로 이동
        requestDispatcher.forward(request, response); // 서블릿에서 JSP를 호출한다.
    }
}

FrontControllerServletV1

@WebServlet(name = "frontControllerServletV1", urlPatterns = "/front-controller/v1/*")
public class FrontControllerServletV1 extends HttpServlet {
    private Map<String, ControllerV1> controllerMap = new HashMap<>();

    public FrontControllerServletV1(Map<String, ControllerV1> controllerMap) {
        controllerMap.put("/front-controller/v1/members/new-form",
                new MemberFormControllerV1());
        controllerMap.put("/front-controller/v1/members/save",
                new MemberSaveControllerV1());
        controllerMap.put("/front-controller/v1/members",
                new MemberListControllerV1());
    }

    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        String requestURI = req.getRequestURI();
        ControllerV1 controller = controllerMap.get(requestURI);
        if (controller == null) {
            resp.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        controller.process(req, resp);
    }
}

Controller 정보를 가진 서블릿인 FrontContoller를 구현한다.

• urlPatterns : "/front-controller/v1/"를 포함한 하위 모든 요청을 하나의 서블릿에서 받아들인다.
• controllerMap : key-매핑 URL, value-호출될 컨트롤러
• service() : reqeustURI를 조회하여 실제 호출할 컨트롤러를 찾고 해당 컨트롤러를 실행(process())한다.

여러 Controller와 서블릿이 하나의 JSP를 재사용하고 있다.

---

View 분리

Controller에서 View로 이동하는 부분이 중복된다.
Controller는 MyView만 반환해주면 된다.

ControllerV2

public interface ControllerV2 {
    MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}

• 인터페이스를 구현하므로 반환 타입을 맞출 수 있다.

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

MemberFormControllerV2

public class MemberFormControllerV2 implements ControllerV2 {
    @Override
    public MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        return new MyView("/WEB-INF/views/new-form.jsp");
    }
}

• viewPath를 가지고 있는 MyView 객체를 반환한다.

FrontControllerServletV2

@WebServlet(name = "frontControllerServletV2", urlPatterns = "/front-controller/v2/*")
public class FrontControllerServletV2 extends HttpServlet {
    private Map<String, ControllerV2> controllerMap = new HashMap<>();

    public FrontControllerServletV2(Map<String, ControllerV2> controllerMap) {
        controllerMap.put("/front-controller/v2/members/new-form",
                new MemberFormControllerV2());
        controllerMap.put("/front-controller/v2/members/save",
                new MemberSaveControllerV2());
        controllerMap.put("/front-controller/v2/members",
                new MemberListControllerV2());
    }

    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        String requestURI = req.getRequestURI();
        ControllerV2 controller = controllerMap.get(requestURI);
        if (controller == null) {
            resp.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        MyView view = controller.process(req, resp);
        view.render(req, resp);
    }
}

---

Model 추가

서블릿 종속성 추가

컨트롤러 입장에서 HttpServletRequest, HttpServletResponse가 필요하지 않다.
요청 파라미터를 Map으로 넘기면 컨트롤러가 서블릿이 아니어도 동작할 수 있다.

뷰 이름 중복 제거

현재 컨트롤러에서 지정하는 뷰 이름에는 중복(/WEB-INF/views/)이 존재한다.
컨트롤러는 뷰의 논리 이름을 반환하고, 물리 이름은 프론트 컨트롤러에서 처리하도록 변경해보자.
논리적 물리적 이름을 구분하면 나중에 변경할 때 컨트롤러를 변경할 일이 없다.

ModelView

Model을 전달하기 위해서 request.setAttribute() 를 사용하여 데이터를 저장하고 뷰에 전달했다.
서블릿의 종속성을 제거하기 위해, Model을 따로 만들고 View 이름까지 전달하는 객체를 만든다.

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

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

    // ...
}

ControllerV3

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

• ModelView를 반환하도록 한다.

MemberSaveControllerV3

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 mv = new ModelView("save-result");
        mv.getModel().put("member", member);
        return mv;
    }
}

• 논리 이름을 ModelView 객체에 넣어 생성하도록 한다.
• 모델에 뷰에 필요한 객체를 담고 ModelView 객체를 반환한다.

FrontControllerServletV3 일부

@Overrideprotected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {        String requestURI = req.getRequestURI();        ControllerV3 controller = controllerMap.get(requestURI);        if (controller == null) {            resp.setStatus(HttpServletResponse.SC_NOT_FOUND);            return;        }        // param Map        Map<String, String> paramMap = createParamMap(req);        ModelView mv = controller.process(paramMap);        String viewName = mv.getViewName(); // 논리 이름 ex) new-form        MyView view = viewResolver(viewName);        view.render(mv.getModel(), req, resp);    }    private Map<String, String> createParamMap(HttpServletRequest req) {        Map<String, String> paramMap = new HashMap<>();        req.getParameterNames().asIterator()                .forEachRemaining(paramName -> paramMap.put(paramName, req.getParameter(paramName)));        return paramMap;    }    private MyView viewResolver(String viewName) {        MyView view = new MyView("/WEB-INF/views/" + viewName + ".jsp");        return view;    }}

• createParamMap() : HttpServletRequest의 파라미터 정보를 Map으로 변경한다.
• viewResolver() : 컨트롤러가 반환한 논리 뷰 이름을 실제 물리 뷰 경로로 변경한다.
• view.render(mv.getModel(), req, resp) : 뷰 객체를 통해 HTML 화면을 렌더링한다.

MyView

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

---

단순하고 실용적인 컨트롤러

컨트롤러 인터페이스를 구현하면서 항상 ModelView 객체를 생성하고 반환해야 하는 부분이 번거롭다.
컨트롤러는 View의 이름만 변경하도록, 실용성 있도록 변경한다.

ControllerV4

public interface ControllerV4 {    /**     *     * @param paramMap     * @param model     * @return viewName     */    String process(Map<String, String> paramMap, Map<String, Object> model);}

• view 이름을 반환하도록 변경한다.

public class MemberSaveControllerV4 implements ControllerV4 {    private MemberRepository memberRepository = MemberRepository.getInstance();    @Override    public String process(Map<String, String> paramMap, Map<String, Object> model) {        String username = paramMap.get("username");        int age = Integer.parseInt(paramMap.get("age"));        Member member = new Member(username, age);        memberRepository.save(member);        model.put("member", member);        return "save-result";    }}

• Controller에서는 필요한 값을 꺼내고, 비즈니스 로직을 호출한 후 viewName만을 반환한다.

FrontControllerServletV4

@WebServlet(name = "frontControllerServletV4", urlPatterns = "/front-controller/v2/*")public class FrontControllerServletV4 extends HttpServlet {    private Map<String, ControllerV4> controllerMap = new HashMap<>();    public FrontControllerServletV4(Map<String, ControllerV4> controllerMap) {        controllerMap.put("/front-controller/v2/members/new-form",                new MemberFormControllerV4());        controllerMap.put("/front-controller/v2/members/save",                new MemberSaveControllerV4());        controllerMap.put("/front-controller/v2/members",                new MemberListControllerV4());    }    @Override    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {        String requestURI = req.getRequestURI();        ControllerV4 controller = controllerMap.get(requestURI);        if (controller == null) {            resp.setStatus(HttpServletResponse.SC_NOT_FOUND);            return;        }        // param Map        Map<String, String> paramMap = createParamMap(req);          // model         Map<String, Object> model = new HashMap<>();        String viewName = controller.process(paramMap, model);        MyView view = viewResolver(viewName);        view.render(model, req, resp);    }    private Map<String, String> createParamMap(HttpServletRequest req) {        Map<String, String> paramMap = new HashMap<>();        req.getParameterNames().asIterator()                .forEachRemaining(paramName -> paramMap.put(paramName, req.getParameter(paramName)));        return paramMap;    }    private MyView viewResolver(String viewName) {        MyView view = new MyView("/WEB-INF/views/" + viewName + ".jsp");        return view;    }}

• 프론트 컨트롤러에서 model을 만들고 각 Controller에 paramMap과 model을 넘겨 처리를 하고, viewName을 반환받는다.
• modelView에서 model을 꺼낼 필요가 없다.

하지만, 지금 ControllerV4 인터페이스로 받을 수 있는 컨트롤러를 제한하고 있다.

---

유연한 Controller - 어댑터 패턴

지금까지의 프론트 컨트롤러는 한가지 인터페이스만 사용이 가능했었다.
어떠한 컨트롤러도 호환이 가능하도록 어댑터 패턴을 사용한다.

• 핸들러 어댑터 : 중간에 어댑터 역할을 하는 어댑터가 추가되었다. 이 덕분에 다양한 종류의 컨트롤러를 호출할 수 있다.
• 기존에는 프론트 컨트롤러가 바로 컨트롤러를 호출하였지만, 이제는 어댑터를 통해서 호출한다.
• 핸들러 : 컨트롤러의 좀 더 넓은 범위. 어댑터가 있기 때문에 컨트롤러 개념 뿐만 아니라 해당하는 어댑터만 있으면 처리가 가능하다.

MyHandlerAdapter

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

• supports(Object handler) : 어댑터가 해당 컨트롤러를 처리할 수 있는지 반환
• handle(...) : 어댑터는 실제 컨트롤러를 호출하고 결과로 ModelView를 반환한다.
• 만약 컨트롤러가 ModelView를 반환하지 못하면, 어댑터가 직접 생성한다.
• 프론트 컨트롤러가 아닌 어댑터가 실제 컨트롤러를 호출한다.

ControllerV3HandlerAdapter

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) throws ServletException, IOException {
        ControllerV3 controller = (ControllerV3) handler;
        Map<String, String> paramMap = createParamMap(request);
        ModelView mv = controller.process(paramMap);
        return mv;
    }

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

• supports()로 ControllerV3 타입인지 확인하고 맞다면 호출한다.

@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());    }    private void initHandlerAdapters() {        handlerAdapters.add(new ControllerV3HandlerAdapter());    }    @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);        String viewName = mv.getViewName(); // 논리 이름 ex) new-form        MyView view = viewResolver(viewName);                view.render(mv.getModel(), req, resp);    }    private MyHandlerAdapter getHandlerAdapter(Object handler) {        for (MyHandlerAdapter adapter : handlerAdapters) {            if (adapter.supports(handler)) {                return adapter;            }        }        throw new IllegalArgumentException("handler adapter를 찾을 수 없습니다. handler " + handler);    }    private Object getHandler(HttpServletRequest req) {        String requestURI = req.getRequestURI();        Object handler = handlerMappingMap.get(requestURI);        return handler;    }    private Map<String, String> createParamMap(HttpServletRequest req) {        Map<String, String> paramMap = new HashMap<>();        req.getParameterNames().asIterator()                .forEachRemaining(paramName -> paramMap.put(paramName, req.getParameter(paramName)));        return paramMap;    }    private MyView viewResolver(String viewName) {        MyView view = new MyView("/WEB-INF/views/" + viewName + ".jsp");        return view;    }}

• 생성자 : 핸들러 매핑과 어댑터를 초기화한다.
• 매핑 정보인 handlerMappingMap 이 Object Map으로 아무 타입이나 받을 수 있다.
• 핸들러 매핑
• 핸들러를 처리할 수 있는 어댑터 조회
• 어댑터 호출

ControllerV4HandlerAdapter 예제

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

    public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException {
        ControllerV4 controller = (ControllerV4) handler;
        Map<String, String> paramMap = createParamMap(request);
        HashMap<String, Object> model = new HashMap<>();

        //  viewName만 반환할 경우 ModelView 객체로 만들어주는 역할도 한다.
        String viewName = controller.process(paramMap, model);

        ModelView mv = new ModelView(viewName);
        mv.setModel(model);
        return mv;
    }

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

• 어댑터가 호출하는 ControllerV4는 viewName만 반환하는데, 이때 어댑터에서 이를 ModelView 객체로 만들어 반환한다.

프론트 컨트롤러 입장에서는 핸들러 어댑터에만 의존하고 있다.

이 MVC 프레임 워크는 역할과 구현이 분리되어 있다.
모든 것을 인터페이스로 만들고 구현하고 싶은 부분만 주입하면 완벽! (스프링 MVC는 뷰와 뷰리졸버 다 인터페이스로 구현되어있다.)
어떤 핸들러를 추가하고 싶어도 우리는 핸들러어댑터만 구현해주면 된다!

ex) @RequestMapping()

RequestMappingHandlerAdapter : 위 어노테이션이 붙은 핸들러를 처리해주는 어댑터