[Spring] 스프링 MVC 1편 4) MVC 프레임워크 만들기

스프링 MVC 1편 백엔드 웹 개발 핵심 기술 

Session 4 MVC 프레임워크 만들기

1. 프론트 컨트롤러 패턴 소개

1) 프론트 컨트롤러 패턴 소개

공통을 하나에 모으고 이 프론트 컨트롤러를 통해 A, B, C 호출 결정

 

2) 프론트 컨트롤러 패턴 특징

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

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

공통 처리가 가능하고 프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿을 사용하지 않아도 됨

 

3) 스프링 웹 MVC와 프론트 컨트롤러 패턴

스프링 웹 MVC의 핵심도 프론트 컨트롤러

DispatcherServlet이 프론트 컨트롤러 패턴으로 구현되어 있음

---

2. 프론트 컨트롤러 도입 - v1

1) v1 구조

클라이언트가 HTTP 요청을 하면 프론트 컨트롤러 서블릿이 요청을 받음

프론트 컨트롤러가 URL 매핑 정보에서 컨트롤러를 조회해 호출

컨트롤러에서 jsp forward, jsp로 응답

 

2) ControllerV1 인터페이스 생성

public interface ControllerV1 {
    void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}

 

서블릿과 비슷한 모양의 컨트롤러 인터페이스 도입

각 컨트롤러들은 이 인터페이스를 구현, 프론트 컨트롤러는 이 인터페이스를 호출해 구현과 관계없이 로직의 일관성을 가질수 있음

 

3) 회원 등록 폼, 회원 저장, 회원 목록 컨트롤러 생성

public class MemberListControllerV1 implements ControllerV1 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        ...
    }
}

서블릿 비즈니스 로직 코드 동일

 

4) 프론트 컨트롤러 생성

@WebServlet(name = "frontControllerV1", urlPatterns = "/front-controller/v1/*")
public class FrontControllerV1 extends HttpServlet {

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

    public FrontControllerV1() {
        controllerMap.put("/front-controller/v1/members/new-form", new MemberFormControllerV1());
        controllerMap.put("/front-controller/v1/members/save", new MemberSaveControllerV1());
        controllerMap.put("/front-controller/v1/members", new MemberListControllerV1());
        // 서블릿 생성시 값 넣어둠
    }

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("FrontControllerV1.service");

        String requestURI = request.getRequestURI();

        // 다형성
        ControllerV1 controller = controllerMap.get(requestURI);
        
        if(controller == null){ // 없으면 404
            response.setStatus(HttpServletResponse.SC_NOT_FOUND); //404
            return;
        }

        controller.process(request, response); // 컨트롤러 호출

    }
}

urlPatterns="/front-controller/v1/*" ▶ front-controller/v1 포함한 하위 모든 요청

controllerMap ▶ 키 - 매핑 URL, 값 - 호출된 컨트롤러 

service() ▶ requestURI를 조회해서 controllerMap에서 조회 없으면 404, 있으면 호출해 해당 컨트롤러 실행

JSP는 이전 강의 것 그대로 재사용

---

3. View 분리 - v2

1) v2 구조

모든 컨트롤러에서 뷰로 이동하는 부분 중복

이 부분을 분리하기 위해 별로의 뷰 처리 객체 생성

클라이언트 HTTP 요청 프로트 컨트롤러가 매핑정보를 조회해 컨트롤러 호출

컨트롤러는 뷰 역할을 하는 MyView 객체를 프론트 컨트롤러에 반환

프론트 컨트롤러가 MyView render() 호출

MyView는 jsp forward 클라이언트에게 html 응답

 

2) MyView 생성

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

 

jsp로 forward해주는 render() 메서드

 

3) ControllerV2 인터페이스 생성

public interface ControllerV1 {
    MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}

반환타입이 MyView인 ControllerV2 인터페이스 도입

 

4) 회원 등록 폼, 회원 저장, 회원 목록 컨트롤러 생성

public class MemberListControllerV2 implements ControllerV2 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        List<Member> members = memberRepository.findAll();

        request.setAttribute("members", members);

        return new MyView("/WEB-INF/views/members.jsp");
    }
}

 

 dispatcher.forward() 직접forward()직접 생성해서 호출하지 않아도 됨, 비즈니스 로직을 수행하고 viewPath를 MyView 객체로 반환

 

5) 프론트 컨트롤러 생성

@WebServlet(name = "frontControllerServletV2", urlPatterns = "/front-controller/v2/*")
public class FrontControllerServletV2 extends HttpServlet {
	
    ...
    
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        ...

        MyView view = controller.process(request, response);
        view.render(request, response);

    }
}

컨트롤러 호출 결과로 MyView 객체를 반환받는다.

view.render() 호출하면 forward로직 수행해 jsp 실행

프론트 컨트롤러의 도입으로 render() 호출 부분 모두 일관되게 처리 가능

각 컨트롤러는 MyView를 생성만 해서 반환만 하면 된다.

---

4. Model 추가 - v3

1) 서블릿 종속성 제거

컨트롤러가 서블릿 기술을 전혀 사용하지 않게 변경해 보자

