[Spring] 김영한 스프링 MVC_ 섹션5. MVC 프레임워크 만들기

<출처 인프런>

섹션 5는 현재의 Spring MVC까지 오게된 과정을 차근차근 살펴봤다. 앞서 배운 점에서 가장 큰 변화는 프론트 컨트롤러가 추가되었다는 것이다. 요청과 응답을 컨트롤러에서 처리했던 것과 달리 프론트 컨트롤러에 역할을 전가해 개발자는 점점 편리하게 컨트롤러를 작성할 수 있게 되었다. 그리고 중복되는 코드를 최대한 줄이며 점진적인 구조적 변화를 주었다.

 

 

☘️ 

잘못된 정보가 있을 수 있습니다 

---

 

✔️  V1_ 프론트 컨트롤러를 도입하자.

• 프론트 컨트롤러로 요청을 받아 알맞는 컨트롤러를 찾아 호출한다.
• 나머지 컨트롤러는 서블릿을 사용하지 않는다.

 

►  ControllerV1.interface

public interface ControllerV1 {

    void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;

}

로직의 일관성을 위해 인터페이스를 추가하여 서블릿과 비슷한 모양의 코드를 구현한다.

 

 

 

► MemberSaveControllerV1.class

• 경로를 가지고 있으며 그 경로로 요청과 응답을 넘긴다.
• RequestDispatcher을 사용한다.

    @Override
    public void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));

        Member member = new Member(username, age);
        memberRepository.save(member);

        request.setAttribute("member", member);

        String viewPath = "/WEB-INF/views/save-result.jsp";
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }

들어온 정보를 저장하는 컨트롤러이다. 해당 컨트롤러는 경로를 정의하고 있고, 정의된 경로를 viewPath 담은 후 request.getRequestDispatcher로 이 경로로 갈 수 있는 dispatcher을 만들어 요청과 응답을 넘긴다. 이때 request에 member를 담아 넣기는 이유는 어떤 요청인지 알기 위함이다. 

 

 

Q. 왜 정보를 request에 담을까? response에 담아서 화면에 출력해야하는게 아닐까?

A. reponse는 브라우저에 실제로 보내는 데이터만 담는다. request는 JSP(JavaServer Page, 자바 코드로 HTML 파일을 만드는 서버용 파일)에게 데이터를 넘겨주기 위한 임시 바구니 같은 용도이다. 그래서 보내는 용도로 잠깐만 저장하기 위해 setAttribute를 사용한다. JSP는 아마도 이름 데이터와 나이 데이터를 받았을 것이다. 그러면 JSP는 화면에 보내기 위한 HTML을 만든 후, response에 최종 결과를 담아 사용자가 볼 수 있도록 한다.

 

 

► FrontControllerServletV1.class

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

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

웹이 처음 켜지면 위의 객체를 생성해서 controllerMap에 저장한다. URL이 키가 되고 컨트롤러 객체가 값이 된다.

 

        System.out.println("FrontControllerServletV1.service");

        String requestURI = request.getRequestURI();

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

        controller.process(request,response);

실제 요청이 /front-controller/v1/members/save 경로로 들어오면 requestURI에 넣어진다. 그리고 requestURI를 가지고 controllerMap에서 미리 저장해뒀던 MemberSaveControllerV1 객체를 꺼내서 process( ) 메서드를 호출한다. 그러면 이때

MemberSaveControllerV1.class의 process 메서드가 진행된다.

아까 위에 적었듯이 MemberSaveControllerV1.class에서 dispatcher를 통해 브라우저에 응답을 보낸다. 

 

 

 

▶ 순서 (MemberSaveController)

• 프론트 컨트롤러(FrontControllerServletV1)로 요청이 들어온다
• 들어온 경로로 저장해둔 객체를 꺼낸다.
• 꺼낸 객체의 process 메서드가 호출된다.
• process 메서드에서 이름과 나이를 저장한다.
• dispatcher로 HTML을 만들어 브라우저로 보낸다.

 

 

---

 

 

 

✔️  V2_ View를 분리하자.

• 브라우저에 출력하기 위한(view 부분) 코드를 모든 컨트롤러에 중복해서 코드를 적어야했다.
• 중복된 코드를 없애고 view를 분리한다.

 

►  MyView.class

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

V1에서는 Controller가 dispatcher.forward까지 처리했다. V2에서는 MyView 클래스를 따로 만들어 View를 처리하도록 했다. 아마도 컨트롤러에서 화면에 표시될 경로를 MyView로 반환할 것이다. 그럼 그 경로를 받아 render 메서드에서 처리해 사용자 화면에 출력된다.

 

 

 

► MemberSaveControllerV2.class

    @Override
    public MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));

        Member member = new Member(username, age);
        memberRepository.save(member);

        request.setAttribute("member", member);

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

해당 경로를 가지고 MyView 객체를 생성했다. 어떤 뷰로 보여줄지 정보만 넘긴 후, 실제 화면은 MyView 객체가 담당할 것이다.

 

 

 

