[Spring] MVC 1편 (7) - MVC 프레임워크 만들기 v1, v2, v3

📌 프론트 컨트롤러

✅ 프론트 컨트롤러 도입 전

• 프론트 컨트롤러 도입 전에는 각 컨트롤러에서 공통 로직을 구현해줘야 했다.

 

✅ 프론트 컨트롤러 도입 후

• 모든 요청 메세지는 공통 로직이 구현되어 있는 프론트 컨트롤러로 들어온다.
• 프론트 컨트롤러는 요청에 맞는 컨트롤러를 찾아 호출해준다.
• 프론트 컨트롤러에서 요청 메세지를 매핑 시켜주면, 나머지 컨트롤러는 서블릿을 사용하지 않아도 된다.

 

스프링 웹 MVC의 핵심도 FrontController

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

 

 

📌 MVC 프레임워크 직접 만들어보기

✅ v1 - 프론트 컨트롤러 도입

HTTP 요청이 들어오면 프론트 컨트롤러는 요청의 URL을 바탕으로 매핑 정보에서 요청 URL과 맞는 컨트롤러를 찾아 호출한다. 각 컨트롤러는 dispatcher.forward()를 사용해서 뷰를 호출한다.

 

ControllerV1 인터페이스

public interface ControllerV1 {

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

• 각 컨트롤러는 이 인터페이스를 구현한다.
• 프론트 컨트롤러는 이 인터페이스의 process() 메서드를 호출하여 로직의 일관성을 가져갈 수 있다.

 

FrontControllerV1

@WebServlet(name = "frontControllerServletV1", urlPatterns = "/front-controller/v1/*") // v1의 어떤 url이 들어와도 프론트 컨트롤러 서블릿이 무조건 먼저 호출
public class FrontControllerServletV1 extends HttpServlet {

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

    // 서블릿이 생성될 때 url의 매핑 정보를 가지고 있음 (Map의 형태: key=url, value=각 컨트롤러 구현 객체)
    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());
    }

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("FrontControllerServletV1.service"); // 실제로 실행되는지 확인하기 위해서는 로그 찍어보기

        String requestURI = request.getRequestURI();// 요청으로 들어오는 URI를 그대로 받을 수 있음

        ControllerV1 controller = controllerMap.get(requestURI); // 다형성 활용 (인터페이스 타입으로 컨트롤러 가져옴)
        if(controller == null) { // 들어온 URI가 없을 때 예외 처리
             response.setStatus(HttpServletResponse.SC_NOT_FOUND);
             return;
        }

	// 인터페이스의 메서드 호출
        controller.process(request, response);
    }
}

• urlPatterns를 "/front-controller/v1/*"로 설정하면 /front-controller/v1를 포함한 모든 하위 요청은 이 서블릿으로 들어온다.
• controllerMap에는 각 컨트롤러의 url 매핑 정보를 저장하고, 이는 서블릿이 생성될 때 가지고 있는다.
• request.getRequestURI()로 요청으로 들어온 URI를 key로 사용해 controllerMap에서 컨트롤러를 인터페이스 타입으로 가져온다. (다형성)
• 만약 컨트롤러 중 요청 URI와 맞는 컨트롤러가 없으면 NOT_FOUND 상태 코드를 반환한다.
• 컨트롤러가 있으면 컨트롤러에 공통으로 구현되어 있는 process() 메서드를 호출한다.

 

→ 프론트 컨트롤러를 도입했고, Controller의 인터페이스를 도입해서 더 확장성 있고 일관적으로 로직을 처리할 수 있게 되었다!

 

✅ v2 - View 분리

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

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

 

기존에는 컨트롤러에서 직접 JSP를 forward 해주었지만, 이제 Controller는 MyView 객체를 생성해서 FrontController에게 넘겨주기만 하면 FrontController에서 뷰로 이동하는 로직을 실행한다.

 

MyView

public class MyView {

    private String viewPath;

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

