MVC 프레임워크 만들기, 단순하고 실용적인 컨트롤러 - v4, 유연한 컨트롤러 - v5

  출처 : 인프런 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 (유료) / 김영한님  
  유료 강의이므로 정리에 초점을 두고 코드는 일부만 인용  

https://inf.run/Gmptq

---

1. 단순하고 실용적인 컨트롤러 - v4

1) V4

(1) 실용성 추가

• v3는 서블릿 종속성을 제거하고 뷰 경로의 중복을 제거하면서 설계가 잘된 컨트롤러가 되었음
• 그러나 개발자 입장에서는 컨트롤러 인터페이스를 구현할 때 항상 ModelView객체를 생성하고 반환해야하는 번거로운 부분이 아직 존재함
• 좋은 프레임워크는 아키텍처도 중요하지만 개발자가 단순하고 편리하게 사용할 수 있어야(실용성이 있어야)함

(2) v4의 구조

• v3 컨트롤러를 개발자가 편리하게 개발할 수 있도록 구조를 조금 변경
• 기본적인 구조는 동일하지만 Controller가 ModelView를 반환하지 않고 ViewName만 반환하는 구조

(3) ControllerV4

• v4패키지 생성후 작성
• ControllerV4의 인터페이스는 ModelView가 아닌 String으로 반환되는 메서드를 선언
• model 객체는 파라미터로 전달되기 때문에 그냥 사용하면되고 결과로 뷰의 이름만 반환하면됨

package hello.servlet.web.frontcontroller.v4;

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

 

(4) MemberFormControllerV4, MemberSaveControllerV4, MemberListControllerV4 - 회원등록, 회원저장, 회원조회 컨트롤러V4

• 컨트롤러는 모델객체가 아닌 단순히 뷰의 논리 이름만 반환함
• model이 파라미터로 전달되기 때문에 모델을 직접 생성하지않고 model.put()으로 모델에 데이터를 저장

package hello.servlet.web.frontcontroller.v4.controller;

public class MemberFormControllerV4 implements ControllerV4 {
    @Override
    public String process(Map<String, String> paramMap, Map<String, Object> model) {
        return "new-form";
    }
}

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

public class MemberListControllerV4 implements ControllerV4 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public String process(Map<String, String> paramMap, Map<String, Object> model) {
        List<Member> members = memberRepository.findAll();
        model.put("members", members);
        return "members";
    }
}

 

(5) FrontControllerServletV4 - 프론트컨트롤러v4

• v3버전과 거의 동일하지만 모델 객체를 프론트 컨트롤러에서 생성해서 넘겨줌
• 컨트롤러에서 모델 객체에 값을 담으면 여기에 그대로 담겨있게 됨
• 컨트롤러가 직접 뷰의 논리이름을 반환하므로 반환된 값을 사용하여 실제 물리 뷰를 찾을 수 있음

package hello.servlet.web.frontcontroller.v4;

@WebServlet(name = "frontControllerServletV4", urlPatterns = "/front-controller/v4/*")
public class FrontControllerServletV4 extends HttpServlet {

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

    public FrontControllerServletV4() {
        controllerMap.put("/front-controller/v4/members/new-form", new MemberFormControllerV4());
        controllerMap.put("/front-controller/v4/members/save", new MemberSaveControllerV4());
        controllerMap.put("/front-controller/v4/members", new MemberListControllerV4());
    }

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

        Map<String, String> paramMap = createParamMap(request);
        Map<String, Object> model = new HashMap<>();    // 추가
        String viewName = controller.process(paramMap, model);
        
        MyView view = viewResolver(viewName);
        view.render(model, request, response);
    }

    private Map<String, String> createParamMap(HttpServletRequest request) {
        // 메서드 로직 동일
    }

    private MyView viewResolver(String viewName) {
        // 메서드 로직 동일
    }
}

 

(6) 정리

