Spring DispatcherServlet(FrontController 패턴) 코드로 이해하기

REFERENCE  

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

---

목차
1. FrontController 패턴 특징
2. 컨트롤러 인터페이스 도입
3. 이 인터페이스를 구현한 컨트롤러를 만들어보자.
4. FrontController를 만들어보자.
5. 뷰를 처리하는 객체를 만들자.
6. 어댑터 패턴 
7. 어댑터용 인터페이스
8. 실제 어댑터를 구현해보자. 
9. 핸들러 어댑터용 FrontController
10. ModelView
11. 요약

1. FrontController 패턴 특징

프론트 컨트롤러 도입 후

1) 프론트 컨트롤러 서블릿 하나로 클라이언트의 요청을 받음

2) 프론트 컨트롤러가 요청에 맞는 컨트롤러를 찾아서 호출

3) 입구를 하나로!

4) 공통 처리 가능

5) 프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿을 사용하지 않아도 됨

 

---

2. 컨트롤러 인터페이스 도입

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

• 각 컨트롤러들은 이 인터페이스를 구현하면 된다. 프론트 컨트롤러는 이 인터페이스를 호출해서 구현과 관계없이 로직의 일관성을 가져갈 수 있다.
• 이 컨트롤러는 서블릿 기술을 전혀 사용하지 않는다. 따라서 구현이 매우 단순해지고, 테스트 코드 작성시 테스트 하기 쉽다. 
• HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 paramMap에 담아서 호출해주면 된다. 
• model 객체는 파라미터로 전달되기 때문에 그냥 사용하면 되고, 결과로 뷰의 이름만 반환해주면 된다.

---

3. 이제 이 인터페이스를 구현한 컨트롤러를 만들어보자.

1) 회원 등록 컨트롤러

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

• 정말 단순하게 new-form 이라는 뷰의 논리 이름만 반환하면 된다. 실제 물리적인 이름은 프론트 컨트롤러에서 처리한다.

2) 회원 저장 컨트롤러

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

paramMap.get("username");

• 파라미터 정보는 map에 담겨있다. map에서 필요한 요청 파라미터를 조회하면 된다. 

model.put("member", member);

• 모델이 파라미터로 전달되기 때문에, 모델을 직접 생성하지 않아도 된다.

3) 회원 목록 컨트롤러

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

---

4. 이제 FrontController를 만들어보자.

@WebServlet(name = "frontControllerServletV4", urlPatterns = "/front-controller/v4/*")
public class FrontControllerServletV4 extends HttpServlet {
    
    private Map<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) {
        Map<String, String> paramMap = new HashMap<>();
        request.getParameterNames().asIterator()
               .forEachRemaining(paramName -> paramMap.put(paramName, request.getParameter(paramName)));
        return paramMap;
    }
      
    private MyView viewResolver(String viewName) {
        return new MyView("/WEB-INF/views/" + viewName + ".jsp");
    } 
}

urlPatterns = "/front-controller/v1/*"

• /front-controller/v1 를 포함한 하위 모든 요청은 이 서블릿에서 받아들인다.

controllerMap.put("/front-controller/v4/members/new-form", new MemberFormControllerV4());

• key: 매핑 URL / value: 호출될 컨트롤러

ControllerV4 controller = controllerMap.get(requestURI);
if (controller == null) {
    response.setStatus(HttpServletResponse.SC_NOT_FOUND);
    return;
}

• 먼저 requestURI 를 조회해서 실제 호출할 컨트롤러를 controllerMap 에서 찾는다. 만약 없다면 404(SC_NOT_FOUND) 상태 코드를 반환한다. 컨트롤러를 찾고 controller.process(paramMap, model); 을 호출해서 해당 컨트롤러를 실행한다.

createParamMap()

• HttpServletRequest에서 파라미터 정보를 꺼내서 Map으로 변환한다. 그리고 해당 Map( paramMap )을 컨트롤러에 전달하면서 호출한다. 

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

• 모델 객체를 프론트 컨트롤러에서 생성해서 넘겨준다. 컨트롤러에서 모델 객체에 값을 담으면 여기에 그대로 담겨있게 된다. 

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

