Adapter 패턴

"어댑터 패턴"을 사용하면 ControllerV1 ~ ControllerV4까지, 여러 버전의 컨트롤러를 갈아끼워서 사용할 수 있습니다.

어댑터 패턴을 사용해서 Front-Controller가 다양한 방식의 컨트롤러를 처리할 수 있도록 해보겠습니다.

 

그림 구조로 확인하면 다음과 같습니다.

핸들러 : 컨트롤러의 넓은 범위의 이름으로, 그냥 컨트롤러로 이해하셔도 됩니다.

핸들러-어댑터 : 핸들러(컨트롤러)의 어댑터로 다양한 종류의 핸들러(컨트롤러)를 호출할 수 있게 해줌. 자세한 설명은 코드를 통해 진행하겠습니다.

 

0. Client에서 HTTP요청을 보냅니다.

 

1. 요청 URL Pattern과 매핑된 FrontController에서 핸들러-매핑 정보를 조회합니다.

 

2. 핸들러를 처리할 수 있는 어댑터가 있는지 조회합니다.

 

3. 조회한 어댑터에서 handle(handler) 메소드를 통해 핸들러(컨트롤러)를 호출해 컨트롤러 로직 실행 후 ModelView를 리턴합니다.

 

4. Front-Controller에서 리턴된 ModelView의 viewName을 통해 viewResolver해서 viewPath를 얻어냅니다.

 

5. viewPath를 통해 MyView에서 JSP로 forward 해줍니다.

 

순서과정을 읽어봐도 한 번에 와닿지 않아 코드를 통해 살펴보겠습니다.

 

우선 FrontController가 ModelView를 리턴받기 전과 후로 나눠서 설명하겠습니다.

 

우선 FrontController 전체 코드입니다.

package hello.servlet.web.frontcontroller.v5;

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v3.controller.MemberFormControllerV3;
import hello.servlet.web.frontcontroller.v3.controller.MemberListControllerV3;
import hello.servlet.web.frontcontroller.v3.controller.MemberSaveControllerV3;
import hello.servlet.web.frontcontroller.v4.controller.MemberFormControllerV4;
import hello.servlet.web.frontcontroller.v4.controller.MemberListControllerV4;
import hello.servlet.web.frontcontroller.v4.controller.MemberSaveControllerV4;
import hello.servlet.web.frontcontroller.v5.adapter.ControllerV3HandlerAdapter;
import hello.servlet.web.frontcontroller.v5.adapter.ControllerV4HandlerAdapter;

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


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

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

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

    }

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

        System.out.println("handler = " + handler);
        MyHandlerAdapter adapter = getHandlerAdapter(handler);
        ModelView mv = adapter.handle(request, response, handler);

        String viewPath = viewResolver(mv.getViewName());
        System.out.println("viewPath = " + viewPath);
        MyView view = new MyView(viewPath);
        view.render(mv.getModel(),request,response);
    }

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

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


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

}

 

ModelView 리턴 받기 전의 Front-Controller Logic

1. 요청 URI - 컨트롤러 매핑

private final Map<String, Object> handlerMappingMap = new HashMap<>();

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

}

HashMap을 이용해 URI-Handler(컨트롤러) 매핑을 통해 config

 

2. Handler-Adapter 추가

private final List<MyHandlerAdapter> handlerAdapters = new ArrayList<>();

FrontControllerServletV5()
{
    initHandlerMappingMap(); // URI - Handler
    initHandlerAdapters(); // Handler - Adapter
}

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

여기서 MyHandlerAdapter는 핸들러-어댑터의 인터페이스입니다.

다형성을 이용하기 위해 인터페이스를 사용했습니다.