• 기존 구조에서 객체였던 모델을 파라미터로 넘기고 뷰의 논리이름을 반환한다는 작은 아이디어의 적용으로 컨트롤러를 구현하는 개발자 입장에서는 개발 코드가 매우 간편해짐
• 중요한 사실은 여기까지 한번에 발전된 것이 아니라 프레임워크가 점진적으로 발전하는 과정 속에서 이러한 방법들이 찾게된 것임
• 프레임워크나 공통 기능이 수고로워야 사용하는 개발자가 편리해짐

---

2. 유연한 컨트롤러 - v5

1) V5 - V3 컨트롤러 적용

(1) 만약 한 프로젝트에 컨트롤러의 방식을 v3 방식과 v4 방식으로 각각 적용하고 싶다면? -> 어댑터 패턴을 사용하여 해결

• 지금까지 개발한 프론트 컨트롤러는 한가지 방식의 컨트롤러 인터페이스만 사용이 가능함
• Controllerv3과 ControllerV4는 완전히 다른 인터페이스이므로 호환이 불가능
• 어댑터 패턴을 이용하여 프론트 컨트롤러가 다양한 방식의 컨트롤러를 처리

(2) V5 구조 - 어댑터 패턴적용

• 핸들러 어댑터 : 다양한 종류의 컨트롤러를 호출할 수 있는 어댑터 추가
• 핸들러 : 컨트롤러의 이름을 더 넓은 범위의 핸들러로 변경, 어댑터가 존재하기 때문에 컨트롤러의 개념을 넘어서 어떤 것이든 해당하는 종류의 어댑터만 있으면 다 처리할 수 있기 때문

 

(3) MyHandlerAdapter - 인터페이스

• v5 패키지생성 후 작성
• 어댑터의 구현 방식으로 2가지의 메서드가 선언된 어댑터용 인터페이스
• 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해서 실제 컨트롤러가 호출 됨
• supports(): 어댑터가 매개변수의 handler(컨트롤러)를 처리할 수 있는지 판단하는 메서드
• ModelView handle(): 어댑터가 실제 컨트롤러를 호출하고 그 결과로 ModelView를 반환하며 실제 컨트롤러가 ModelView를 반환하지 못하면 어댑터가 직접 생성해서라도 반환해야함
• 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 해당 어댑터를 통해서 실제 컨트롤러가 호출됨

package hello.servlet.web.frontcontroller.v5;

public interface MyHandlerAdapter {
    // 어댑터가 해당 컨트롤러를 처리할 수 있는지 판단하는 메서드
    boolean supports(Object handler);
    
    // 어댑터는 실제 컨트롤러를 호출 후 결과를 ModelView로 반환
    // 실제 컨트롤러가 ModelView를 반환하지 못하면 어댑터가 ModelView를 직접 생성해서라도 반환해야 함
    ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
                    throws ServletException, IOException;
}

 

(4-1) ControllerV3HandlerAdapter

• adapter패키지를 생성 후 작성
• MyHandlerAdapter인터페이스를 구현하여 ControllerV3 버전을 지원하는 어댑터를 구현

package hello.servlet.web.frontcontroller.v5.adapter;

public class ControllerV3HandlerAdapter implements MyHandlerAdapter {
	
    // ControllerV3를 처리할 수 있는 어댑터를 뜻함
    @Override
    public boolean supports(Object handler) {
        return (handler instanceof ControllerV3);
    }

    // handler를 컨트롤러 v3로 변환 후 v3형식에 맞도록 호출
    // supports()를 통해 ControllerV3만 지원하기 때문에 타입 변환이 걱정이 없음
    // ControllerV3는 ModelView를 반환하기때문에 그대로 ModelView를 반환하면 됨
    @Override
    public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) ... {
        ControllerV3 controller = (ControllerV3) handler;

        Map<String, String> paramMap = createParamMap(request);
        ModelView mv = controller.process(paramMap);

        return mv;
    }
    
    private Map<String, String> createParamMap(HttpServletRequest request) {
        // ... 로직 동일
    }
}

 

(4-2) supports(Object handler)