요청 파라미터 정보는 자바의 Map으로 대신 넘기도록 하면 컨트롤러가 서블릿 기술을 몰라도 동작 가능

request 객체를 Model로 사용하는 대신 별도의 Model 객체를 만들어 반환 

 

2) 뷰 이름 중복 제거

컨트롤러에서 지정하는 뷰 이름에 중복이 있음

컨트롤러는 뷰의 논리 이름을 반환하고 실제 물리위치 이름은 프론트 컨트롤러에서 처리하도록 단순화

향후 뷰 폴더 위치가 이동해도 프론트 컨트롤러만 변경하면 된다.

 

3) v3 구조

 

클라이언트 HTTP 요청 프로트 컨트롤러가 매핑정보를 조회해 컨트롤러 호출

컨트롤러는 모델과 뷰 역할을 하는 ModelView 객체를 프론트 컨트롤러에 반환

프론트 컨트롤러가 viewResolver를 호출해 뷰의 논리이름을 물리이름으로 변환하고 MyView를 반환

프론트 컨트롤러가 MyView render(model) 호출

MyView는 jsp forward 클라이언트에게 html 응답

 

4) ModelView 작성

이전 버전에선 컨트롤러에서 서블릿에 종속적인 HttpServletRequest 사용, 모델도 request.setAttribute()를 이용해 데이터를 저장하고 뷰에 전달

서블릿의 종속성을 제거하기 위해 Model을 직접 만들고 View 이름까지 전달하는 객체를 만들어보자

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

뷰 이름과 뷰를 렌더링 할 때 필요한 model 객체를 가지고 있고

model은 map으로 되어있어 컨트롤러에서 뷰에 필요한 데이터를 키, 값으로 넣어주면 된다.

 

5) ControllerV3

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

컨트롤러는 서블릿 기술을 전혀 사용하지 않음

HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 paramMap에 담아서 호출

응답 결과로 뷰 이름과 뷰에 전달할 model 데이터를 포함하는 ModelView 객체를 반환하면 된다.

 

6) 회원 등록 폼, 회원 저장, 회원 목록 컨트롤러 생성

public class MemberFormControllerV3 implements ControllerV3 {
      @Override
      public ModelView process(Map<String, String> paramMap) {
          return new ModelView("new-form");
      }
}

ModelView 생성할 때 new-form이라는 뷰의 논리적 이름 지정, 실제 물리적 이름은 프론트 컨트롤러에서 처리

 

public class MemberSaveControllerV3 implements ControllerV3 {
      private MemberRepository memberRepository = MemberRepository.getInstance();
      @Override
      public ModelView process(Map<String, String> paramMap) {
          String username = paramMap.get("username");
          int age = Integer.parseInt(paramMap.get("age"));
          
          Member member = new Member(username, age);
          memberRepository.save(member);
          
          ModelView mv = new ModelView("save-result");
          mv.getModel().put("member", member);
          return mv;
	  }
}

paramMap.get("username") ▶ 파라미터 정보는 map에 담겨있어 필요한 요청 파라미터 조회

mv.getModel().put("member", member) ▶ 모델은 단순 map이므로 모델에 뷰에서 필요한 멤버 객체를 담고 반환

 

7) 프론트 컨트롤러 생성

@WebServlet(name = "frontControllerServletV3", urlPatterns = "/front-controller/v3/*")
public class FrontControllerServletV3 extends HttpServlet {
	...
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    
    	...
        
        Map<String, String> paramMap = createParamMap(request);
        ModelView mv = controller.process(paramMap);
        String viewName = mv.getViewName();
        MyView view = viewResolver(viewName);
        view.render(mv.getModel(), 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");
      } 
}

createParamMap() ▶ HttpServletRequest에서 파라미터 정보를 꺼내서 Map으로 변환, 해당 map을 컨트롤러에 전달하면서 호출

viewResolver() ▶ 컨트롤러가 반환한 논리 뷰 이름을 실제 물리 뷰 경로로 변경, 뷰의 물리적 위치가 변하면 이곳만 코드 수정

view.render(mv.getModel(), request, response) ▶ 뷰 객체를 통해서 HTML 화면을 렌더링

 

8) MyView 

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

 

modelToRequestAttribute() ▶ 모델의 데이터를 꺼내서 setAttribute()로 담음

jsp로 포워드 해서 jsp 렌더링

---

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

1) 단순하고 실용적인 컨트롤러

v3 컨트롤러는 서블릿 종속성을 제거하고 뷰 경로의 중복을 제거, 잘 설계된 컨트롤러

그런데 v3 컨트롤러 인터페이스를 구현하다 보면 항상 modelView 객체를 생성하고 반환해야 하는 부분이 번거롭다

이 부분을 좀 더 편리하고 실용성 있게 개발

 

2) v4 구조

 

v3와 기본 구조는 같으나 컨트롤러가 ModelView를 반환하지 않고 ViewName만 반환

 

3) ControllerV4

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

 

인터페이스에 ModelView를 사용하지 않음 단순하게 뷰의 논리 이름만 반환

model객체는 파라미터로 전달해 그냥 사용만 하면 된다.

 

