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

Spring 정리 2021. 10. 21. 20:48

인프런 강의 29일차.

 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 1 (김영한 강사님)

 - 서블릿, JSP, MVC 패턴

 - 서블릿으로 1차 구현

   -> 서블릿으로 구현했을 때 불편한 점 개선을 위해 JSP로 2차 구현

   -> JSP로도 불편한 점을 개선하기 위해 MVC 패턴으로 3차 구현

 

1. MVC 패턴 - 한계

 - MVC 패턴을 적용한 덕분에 컨트롤러의 역할과 뷰를 렌더링하는 역할을 명확하게 구분할 수 있다.

 - 특히 뷰는 화면을 그리는 역할에 충실한 덕분에, 코드가 깔끔하고 직관적이다. 단순하게 모델에서 필요한 데이터를 꺼내고, 화면을 만들면 된다.

 - but, 컨트롤러는 중복도 많고 필요하지 않은 코드도 많다.

 

 1.1 MVC 컨트롤러의 단점

  - 포워드 중복

  - View로 이동하는 코드가 항상 중복 호출되어야 한다. 물론 이 부분을 공통화해도 되지만, 공통을 항상 호출해야 한다는 점은 매한가지.

//항상 호출되는 코드
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);

//View Path 또한 중복으로 세팅하는 부분이 있다. (prefix, suffix)
//prefix: /WEB-INF/views/
//suffix: .jsp
String viewPath = "/WEB-INF/views/members.jsp";

  - 만약 jsp가 아닌 thymeleaf같은 다른 뷰로 변경한다면 전체 코드를 전부 변경해야 동작한다.

  - 그 외에 사용 빈도가 적은 코드도 존재한다. (특히 response는 현재 코드에서는 사용하지 않는다)

    ex) HttpServletRequest request, HttpServletResponse response

         > HttpServletRequest, HttpServletResponse를 사용하는 코드는 테스트 케이스를 작성하기도 어렵다.

 

  - 공통 처리가 어렵다

    > 컨트롤러 호출 전에 먼저 공통 기능을 처리해야만 해결 가능

    > 프론트 컨트롤러 패턴을 도입해서 공통기능을 먼저 처리하는 형태로 해결 해야하며, 스프링 MVC의 핵심도 바로 이 프론트 컨트롤러에 있다.

 

 

2. MVC 프레임워크 만들기

 2.1 프론트 컨트롤러 패턴 소개

프론트 컨트롤러 도입 전 호출 형태
프론트 컨트롤러 도입 후 호출 형태

 2.2 FrontController 패턴 특징

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

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

  - 입구를 하나로!

  - 공통 처리 가능

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

  - 스프링 웹 MVC와 프론트 컨트롤러 스프링 웹 MVC의 핵심도 바로 FrontController

  - 스프링 웹 MVC의 DispatcherServlet이 FrontController 패턴으로 구현되어 있음

 

2.3 FrontController 도입 - v1

  - 프론트 컨트롤러를 단계적으로 도입해보자.

  - 기존 코드를 최대한 유지하면서 프론트 컨트롤러를 도입하는 것이 목표

프론트 컨트롤러 구현 후 호출 형태 (v1)

package hello.servlet.web.frontcontroller.v1;

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

public interface ControllerV1 {

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

}

  - web.frontcontroller.v1.ControllerV1.java

  - 서블릿과 비슷한 모양의 컨트롤러 인터페이스를 생성한다. 각 컨트롤러들은 이 인터페이스를 구현한다.

  - 프론트 컨트롤러는 이 인터페이스를 호출해서 구현과 관계없이 로직의 일관성을 가져갈 수 있다.

 

package hello.servlet.web.frontcontroller.v1.controller;

import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.v1.ControllerV1;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class MemberFormControllerV1 implements ControllerV1 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String viewPath = "/WEB-INF/views/members.jsp";
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
}

  - web.frontcontroller.v1.controller.MemberFormControllerV1.java

  - 리팩토링 순서는 같은 레벨에서의 구조를 먼저 개선 한 후 문제가 없을 때 세부 로직을 변경하는 형태로 개선한다.

  - v1에서는 구조만 변경하는 것으로 진행(viewPath와 Dispatcher호출은 변경하지 않고, 컨트롤러 호출 형태만 변경)

 

package hello.servlet.web.frontcontroller.v1.controller;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.v1.ControllerV1;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class MemberSaveControllerV1 implements ControllerV1 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));   //request.getParam의 결과는 항상 문자이므로 숫자는 따로 형변환을 해주어야함

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

        //Model에 데이터 저장
        request.setAttribute("member", member);

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

  - web.frontcontroller.v1.controller.MemberSaveControllerV1.java

 

package hello.servlet.web.frontcontroller.v1.controller;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.v1.ControllerV1;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;

public class MemberListControllerV1 implements ControllerV1 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

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

        request.setAttribute("members", members);

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

  - web.frontcontroller.v1.controller.MemberListControllerV1.java

 

package hello.servlet.web.frontcontroller.v1;

import hello.servlet.web.frontcontroller.v1.controller.MemberFormControllerV1;
import hello.servlet.web.frontcontroller.v1.controller.MemberListControllerV1;
import hello.servlet.web.frontcontroller.v1.controller.MemberSaveControllerV1;

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.HashMap;
import java.util.Map;


//v1 하위에 모든 컨트롤러를 호출할 수 있음
@WebServlet(name="frontControllerServletV1", urlPatterns = "/front-controller/v1/*")
public class FrontControllerServletV1 extends HttpServlet {

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