• ControllerV3를 처리할 수 있는 어댑터를 뜻함
• handler가 ControllerV3이면 true를 반환

(4-3) ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler)

• handler를 컨트롤러 V3로 변환한 다음 V3형식에 맞도록 호출
• supports()를 통해 ControllerV3만 지원하도록 검증했기 때문에 타입 변환은 걱정없이 실행해도 됨
• ControllerV3는 ModelView를 반환하므로 그대로 ModelView를 반환

(5) FrontControllerServletV5

• 컨트롤러(Controller) -> 핸들러(Handler): 이전에는 컨트롤러를 직접 맵핑했지만 이제는 어댑터를 사용하여 컨트롤러 뿐만 아니라 어댑터가 지원하기만 하면 어떤 것이라도 URL에 매핑해서 사용 가능(더 넓은 범위의 핸들러로 명칭을 변경한 이유)
• 생성자: 생성자에서 핸들러 매핑과 어댑터를 초기화(등록)함
• 매핑정보: private final Map<String, Object> handlerMappingMap = new HashMap<>();를 보면 매핑 정보의 값이 ControllerV3, ControllerV4같은 인터페이스에서 아무 값이나 받을 수 있는 Object로 변경되었음
• 핸들러 매핑: getHandler()메서드로 핸들러 매핑하는 코드를 별도의 메서드로 추출, 매핑 정보인 handlerMappingMap에서 URL에 매핑된 핸들러(컨트롤러) 객체를 찾아서 반환
• 핸들러를 처리할 수 있는 어댑터 조회: getHandlerAdapter()메서드로 핸들러를 처리할 수 있는 어댑터를 조회하는 코드를 별도의 메서드로 추출, handler를 처리할 수 있는 어댑터를 adapter.supports(handler)를 통해서 찾고 handler가 ControllerV3인터페이스를 구현했다면 ControllerV3HandlerAdapter()가 반환됨
• 어댑터 호출: ModelView mv = adapter.handle(request, response, handler)메서드를 통해 실제 어댑터가 호출되고 어댑터는 핸들러(컨트롤러)를 호출하고 그 결과를 어댑터에 맞추어 반환함

package hello.servlet.web.frontcontroller.v5;

@WebServlet(name ="frontControllerServletV5" , urlPatterns ="/front-controller/v5/*")
public class FrontControllerServletV5 extends HttpServlet {
    
    // 매핑 정보
    // 매핑 정보의 값을 아무 값이나 받을 수 있는 Object로 변경
    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 request, HttpServletResponse response)... {
    
       // 핸들러 매핑
       // 핸들러 매핑 정보인 handlerMappingMap에서 URL에 매핑된 핸들러 객체를 찾아서 반환
        Object handler = getHandler(request);
        if (handler == null) {
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        // 핸들러를 처리할 수 있는 어댑터 조회
        MyHandlerAdapter adapter = getHandlerAdapter(handler);

        // 어댑터 호출
        // adapter.handle메서드를 통해 실제 어댑터가 호출
        // 어댑터는 handler(컨트롤러)를 호출하고 그결과를 어댑터에 맞춰서 반환
        ModelView mv = adapter.handle(request, response, handler);

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

        view.render(mv.getModel(), request, response);

    }
    
    // 핸들러 매핑 메서드
    private Object getHandler(HttpServletRequest request) {
        String requestURI = request.getRequestURI();
        return handlerMappingMap.get(requestURI);
    }
    
    // 어댑터를 조회하는 메서드
    // 반복문으로 adapter.supports(handler)를 통해 검증
    // handler가 ControllerV3를 구현했다면 controllerV3HandlerAdapter 객체가 반환
    // 아니면 예외 반환
    private MyHandlerAdapter getHandlerAdapter(Object handler) {
        for (MyHandlerAdapter adapter : handlerAdapters) {
            if (adapter.supports(handler)) {
                return adapter;
            }
        }
        throw new IllegalArgumentException("handler adapter를 찾을 수 없습니다" + handler);
    }

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

2) V5 - V4 컨트롤러도 같이 적용