• controller.process의 반환 타입이 String 이므로 프론트 컨트롤러는 컨트롤러의 호출 결과로 String 을 반환 받는다.
• 컨트롤로가 직접 뷰의 논리 이름을 반환하므로 이 값을 사용해서 실제 물리 경로가 있는 MyView 객체를 반환한다.

view.render(model, request, response);

• 뷰 객체의 render() 는 모델 정보도 함께 받는다. 
• JSP는 request.getAttribute() 로 데이터를 조회하기 때문에, 모델의 데이터를 꺼내서 request.setAttribute() 로 담아둔다. 
• 그리고 view.render() 를 호출하면 dispatcher.forward(request, response) 로직을 수행해서 JSP가 실행된다.
• 프론트 컨트롤러의 도입으로 MyView 객체의 render() 를 호출하는 부분을 모두 일관되게 처리할 수 있다. 

---

5. 뷰를 처리하는 객체를 만들자.

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);
    }
    
    public void render(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        modelToRequestAttribute(model, request);
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
    
    private void modelToRequestAttribute(Map<String, Object> model, HttpServletRequest request) {
        model.forEach((key, value) -> request.setAttribute(key, value));
    }
}

 

---

6. 어댑터 패턴 

지금까지 우리가 개발한 프론트 컨트롤러는 한가지 방식의 컨트롤러 인터페이스만 사용할 수 있다. 

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

ControllerV3 , ControllerV4 는 완전히 다른 인터페이스이다. 따라서 호환이 불가능하다. 

마치 v3는 110v이고, v4는 220v 전기 콘센트 같은 것이다. 이럴 때 사용하는 것이 바로 어댑터이다. 

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

 

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

---

7. 어댑터용 인터페이스

어댑터는 이렇게 구현해야 한다는 어댑터용 인터페이스이다.

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를 반환하지 못하면, 어댑터가 ModelView를 직접 생성해서라도 반환해야 한다.
• 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해서 실제 컨트롤러가 호출된다. 

---

8. 실제 어댑터를 구현해보자. 

1) 먼저 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) {
        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;
    }
}

public boolean supports(Object handler) {
    return (handler instanceof ControllerV3);
}

• ControllerV3 을 처리할 수 있는 어댑터를 뜻한다.

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

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

---

2) ControllerV4를 지원하는 어댑터를 구현하자.

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

public boolean supports(Object handler) {
    return (handler instanceof ControllerV4);
}

• handler 가 ControllerV4 인 경우에만 처리하는 어댑터이다.

ControllerV4 controller = (ControllerV4) handler;

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

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

• handler를 ControllerV4로 케스팅 하고, paramMap, model을 만들어서 해당 컨트롤러를 호출한다. 그리고 viewName을 반환 받는다.

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

return mv;

• 어댑터가 호출하는 ControllerV4 는 뷰의 이름을 반환한다. 그런데 어댑터는 뷰의 이름이 아니라 ModelView 를 만들어서 반환해야 한다. 여기서 어댑터가 꼭 필요한 이유가 나온다. ControllerV4 는 뷰의 이름을 반환했지만, 어댑터는 이것을 ModelView로 만들어서 형식을 맞추어 반환한다. 마치 110v 전기 콘센트를 220v 전기 콘센트로 변경하듯이!

---

9. 핸들러 어댑터용 FrontController

@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());
        
        //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());
    }
    
    private void initHandlerAdapters() {
        handlerAdapters.add(new ControllerV3HandlerAdapter());
        handlerAdapters.add(new ControllerV4HandlerAdapter()); //V4 추가
    }
    
    @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);
        
        MyView view = viewResolver(mv.getViewName());
        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("handler adapter를 찾을 수 없습니다. handler=" + handler);
    }
    
    private MyView viewResolver(String viewName) {
        return new MyView("/WEB-INF/views/" + viewName + ".jsp");
    } 
}

1) 컨트롤러(Controller) -> 핸들러(Handler)

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

 

2) 생성자

public FrontControllerServletV5() { 
    initHandlerMappingMap(); //핸들러 매핑 초기화 
    initHandlerAdapters(); //어댑터 초기화
}

• 생성자는 핸들러 매핑과 어댑터를 초기화(등록)한다.

3) 매핑 정보

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

• 매핑 정보의 값이 ControllerV3 , ControllerV4 같은 인터페이스에서 아무 값이나 받을 수 있는 Object 로 변경되었다.

