[Spring MVC] 12. 어댑터 패턴을 이용한 유연한 컨트롤러 - V5

해당 글은 김영한님의 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의를 수강하고 정리한 게시글입니다.

어댑터 패턴을 이용한 유연한 컨트롤러 - V5

만약 어떤 개발자는 이전 “ControllerV3“ 방식으로 개발하고 싶고, 어떤 개발자는 “ControllerV4“ 방식으로 개발하고 싶다면 어떻게 해야할까?

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

public interface ControllerV4 {
    String process(Map<String, String> paramMap, Map<String, Object> model);
}

어댑터 패턴을 사용해서 프론트 컨트롤러가 다양한 방식의 컨트롤러를 처리할 수 있도록 변경해보자.

참고: 지금까지 우리가 개발한 프론트 컨트롤러는 한가지 방식의 컨트롤러 인터페이스만 사용할 수 있다. 그럼으로 110v 전기 콘센트와 220v 전기 콘센트와 같이 호환이 불가능하다. 이럴 때 사용하는 것이 어댑터인것 처럼 우리 코드에도 어댑터 패턴을 적용해보자.

 

[V5 구조]

• 핸들러 어댑터: 중간에 어댑터 역할을 하는 어댑터가 추가되었는데 이름이 핸들러 어댑터이다. 여기서 어댑터 역할을 해주는 덕분에 다양한 종류의 컨트롤러를 호출할 수 있다.
• 핸들러: 컨트롤러의 이름을 더 넓은 범위인 핸들러로 변경했다. 그 이유는 이제 어댑터가 있기 때문에 꼭 컨트롤러의 개념 뿐만 아니라 어떠한 것이든 해당하는 종류의 어댑터만 있으면 다 처리할 수 있기 때문이다.

어댑터 인터페이스

어댑터 인터페이스는 실제 구현할 어댑터의 설계도이다.

[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를 반환해야 한다.

(실제 컨트롤러가 ModelView를 반환하지 못하면(V4는 뷰의 논리이름 반환) 직접 생성해서 반환해줘야 한다)

이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해 실제 컨트롤러가 호출되게 된다.

V3 어댑터

[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(Object handler) 메서드는 “ControllerV3”를 처리할 수 있는 어댑터인지 확인하는 역할이다.

 

handle() 메서드에서 handler를 V3 컨트롤러로 형변환 해주고(확인을 하기때문에 가능) V3 형식에 맞쳐서 호출후 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());
    }

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

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

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

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

컨트롤러(Controller) 핸들러(Handler)
이전에는 컨트롤러를 직접 매핑해서 사용했다. 그런데 이제는 어댑터를 사용하기 때문에, 컨트롤러 뿐만 아니라 어댑터가 지원하기만 하면, 어떤 것이라도 URL에 매핑해서 사용할 수 있다. 그래서 이름을 컨트롤러에서 더 넒은 범위의 핸들러로 변경했다.

 

“handlerMappingMap” 객체는 매핑 정보의 값이 ControllerV3, V4 같은 인터페이스에서 아무 값이나 받을 수 있도록 Map<String, Object> 타입으로 선언해주었다.

 

생성자에서는 핸들러 매핑과 어댑터를 등록한다.

 

getHandler(request) 메서드는 URL에 매핑된 핸들러(컨트롤러) 객체를 찾아서 반환한다.

 

이후, getHandlerAdapter(handler) 메서드에 핸들러를 인자로 넣어 handlerAdapters에 등록된 어댑터 중 핸들러를 처리할 수 있는지 찾는다. 그 후 처리할 수 있다면 해당 핸들러 어댑터(ControllerV3HandlerAdapter)가 반환된다.

 

이후, adapter.handle(request, response, handler) 메서드를 통해 실제 어댑터가 호출되어 어댑터에서 핸들러(컨트롤러)를 호출하고 어댑터에서 결과(ModelView)를 맞추어 반환해주게 된다.

 

이제 다양한 버전을 지원할 수 있는 프론트 컨트롤러가 완성 되었다. 여기에 V4 컨트롤러를 사용할 수 있도록 추가해보자.

컨트롤러 V4 추가

컨트롤러 V4를 사용하기 위해서는 프론트 컨트롤러 V5에 V4의 컨트롤러 매핑 정보와 “ControllerV4HandlerAdapter”를 만들어 추가해주면 된다.

 

[FrontControllerServletV5.initHandlerMappingMap() 에 추가]

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

    //V4 추가부분
    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());

}

위와 같이 v5에서 사용될 v4 컨트롤러 매핑정보를 추가해준다.

 

[FrontControllerServletV5.initHandlerAdapters() 에 추가]

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

핸들러 어댑터도 위와 같이 추가해서 넣고 이제 핸들러 어댑터를 만들어주면 된다.

 

[ControllerV4HandlerAdapter]

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);
        HashMap<String, Object> model = new HashMap<>();

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

기본적으로 V3핸들러 어댑터와 같이 MyHandlerAdapter의 supports, handle을 구현해주면된다.

 

V4핸들러 어댑터의 차이는 V4 컨트롤러의 process() 메서드 반환값이 String이기 때문에, 처리 후 ModelView형식으로 만들어서 반환해주면된다.(이 구조가 마치 110v 전기 콘센트를 220v 전기 콘센트로 변경하는 어댑터의 역할이다)

 

V1 ~ V5 까지 진행된 컨셉이 스프링 MVC의 핵심 구조이다.

이제부터는 진짜 스프링 MVC 구조를 이해해보자