(1) FrontControllerServletV5 - 수정

• FrontControllerServletV5에 v4컨트롤러도 사용할 수 있도록 변
• initHandlerMappingMap()메서드에 ControllerV4를 사용하는 컨트롤러 들을 추가
• initHandlerAdapters()메서드에 해당 컨트롤러를 처리할 수 있는 어댑터인 ControllerV4HandlerAdapter도 추가(생성해야함)

@WebServlet(name = "frontControllerServletV5", urlPatterns = "/front-controller/v5/*")
public class FrontControllerServletV5 extends HttpServlet {
    // .. 기존 코드 동일

    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());  // 추가
    }
    
    // ... 기존 코드 동일
}

 

(2) ControllerV4HandlerAdapter

• supports()로 handler가 ControllerV4인 경우에만 처리하도록 검증
• 실행로직: handler를 ControllerV4로 캐스팅하고 paramMap과 model을 만들어서 해당 컨트롤러를 호출 후 viewName을 반환
• 어댑터 변환: 어댑터가 호출하는 ControllerV4는 뷰의 이름을 반환하지만 어댑터는 뷰의 이름이 아니라 ModelView를 만들어서 반환해야하는데, 여기서 어댑터가 필요한 이유가 나옴
• 어댑터를 통해서 ControllerV4가 뷰의 이름을 반환했지만 어댑터는 이것을 마치 중간에서 110v 전기 콘센트를 220v 전기 콘센트로 변경하듯이 ModelView로 만들어서 형식을 맞추어서 반환함

package hello.servlet.web.frontcontroller.v5.adapter;

public class ControllerV4HandlerAdapter implements MyHandlerAdapter {
    
    // handler가 ControllerV4인 경우에만 처리하는 어댑터
    @Override
    public boolean supports(Object handler) {
        return (handler instanceof ControllerV4);
    }

    @Override
    public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException {
    
        // handler를 ControllerV4로 캐스팅 후 paramMap, model을 만들어 해당 컨트롤러를 호출
        ControllerV4 controller = (ControllerV4) handler;

        Map<String, String> paramMap = createParamMap(request);
        HashMap<String, Object> model = new HashMap<>();

        String viewName = controller.process(paramMap, model);

        // 어댑터 변환 : viewName을 ModelView타입으로 변환
        // 어댑터가 호출하는 ControllerV4는 viewName을 반환하지만 어댑터는 ModelView를 반환해야함
        ModelView mv = new ModelView(viewName);
        mv.setModel(model);

        return mv;
    }
    
    private Map<String, String> createParamMap(HttpServletRequest request) {
        // 해당 메서드의 로직은 동일
    }
}

---

3. MVC 프레임워크 만들기 정리

(1) 점진적인 프레임워크 발전 (v1 ~ v5)

• v1: 프론트 컨트롤러 도입 - 기존 구조를 최대한 유지하면서 프론트 컨트롤러를 도입
• v2: View 분류 - 단순 반복되는 view 로직을 분리
• v3: Model 추가 - 서블릿 종속성을 제거하고 뷰 이름 중복을 제거
• v4: 단순하고 실용적인 컨트롤러 - v3와 거의 비슷하지만 ModelView를 직접 생성하지 않도록 편리한 인터페이스를 제공
• v5: 유연한 컨트롤러 - 어댑터 도입하여 프레임워크를 유연하고 확장성 있게 설계
• 여기에 애노테이션을 사용해서 컨트롤러를 더 편리하게 발전 시킬 수 있는데 애노테이션을 지원하는 어댑터를 추가하기만 하면 됨
• 그러나 스프링이 이미 구현해 두었는데 그것이 스프링 MVC임

(2) 스프링 MVC

• 지금까지 작성한 코드는 스프링 MVC 프레임워크의 핵심 코드의 축약버전이며 v5 버전과 구조도 거의 같음
• 스프링 MVC는 인터페이스와 애노테이션으로 대부분 구현 되어있음