► FrontControllerServletV2.class

@Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

        String requestURI = request.getRequestURI();

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

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

V1은 controller.process()만 호출됐다. V2는 controller.process()에서 view에 넘길 데이터를 준비해서 request에 담고, 어떤 JSP로 갈지 MyView를 반환한다. 그 다음 view.render를 통해 지정된 JSP로 forward해서 브라우저에 화면이 보이도록 한다.

 

 

 

 

▶ 순서 (MemberSaveController)

• 프론트 컨트롤러(FrontControllerServletV1)로 요청이 들어온다
• 들어온 경로로 저장해둔 객체를 꺼낸다.
• 꺼낸 객체의 process 메서드가 호출된다.
• process 메서드에서 이름과 나이를 저장한다.
• process 메서드에서 경로를 반환한다.
• 반환된 경로로 정보를 가지고 MyView 클래스의 render 메서드에 간다.
• render에서 화면을 만든다.

 

 

---

 

 

 

✔️  V3_ 서블릿 종속성을 제거하자.

• HttpServletRequest, HttpServletResponse이 꼭 필요하진 않은 것 같다.
• request 객체를 Model로 대신해 사용해본다.
• 뷰 이름의 중복을 지워본다.

 

► MemberSaveControllerV3.class

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

mv에는 "save-result"와 member 정보가 담긴 model을 반환한다. 

 

 

 

 

►FrontControllerServeltV3.class

        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 MyView viewResolver(String viewName) {
        return new MyView("/WEB-INF/views/" + viewName + ".jsp");
    }

service( ) 메서드에서 사용자가 적어 넣은 데이터를 createParamMap( ) 메서드로 꺼낸다. 그리고 그 정보를 컨트롤러에 있는 process( ) 메서드로 보낸다. process( ) 메서드에서 결과적으로 "save-result"라는 view 이름과 ("member", member)를 mv에 담았고, 프론트 컨트롤러는 mv를 받는다. 그러면 mv.getViewName( )을 통해 뷰 이름을 꺼내고, 뷰 이름을 viewResolver( ) 메서드로 보내 실제 물리 뷰 경로로 변경한다.

V1과 V2는 컨트롤러가 직접 request에 정보를 넣었다. 그런데 V3에서는 컨트롤러가 Model에 데이터만 넣고, 프론트 컨트롤러가 view.render( )로 전달해 그 안에서 setAttribute가 이뤄진다.

 

 

 

►  MyView.class

 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 static void modelToRequestAttribute(Map<String, Object> model, HttpServletRequest request) {
        model.forEach((key, value) -> request.setAttribute(key, value));
    }

render 메서드를 새롭게 오버로딩(같은 이름의 메서드, 다른 시그니처)했다. 그 이유는 view.render에 mv.getModel이 추가되어 그걸 받을 수 있는 model을 매개변수로 넣어야하기 때문이다.

render( ) 메서드가 호출되면 modelToRequestAttribute( ) 메서드에서 model에 넣어둔 정보를 forEach로 꺼내 setAttribute로 request에 잠시 저장하고, dispatcher.forward( ) 메서드로 사용자 브라우저에 화면이 송출될 수 있게 된다. 

 

 

 

 

▶ 순서 (MemberSaveController)

• 프론트 컨트롤러(FrontControllerServletV1)로 요청이 들어온다
• 들어온 경로로 저장해둔 객체를 꺼낸다.
• 꺼낸 객체의 process 메서드가 호출된다.
• process 메서드에서 이름과 나이를 저장한다.
• process 메서드에서 논리 뷰 이름을 반환한다.
• mv에 정보와 논리 뷰 이름을 가지고 프론트 컨트롤러에 온다.
• 논리 뷰 이름을 viewResolver 메서드로 물리 뷰 이름으로 변경된다.
• 그 경로로 render 메서드가 실행된다.
• MyView 클래스에서 model을 request.setAttribute로 변경하고
• 그 후 브라우저에 송출한다.

 

 

---

 

 

 

✔️  V4_ 좀 더 실용적이게 코드를 바꿔보자.

• ModelView 객체를 생성하고 반환해야 하는 부분이 조금은 번거롭다.
  

   

► MemberSaveControllerV4.class

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

V3는 model 객체를 따로 만들었다. 그런데 V4는 model.put으로 정보를 넣고, reuturn을 통해 간단하게 논리 뷰 이름을 반환했다. 그저 컨트롤러는 map에 값을 넣고 view 이름만 반환한 것이다. 그래서 V3에 있던 mv가 V4에 없다.

 

 

 

►FrontControllerServletV4.class

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

Map으로 받는 model 코드가 추가되었다. V3의 프론트 컨트롤러에서는 model 객체를 계속해서 만들어줘야했다. 그런 번거로움을 V4가 Map으로 model을 직접 만들어 넘겨주니 컨트롤러는 그냥 model.put만 하면 되는 깔끔한 코드가 완성됐다.

 

 

 

▶ 순서 (MemberSaveController)

