[Spring] Spring MVC : MVC 프레임워크 구현 - 유연한 컨트롤러

어댑터 패턴

어댑터 패턴이란 서로 호환되지 않는 인터페이스를 연결하는 디자인 패턴이다. 이 패턴을 사용하면 기존 코드를 수정하지 않고 이미 존재하는 클래스를 함께 사용할 수 있다.

지금까지 개발한 프론트 컨트롤러는 한 가지 방식의 컨트롤러 인터페이스만 사용할 수 있다. ControllerV3와 ControllerV4는 완전히 다른 인터페이스이기 때문이다. 따라서 두 컨트롤러는 호환이 불가능하다. 그러나 어댑터 패턴을 적용함으로써 이 점을 해결한다. 즉, 각 컨트롤러 클래스의 코드를 수정하지 않고 프론트 컨트롤러가 다양한 컨트롤러를 사용할 수 있도록 만든다.

구조 및 동작

• 핸들러 : 컨트롤러의 더 넓은 의미의 이름이다. 핸들러라고 부르는 이유는 어댑터가 있어 컨트롤러의 개념 뿐만 아니라 어떤 종류이든 어댑터만 있으면 다 처리할 수 있기 때문이다.
• 핸들러 어댑터 : 핸들러(컨트롤러)와 프론트 컨트롤러 사이에서 중개자 역할을 한다. 이 덕에 프론트 컨트롤러는 다양한 핸들러를 지원할 수 있다.

MyHandlerAdapter - 어댑터 인터페이스

public interface MyHandlerAdapter {

    boolean supports(Object handler);

    ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException;
}

• boolean supports(Object handler)
  • handler는 컨트롤러다.
  • 어댑터가 해당 컨트롤러 또는 핸들러를 처리할 수 있는지 판단하는 메서드다.
• ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
  • 어댑터가 컨트롤러 또는 핸들러를 호출하는 메서드다.
  • 컨트롤러가 ModelView를 반환하지 못하면 어댑터가 직접 생성해서라도 반환해야 한다.
  • 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터의 메서드를 통해 컨트롤러가 호출된다.

ControllerV3HandlerAdapter - V3 어댑터 구현체

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 modelView = controller.process(paramMap);

        return modelView;
    }

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

• public boolean supports(Object handler) { return (handler instanceof ControllerV3); }
  • 이 핸들러 어댑터가 ControllerV3를 처리할 수 있는지 판단한다.
• ControllerV3 controller = (ControllerV3) handler
  • handler를 ControllerV3 타입으로 변환하여 V3 컨트롤러의 메서드를 사용한다.

ControllerV4HandlerAdapter - V4 어댑터 구현체

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

    @Override
    public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException {
        ControllerV4 controller = (ControllerV4) handler;

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

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

        ModelView modelView = new ModelView(viewName);
        modelView.setModel(model);

        return modelView;
    }

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

• public boolean supports(Object handler) { return (handler instanceof ControllerV4); }
  • 어댑터가 ControllerV4를 처리할 수 있는지 판단한다.
• ModelView modelView = new ModelView(viewName)
  • 어댑터가 호출하는 ControllerV4는 뷰 이름을 반환한다. 그런데 어댑터는 뷰 이름이 아니라 ModelView를 반환해야 한다. 그래서 어댑터는 컨트롤러가 반환한 뷰 이름을 통해 ModelView를 생성하여 반환한다. 이것이 어댑터가 필요한 이유이다.

FrontControllerServletV5 - 프론트 컨트롤러

@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 request, HttpServletResponse response) throws ServletException, IOException {
        Object handler = getHandler(request);
        if (handler == null) {
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }

        MyHandlerAdapter adapter = getHandlerAdapter(handler);
        ModelView modelView = adapter.handle(request, response, handler);

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

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

    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 request) {
        String requestURI = request.getRequestURI();
        return handlerMappingMap.get(requestURI);
    }

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

• 핸들러 매핑정보 등록
  • private final Map<String, Object> handlerMappingMap = new HashMap<>(), initHandlerMappingMap()
  • 이전에는 컨트롤러를 매핑해서 사용했지만, 이제는 어댑터를 사용하기 때문에 컨트롤러 뿐만 아니라 어댑터가 지원하는 모든 것은 사용할 수 있다. 그래서 이름을 더 넓은 범위를 의미하는 핸들러로 변경했다. 그래서 HashMap에 저장되는 타입도 컨트롤러 인터페이스가 아니라 최상위 객체인 Object로 변경되었다.
• 핸들러 매핑
  • Object handler = getHandler(request)
  • 핸들러 매핑정보에서 해당 URI에 매핑된 핸들러를 찾아서 반환한다.
• 핸들러를 처리할 수 있는 어댑터 조회
  • MyHandlerAdapter adapter = getHandlerAdapter(handler)
  • 핸들러를 처리할 수 있는 어댑터를 adapter.supports(handler)를 통해서 찾는다. 핸들러가 ControllerV3 인터페이스를 구현했다면 ControllerV3HandlerAdapter 객체가 반환된다.
• 어댑터 호출
  • ModelView modelView = adapter.handle(request, response, handler)
  • 어댑터를 통해 핸들러의 메서드를 호출하고 그 결과를 handler()의 반환타입에 맞추어 반환한다.