public interface MyHandlerAdapter {
    boolean supports(Object handler);

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

어댑터에서는 두 가지 메소드를 사용합니다. 

1. boolean supports(Object handler) : 어댑터가 이 핸들러를 처리할 수 있는지에 대한 여부
2. ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException : 어댑터가 실제 핸들러를 호출하고 ModelView를 반환. 이전에는 프론트컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해서 실제 컨트롤러가 호출됩니다.

우선 실제 어댑터를 구현해보겠습니다.

 

ControllerV3 어댑터 입니다.

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의 인스턴스인지에 대한 여부 리턴
• handle : 핸들러를 ControllerV3로 Object->ControllerV3로 타입변환 ▶︎ request를 통해 전달된 파라미터로 paramMap을 얻음 ▶︎ 컨트롤러를 호출해 process(파라미터 할당, JSP 동적 리소스 모델에 put 등 ) 한 후 생성된 ModelView를 리턴

즉 어댑터에서 핸들러(컨트롤러)가 호출되고 ModelView를 리턴합니다.

 

다음은 ControllerV4 어댑터입니다.

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

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v3.ControllerV3;
import hello.servlet.web.frontcontroller.v4.ControllerV4;
import hello.servlet.web.frontcontroller.v5.MyHandlerAdapter;
import org.springframework.ui.Model;

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

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

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

}

• supports : 이 핸들러(컨트롤러)가 ControllerV3의 인스턴스인지에 대한 여부 리턴
• handle : ControllerV4에서는 model과 paramMap을 process의 파라미터로 넘겨주고 viewName을 리턴받기 때문에 위와 같이 구현 했습니다. viewName을 주입받은 ModelView을 리턴하고 process를 통해 업데이트된 model을 set해준 ModelView를 리턴합니다.

3. 요청 URI에 맞는 핸들러(컨트롤러)와 어댑터 가져오기

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

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

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

• getHandler(request) : 요청 URI를 통해 핸들러맵에 매핑하여 핸들러(컨트롤러)를 가져옵니다.
• getHandlerAdapter(getHandler를 통해 얻은 handler) : List를 iterator하게 살펴보고 supports 메소드를 이용해 해당 핸들러와 호환되는 어댑터를 가져옵니다. 

ModelView를 리턴받은 후의 Front-Controller Logic

package hello.servlet.web.frontcontroller.v5;

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v3.controller.MemberFormControllerV3;
import hello.servlet.web.frontcontroller.v3.controller.MemberListControllerV3;
import hello.servlet.web.frontcontroller.v3.controller.MemberSaveControllerV3;
import hello.servlet.web.frontcontroller.v4.controller.MemberFormControllerV4;
import hello.servlet.web.frontcontroller.v4.controller.MemberListControllerV4;
import hello.servlet.web.frontcontroller.v4.controller.MemberSaveControllerV4;
import hello.servlet.web.frontcontroller.v5.adapter.ControllerV3HandlerAdapter;
import hello.servlet.web.frontcontroller.v5.adapter.ControllerV4HandlerAdapter;

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


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

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

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

    }

    @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 viewPath = viewResolver(mv.getViewName());
        MyView view = new MyView(viewPath);
        view.render(mv.getModel(),request,response);
    }

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

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


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

}

adapter의 handle을 통해 리턴된 ModelView에서 viewName(뷰 논리 이름)필드를 ViewResolver 메소드를 사용해 실제 viewPath를 가지고 MyView 객체를 만들어 JSP로 forward합니다.

 

<정리>

1. 어댑터를 도입해서 프레임워크를 확장성있게 설계 해보았습니다.

2. 다형성을 이용한 어댑터 덕분에 기존 구조를 유지하면서 프레임워크의 기능을 확장할 수 있었습니다.

 

여기에 어노테이션을 지원하는 어댑터를 사용해서 컨트롤러를 더 편리하게 발전시킬 수도 있습니다. 

이전 포스팅과 이번 포스팅에서는 여러가지 MVC 구조를 만들어보고 확장해보았습니다.

다음 포스팅에서는 스프링 부트를 이용한 MVC 구조를 알아보겠습니다. 

 

<참고자료>

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의

https://chinggin.tistory.com/586

핸들러 매핑과 핸들러 어댑터