4) 핸들러 매핑

Object handler = getHandler(request);

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

• 핸들러 매핑 정보인 handlerMappingMap 에서 URL에 매핑된 핸들러(컨트롤러) 객체를 찾아서 반환한다.

5) 핸들러를 처리할 수 있는 어댑터 조회

MyHandlerAdapter adapter = getHandlerAdapter(handler);

for (MyHandlerAdapter adapter : handlerAdapters) {
    if (adapter.supports(handler)) {
        return adapter;
    }
}

• handler 를 처리할 수 있는 어댑터를 adapter.supports(handler) 를 통해서 찾는다. 
• handler가 ControllerV3 인터페이스를 구현했다면, ControllerV3HandlerAdapter 객체가 반환된다.

6) 어댑터 호출

ModelView mv = adapter.handle(request, response, handler);

• 어댑터의 handle(request, response, handler) 메서드를 통해 실제 어댑터가 호출된다.
• 어댑터는 handler(컨트롤러)를 호출하고 그 결과를 어댑터에 맞추어 반환한다.
• ControllerV3HandlerAdapter 의 경우 어댑터의 모양과 컨트롤러의 모양이 유사해서 변환 로직이 단순하다.

---

10. ModelView

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

    public ModelView(String viewName) {
        this.viewName = viewName;
    }
    
    public String getViewName() {
        return viewName;
    }
    
    public void setViewName(String viewName) {
        this.viewName = viewName;
    }
    
    public Map<String, Object> getModel() {
        return model;
    }
    
    public void setModel(Map<String, Object> model) {
        this.model = model;
    }
}

• 뷰의 이름과 뷰를 렌더링할 때 필요한 model 객체를 가지고 있다. model은 단순히 map으로 되어 있으므로 컨트롤러에서 뷰에 필요한 데이터를 key, value로 넣어주면 된다.

---

10. 요약

DispatcherServlet은 FrontController 패턴으로

urlPatterns로 해당 경로를 포함한 1) 하위 모든 요청을 프론트 컨트롤러에서 받아서

HttpServletRequest에서 파라미터 정보를 꺼내서 Map으로 변환시키고

모델 객체를 생성해서 

들어온 2) URL과 매핑되는 컨트롤러를 찾아서 호출시켜 주면(애노테이션으로 등록)

 

컨트롤러에서는

1) 필요한 요청 파라미터는 map에서 조회하면 되고 

2) 응답 파라미터는 모델로 전달된다.

3) 뷰의 논리 이름만 반환하면 된다.

 

다시 프론트 컨트롤러에서는 컨트롤러의 호출 결과로 String 을 반환 받고

이 값을 사용해서 1) 실제 물리 경로가 있는 뷰 객체를 반환하면

뷰 객체에서 렌더링을 시켜주면 

모델 정보도 함께 받는데 2) 모델의 데이터를 꺼내서 request.setAttribute() 로 담아주고

3) dispatcher.forward 로직을 수행해서 뷰가 실행된다.

 

지금까지는 프론트 컨트롤러는 한가지 방식의 컨트롤러 인터페이스만 사용했지만

여러 방식의 컨트롤러 인터페이스를 사용하기 위해서는

해당 컨트롤러(핸들러)와 프런트 컨트롤러 사이에 어댑터를 만들어서

1) 컨트롤러(핸들러) 형식에 맞추어 호출하고, 2) 프론트 컨트롤러 형식에 맞추어 반환시켜 줘야한다.

 

이 과정에서 프론트 컨트롤러는

URL에 매핑된 1) 컨트롤러(핸들러) 객체를 찾아서

해당 컨트롤러(핸들러)를 처리할 수 있는 2) 어댑터를 조회하고

3) 해당 어댑터를 호출하면 된다.

 

---

11. 마무리

여기에 애노테이션을 사용해서 컨트롤러를 더 편리하게 발전시킬 수도 있다. 

여기서 더 발전시키면 좋겠지만, 스프링 MVC의 핵심 구조를 파악하는데 필요한 부분은 모두 만들어보았다.

사실은 지금까지 작성한 코드는 스프링 MVC 프레임워크의 핵심 코드의 축약 버전이고, 구조도 거의 같다.