    // 서블릿에서 jsp로 이동해서 렌더링 되도록 동작
    public void render(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
}

MyView 클래스에는 뷰의 경로를 저장할 변수와 JSP를 forward해주는 render() 메서드를 구현한다.

 

ControllerV2 인터페이스

public interface ControllerV2 {

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

이제 각 컨트롤러는 로직을 수행하고 MyView 객체를 생성해서 반환한다. 이때 각 뷰의 경로를 입력한다.

 

FrontControllerV2

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

// 나머지 부분 v1과 동일

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

• Map에서 가져온 컨트롤러의 호출 결과로 MyView 객체를 받는다. view.render()를 호출하면 각 컨트롤러에 맞는 forward 로직이 수행된다.

 

→ 이제 각 컨트롤러가 직접 JSP를 forward 하지 않고, 프론트 컨트롤러에서 처리하기 때문에 각 컨트롤러에 중복으로 들어갔던 forward 코드를 작성해주지 않아도 된다.

 

 

✅ v3 - 모델 추가

• 서블릿 종속성 제거 : 컨트롤러 입장에서 request와 response 객체가 필요하지 않다. 요청 파라미터 정보를 자바의 Map으로 대신 넘기도록 하면 컨트롤러는 서블릿 기술을 몰라도 된다.
• 뷰 이름 중복 제거 : 경로를 지정하는 부분과 파일의 확장자 부분을 작성하는 부분이 중복된다. 각 컨트롤러는 논리 이름만 반환하도록 하고, 물리 위치의 이름은 프론트 컨트롤러에서 처리하도록 하자. (유지보수 편리)

지금까지 컨트롤러에서 서블릿에 종속적인 HttpServletRequest를 사용했고, Model도 request.setAttribute()를 통해 데이터를 보관하고 뷰에 전달했다. 이번 버전에서는 서블릿의 종속성을 제거하기 위해 Model을 직접 만들고, 뷰의 논리 이름을 물리 이름으로 바꿔주는 객체도 생성해볼 것이다.

 

ModelView

public class ModelView {

    private String viewName;
    private Map<String, Object> model = new HashMap<>(); // key=이름, value=객체

    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 객체를 가지고 있다.

 

ControllerV3

public interface ControllerV3 {

    ModelView process(Map<String, String> paramMap);
}

• 이제 컨트롤러는 서블릿 기술을 전혀 사용하지 않는다. > 구현 매우 단순, 테스트하기도 쉬워짐
• HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러에서 paramMap에 담아준다.
• 각 컨트롤러는 로직 수행 후 ModelView를 반환한다.

 

회원 저장 컨트롤러

public class MemberSaveControllerV3 implements ControllerV3 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public ModelView process(Map<String, String> paramMap) {

        // 기존 방식이었던 getParameter() 메서드를 사용하는 부분은 front controller에서 처리해줌
        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에서 요청 파라미터의 값을 꺼내서 비즈니스 로직을 수행한다.
• 컨트롤러에서 ModelView 객체를 생성하는데, 이때 생성자의 매개변수로 논리 이름을 입력한다.
• ModelView 객체의 model에 뷰를 렌더링 할 때 필요한 객체를 담고 반환한다.

 

FrontControllerV3

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

    // 생략

    Map<String, String> paramMap = createParamMap(request);
    // request, response 대신 paraMap을 넘겨줘야 함
    ModelView mv = controller.process(paramMap);

    String viewName = mv.getViewName();

    MyView view = viewResolver(viewName);// 논리 이름을 물리 이름으로 바꿔줌
    view.render(mv.getModel(), request, response);

} // service

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

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

• HttpServletRequest에서 파라미터 정보를 꺼내서 paramMap에 넣어둔다.
• 이때 생성된 paramMap은 컨트롤러가 호출될 때 전달된다.
• viewResolver 메서드는 논리 이름을 받아 물리 뷰 경로로 변환하고, 실제 물리 경로가 있는 MyView 객체를 반환한다.
• render()를 수행하게 되면 뷰 렌더링할 때 필요한 데이터가 담긴 모델 Map도 넘겨줘야 한다.

 

MyView

public class MyView {
	
    // ...
	
    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);
    }

    // model에 있는 데이터를 request의 attribute로 설정 -> JSP 사용 시 필요
    private void modelToRequestAttribute(Map<String, Object> model, HttpServletRequest request) {
        model.forEach((key, value) -> request.setAttribute(key,value));
    }
}

• MyView에서는 넘어온 모델 Map을 가지고 각 데이터에 대해 request.setAttribute를 수행한다.

 

---

강의 링크

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