4) 회원 등록 폼, 회원 저장, 회원 목록 컨트롤러 생성

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

 

모델이 파라미터로 전달되기 때문에 ModelView 생성 없이 값만 넣어주면 된다.

 

5) 프론트 컨트롤러 생성

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

    ...

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        ...
        // paramMap 모든 파라미터 저장
        Map<String, String> paramMap = createParaMap(request);
        Map<String, Object> model = new HashMap<>();
        
        String viewName = controller.process(paramMap, model);

        MyView view = viewResolver(viewName); // /WEB-INF/views/new-form.jsp
        view.render(model, request, response);

    }

v3와 거의 동일하지만 viewName를 컨트롤러에서 반환해 주기 때문에 ModelView 객체 생성 없어도 된다.

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

 

6) 정리

기존 구조에서 모델을 파라미터로 넘기고 뷰의 논리 이름을 반환

---

6. 유연한 컨트롤러1- v5

1) 유연한 컨트롤러

현재 프론트 컨트롤러는 한 가지 방식의 컨트롤러 인터페이스만 사용 가능

A는 ControllerV3 방식으로 개발하고 싶고 B는 ControllerV4로 개발하고 싶다면 어떻게 해야 할까? ▶ 어댑터 패턴 사용

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

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

 

2) 어댑터 패턴

ControllerV3와 ControllerV4는 완전히 다른 인터페이스, 호환이 불가능

서로 호환해 주기 위해 어댑터 패턴을 사용

→ 프론트 컨트롤러가 다양한 방식의 컨트롤러를 처리할 수 있도록 함

 

3) v5 구조

1~2. 클라이언트 HTTP 요청 프론트 컨트롤러가 핸들러 조회, 핸들러를 처리할 수 있는 핸들러 어댑터 조회

3. 프론트 컨트롤러는 조회한 핸들러(컨트롤러)로 핸들러 어댑터 호출

4. 핸들러 어댑터는 핸들러(컨트롤러) 호출

5. 핸들러가 ModelView를 프론트 컨트롤러에 반환

6~8. 프론트 컨트롤러가 viewResolver를 호출해 뷰의 논리이름을 물리이름으로 변환하고 MyView를 반환

프론트 컨트롤러가 MyView render(model) 호출

MyView는 jsp forward 클라이언트에게 html 응답

 

4) 핸들러, 핸들러 어댑터

-핸들러 어댑터 : 중간에 어댑터 역할을 해주는 덕분에 다양한 종류의 컨트롤러 호출 가능

-핸들러

이전에는 컨트롤러를 직접 매핑해서 사용

지금은 어댑터를 사용하기 때문에 컨트롤러뿐만 아니라 어택터가 지원하기만 하면 어떤 것이라도 URL에 매핑해 사용가능

그래서 컨트롤러의 이름을 더 넓은 범위인 핸들러로 변경

 

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

어댑터는 실제 컨트롤러 호출하고 ModelView 반환

실제 컨트롤러가 ModelView를 반환하지 못하면 어댑터가 직접 생성해서라도 반환

이전 구조는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해 호출

 

6) ControllerV3HandlerAdapter

 public class ControllerV3HandlerAdapter implements MyHandlerAdapter {
      @Override
      public boolean supports(Object handler) {
          return (handler instanceof ControllerV3);
      }
      @Override
      public ModelView handle(HttpServletRequest request, HttpServletResponse esponse, Object handler) {
            ControllerV3 controller = (ControllerV3) handler;
            Map<String, String> paramMap = createParamMap(request);
            ModelView mv = controller.process(paramMap);
            return mv;
       }
       ...
}

 

-supports() 

ControllerV3의 인스턴스인지 확인

-handle()

handler를 v3로 캐스팅 supports()에서 v3인지 확인했기 때문에 캐스팅 가능

v3는 ModelView를 반환하기 때문에 그대로 반환

 

7) FrontControllerServletV5

-생성자

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

 

-핸들러 매핑

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

 

-어댑터 호출

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

흐름을 파악하기!

---

7. 유연한 컨트롤러2 - v5

1) FrontControllerServletV5 - ControllV4 기능 추가

- 생성자 메서드

private void initHandlerMappingMap() {
     ...
     
     //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 ControllerV4HandlerAdapter()); //V4 추가
}

핸들러 매칭에 v4추가, 해당 컨트롤러를 처리할 수 있는 어댑터도 추가

 

2) ControllerV4HandlerAdapter

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

ContorllerV4는 String 반환, 어댑터는 ModelView 반환

어댑터가 ModelView 형식에 맞추어 변환해주어야 한다!!

---

8. 정리

1) v1~v5 프레임워크

-v1 프론트 컨트롤러 도입

기존 구조를 최대한 유지하면서 프론트 컨트롤러 도입

-v2 뷰 분리

단순 반복되는 뷰 로직 분리

-v3 모델 추가

서블릿 종속 제거, 뷰이름 중복 제거

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

v3와 거의 유사

구현입장에서 modelview를 직접 생성해 반환하지 않도록 인터페이스 제공

-v5 유연한 컨트롤러

어댑터 도입, 어댑터를 추가해 프레임워크를 유연하고 확장성 있게 설계