• 프론트 컨트롤러(FrontControllerServletV1)로 요청이 들어온다
• 들어온 경로로 저장해둔 객체를 꺼낸다.
• 요청 파라미터를 Map으로 만든다.
• 비어있는 model(Map)을 미리 생성한다.
• 꺼낸 객체의 process 메서드가 호출된다.
• process 메서드에서 이름과 나이를 저장한다.
• process 메서드에서 논리 뷰 이름을 반환한다.
• model은 이미 프론터 컨트롤러에서 map으로 구현해놨기에 편리하게
  model.put으로 정보를 넣는다. (model의 객체 생성이 필요 없어짐)
• 논리 뷰 이름을 viewResolver 메서드로 물리 뷰 이름으로 변경된다.
• 그 경로로 render 메서드가 실행된다.
• MyView 클래스에서 model을 request.setAttribute로 변경하고
• 그 후 브라우저에 송출한다.

 

 

---

 

 

 

✔️  V5 (1)_ 핸들러 어댑터 만들기

• ModelView 객체를 생성하고 반환해야 하는 부분이 조금은 번거롭다.
  

   

► FrontControllerServletV5.class

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

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

hanlderMappingMap이란 저장소를 만들었다. 이 저장소엔 V3에 관련된 컨트롤러를 담을 것이다. key는 요청이 들어온 주소가 될 것이고, 주소로 요청이 들어오면 그에 맞는 객체를 꺼낼 것이다.

 

 

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

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

V3를 연결해주는 어댑터를 handlerAdapters에 추가했다. 현재 코드에서는 V3만 넣어놨지만, V4도 추가할 수 있다. 그래서 List 형태로 저장한다. 

 

 

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

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

request로 경로가 들어오면 handlerMappingMap에 가서 경로에 맞춰 미리 저장해둔 객체를 꺼낸다. 꺼낸 객체는 handler에 넣어둔다.

 

 

 MyHandlerAdapter adapter = getHandlerAdapter(handler);

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

handler에는 객체가 들어있다. 만약 사용자가 이름과 나이를 저장하는 페이지를 띄웠다면, MemberSaveControllerV3() 객체가 들어있을 것이다. 그걸 getHandlerAdapter가 인자로 받았다.

handlerAdapter에는 new ControllerV3HandlerAdapter()를 넣어놨다. 그러면 adapter 중 MemberSaveControllerV3()가  ControllerV3HandlerAdapter()가 같은 인스턴스가 맞는지 supports 메서드로 확인할 것이다. 

 

 

 

► ControllerV3HandlerAdapter.class

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

같은 인스터스가 맞는지 instanceof를 통해 확인한다. 같은 인스턴스라면 true를 반환한다.

 

 

Q. handler는 ControllerV3의 인스턴스인지 어떻게 아는걸까?

A. MemberSaveControllerV3가 ControllerV3를 implements하고 있다.

public class MemberSaveControllerV3 implements ControllerV3​

자바 타입 검사로 체크하여 true가 나온다.

 

 

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

handle 메서드에 파라미터로 Object handler를 추가했다. supports 메서드를 통해 handler(MemberSaveControllerV3 라고 가정)가 ControllerV3와 같은 인스턴스인지 확인을 했고 참이 나왔다. 그러면 request로 받아온 나이와 이름 정보를 paramMap을 들고 MemberSaveControllerV3의 process 메서드를 호출시킨다.

process 메서드는 모델뷰 타입으로 mv를 반환했다. 반환된 mv는 handle 메서드로 와 다시 return mv가 된다. 그 후 이 mv는 프론트컨트롤러의 service 메서드로 전달된다.

 

 

 

► FrontControllerServletV5.class

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

handler에는 MemberSaveControllerV3가 있다고 가정하자. 그러면 그에 맞는 어댑터를 getHandAdatper를 통해 꺼내올 것이다. 그렇게 꺼내온 어댑터는 ControllerV3HandlerAdapter가 된다.

그리고 adapter.handle은 ControllerV3HandlerAdapter의 handle 메서드가 되고 이부분에 대한 내용이 바로 위에 있는 것이다. handle 메서드는 최종적으로 mv를 리턴했다. 그럼 ModelView mv = adapter.handle(request, response, handler);에 리턴된 mv가 들어오게 되고, 브라우저에 결과가 보이게 된다.

 

 

 

▶ 순서 (MemberSaveController)

• 프론트 컨트롤러(FrontControllerServletV1)로 요청이 들어온다
• 들어온 경로로 저장해둔 객체를 꺼낸다.
• 객체와 어댑터가 맞는지 supports 메서드로 확인 후 맞으면 참을 보낸다.
• true가 나오면 해당 컨트롤러 클래스 내부에 있는 process 메서드를 실행한다.
• 컨트롤러에서 값을 반환하면 어댑터가 받고 어댑터는 프론트 컨트롤러로 반환한다.
• 프론트 컨트롤러에서 반환된 값을 가지고 뷰로 보낸다.