    public FrontControllerServletV1() {
        //url과 호출해야하는 컨트롤러를 매핑하여 Map에 저장
        controllerV1Map.put("/front-controller/v1/members/new-form", new MemberFormControllerV1());
        controllerV1Map.put("/front-controller/v1/members/save", new MemberSaveControllerV1());
        controllerV1Map.put("/front-controller/v1/members", new MemberListControllerV1());
    }

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

        String requestURI = request.getRequestURI();    //호출되는 URL 주소 얻기
        
        ControllerV1 controllerV1 = controllerV1Map.get(requestURI);    //url 주소에 해당하는 Controller생성
        if(controllerV1 == null){
            //매칭되는 컨트롤러가 없으면 404 에러 리턴
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        
        //매칭되는 컨트롤러를 찾았으면 해당 컨트롤러 호출
        controllerV1.process(request, response);

    }
}

  - web.frontcontroller.v1.FrontControllerServletV1.java

  -  urlPatterns는 v1/*로 선언

  - controllerMap : key는 매핑 URL, value는 호출될 Controller

  - JSP는 이전 MVC에서 사용하던 것을 그대로 사용한다,

 

2.4 View 분리 - v2

  - 모든 컨트롤러에서 뷰로 이동하는 부분에 중복이 있고, 깔끔하지 않다 (viewPath 및 dispatcher 호출 부분)

View 분리 후 호출 형태 (v2)

  - viewPath를 전담해서 처리하는 MyView 구현

  - 과거에는 컨트롤러에서 jsp를 직접 호출했다면 v2에서는 MyView에서 jsp를 호출

package hello.servlet.web.frontcontroller;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class MyView {

    private String viewPath;

    public MyView(String viewPath) {
        this.viewPath = viewPath;
    }

    public void render(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //MyView를 생성할 때 생성자로 세팅한 viewPath 호출
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
}

  - web.frontcontroller.v2.MyView.java

  - viewPath에 따른 forward를 수행하는 소스

 

package hello.servlet.web.frontcontroller.v2;

import hello.servlet.web.frontcontroller.MyView;

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

public interface ControllerV2 {

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

  - web.frontcontroller.v2.ControllerV2.java

  - 이제 각 컨트롤러가 dispatcher.forward()를 직접 생성해서 호출하지 않고 MyView객체를 생성하고 뷰 이름만 넣은 뒤 반환하면 된다,

  - ControllerV1와 ControllerV2를 비교해보면 중복이 제거된 것을 확인할 수 있다.

 

package hello.servlet.web.frontcontroller.v2.controller;

import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v2.ControllerV2;

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

public class MemberFormControllerV2 implements ControllerV2 {

    @Override
    public MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        /*
        MyView myView = new MyView("WEB-INF/views/new-form.jsp");
        return myView;
        위 코드를 아래처럼 한번에 변경하는 단축키 Ctrl + alt + N 혹은 Shift + Ctrl + Alt + T로 호출되는 리팩터링 메뉴에서 '인라인' 검색
        */

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

  - web.frontcontroller.v2.controller.MemberFormControllerV2.java

package hello.servlet.web.frontcontroller.v2.controller;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v2.ControllerV2;

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

public class MemberSaveControllerV2 implements ControllerV2 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));   //request.getParam의 결과는 항상 문자이므로 숫자는 따로 형변환을 해주어야함

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

        //Model에 데이터 저장
        request.setAttribute("member", member);

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

  - web.frontcontroller.v2.controller.MemberSaveControllerV2.java

 

package hello.servlet.web.frontcontroller.v2.controller;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v2.ControllerV2;

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

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

  - web.frontcontroller.v2.controller.MemberListControllerV2.java

 

package hello.servlet.web.frontcontroller.v2;

import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v1.ControllerV1;
import hello.servlet.web.frontcontroller.v2.controller.MemberFormControllerV2;
import hello.servlet.web.frontcontroller.v2.controller.MemberListControllerV2;
import hello.servlet.web.frontcontroller.v2.controller.MemberSaveControllerV2;

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.HashMap;
import java.util.Map;


//v1 하위에 모든 컨트롤러를 호출할 수 있음
@WebServlet(name="frontControllerServletV2", urlPatterns = "/front-controller/v2/*")
public class FrontControllerServletV2 extends HttpServlet {

    private Map<String, ControllerV2> controllerV1Map = new HashMap<>();

    public FrontControllerServletV2() {
        //url과 호출해야하는 컨트롤러를 매핑하여 Map에 저장
        controllerV1Map.put("/front-controller/v2/members/new-form", new MemberFormControllerV2());
        controllerV1Map.put("/front-controller/v2/members/save", new MemberSaveControllerV2());
        controllerV1Map.put("/front-controller/v2/members", new MemberListControllerV2());
    }

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

        String requestURI = request.getRequestURI();    //호출되는 URL 주소 얻기
        
        ControllerV2 controllerV2 = controllerV1Map.get(requestURI);    //url 주소에 해당하는 Controller생성
        if(controllerV2 == null){
            //매칭되는 컨트롤러가 없으면 404 에러 리턴
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        
        //매칭되는 컨트롤러를 찾았으면 해당 컨트롤러 호출
        MyView view = controllerV2.process(request, response);
        view.render(request, response);
    }
}

  - web.frontcontroller.v2.FrontControllerServletV2.java

  - ControllerV2의 return이 MyView이므로 컨트롤러의 호출 결과로 MyView를 반환받는다.

  - myview.render() 호출을 통해 forward 로직을 수행하여 JSP가 실행된다.

  - JSP는 이전 MVC에서 사용하던 것을 그대로 사용한다,

  - 프론트 컨트롤러의 도입으로 MyView 객체의 render()를 호출하는 부분을 모두 일관되게 처리할 수 있다. 각각의 컨트롤러는 MyView 객체를 생성만해서 반환하면 된다!