[Spring] MVC 프레임 워크 만들기

728x90

프론트 컨트롤러 패턴

프론트 컨트롤러의 서블릿 하나로 클라이언트의 요청을 받는다.
프론트 컨트롤러가 요청에 맞는 컨트롤러를 찾아서 호출해준다.
공통 처리가 가능하다.
프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿으로 사용하지 않아도 된다.
스프링 웹 MVC의 핵심 기능이 프론트 컨트롤러다.
스프링 웹 MVC의 DispatcherServlet이 프론트 컨트롤러 패턴으로 구현되어 있다.

🔍 프론트 컨트롤러 패턴 도입 전

🔍 프론트 컨트롤러 패턴 도입 후

프론트 컨트롤러 도입 - V1

리팩토링을 할 때는 구조를 먼저 바꾸고 코드 중복 등 디테일적인 부분을 수정한다.
먼저 구조를 바꿔보자.

🔍 V1 구조

프론트 컨트롤러가 HTTP 요청을 받아서 URL 매칭에 맞는 컨트롤러를 호출해서 뷰를 띄운다.

📌 ControllerV1 인터페이스

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

서블릿과 비슷한 모양의 컨트롤러 인터페이스다.
프론트 컨트롤러를 제외한 나머지 컨트롤러는 이 인터페이스를 구현하면 된다.
프론트 컨트롤러는 이 인터페이스를 호출해서 구현과 관계없이 로직의 일관성을 가질 수 있다.

🔍 회원 등록 컨트롤러

📌MemberFormControllerV1 클래스

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

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 MemberFormControllerV1 implements ControllerV1 {
    @Override
    public void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String viewPath = "/WEB-INF/views/new-form.jsp";
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
}

🔍 회원 저장 컨트롤러

📌 MemberSaveControllerV1 클래스

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 {

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

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

    }
}

🔍 회원 목록 컨트롤러

📌 MemberListControllerV1 클래스

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

    }
}

🔍 프론트 컨트롤러

📌 FrontControllerServletV1 클래스

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;

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

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

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        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);
    }
}

16번째 줄 @WebServlet의 속성인 urlPatterns = "/front-controller/v1/*" 는 /front-controller/v1를 포함한 하위 모든 요청을 이 서블릿에서 받아들인다.
controllerMap 에서느 key값은 매핑 URL, value값은 호출될 컨트롤러다.
request.getRequestURI()는 웹 서버로 요청 시, 요청에 사용된 URL 로부터 URI 값을 리턴한다.
- getRequestURL() 는https://www.abc123.com:80/test1.jsp 라고 나온다
- getRequestURI() 는 /test1.jsp 라고 나온다
먼저 requestURI를 조회해서 실제 호출할 컨트롤러를 controllerMap에서 찾는다.
없다면 404(SC_NOT_FOUND) 상태코드를 반환한다.
controllerMap에서 매칭되는 URL이 있으면 맞는 컨트롤러를 호출한다.
- controller.process(request, response) 호출

View 분리 - V2

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

모든 컨트롤러에서 뷰로 이동하는 부분이 중복되어 있다.
이 부분을 깔끔하게 분리하기 위해 변도로 뷰를 처리하는 객체를 만들어야 한다.

🔍 V2 구조

📌 MyView 클래스

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 {
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
}

MyView를 만들어서 랜더링은 모두 MyView가 처리하도록 만들었다.
코드 중복 해결

📌 ControllerV2 인터페이스

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;

}

이 인터페이스를 구현한 클래스들은 dispatcher.forward() 메서드를 직접 호출하지 않아도 된다.
viewPath 정보가 담긴 MyView 객체를 반환하면 된다.

🔍 회원 등록 폼

📌 MemberFormControllerV2 클래스

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

해당 컨트롤러는 dispatcher.forward() 메서드를 직접 호출하지 않고 viewPath가 담긴 MyView 객체를 생성한다.

🔍 회원 저장

📌 MemberSaveControllerV2 클래스

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

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

        request.setAttribute("member", member);

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

🔍 회원 목록

📌 MemberListControllerV2 클래스

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

🔍 프론트 컨트롤러 V2

📌FrontControllerServletV2 클래스

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;

@WebServlet(name = "frontControllerServletV2", urlPatterns = "/front-controller/v2/*")
public class FrontControllerServletV2 extends HttpServlet {

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

    public FrontControllerServletV2() {
        controllerMap.put("/front-controller/v2/members/new-form", new MemberFormControllerV2());
        controllerMap.put("/front-controller/v2/members/save", new MemberSaveControllerV2());
        controllerMap.put("/front-controller/v2/members", new MemberListControllerV2());
    }

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

    }
}

ControllerV2의 반환타입이 MyView 이므로 프론트 컨트롤러는 컨트롤러의 호출 결과로 MyView를 반환 받는다.
MyView 객체의 render() 메서드를 호출하면 forward 로직이 수행해서 JSP가 실행된다.

Model 추가 - V3

서블릿 종속성 제거
- 컨트롤러 입장에서 HttpServletRequest, HttpServletResponse 객체가 꼭 필요하지 않다.
- 요청 파라미터 정보는 자바의 Map으로 대신 넘기도록 하면 컨트롤러가 서블릿 기술을 몰라도 동작할 수 있다.
- request 객체를 Model로 사용하기 위해 별도의 Model 객체를 만들어서 반환하면 된다.
- 컨트롤러가 서블릿 기술을 전혀 사용하지 않도록 변경하면 된다.
- 이렇게 하면 구현 코드가 매우 단순해지고, 테스트 코드 작성이 쉽다.
뷰 이름 중복 제거
- 컨트롤러는 뷰의 논리 이름을 반환하고, 실제 물리 위치의 이름은 프론트 컨트롤러에서 처리하도록 단순화 했다.
- 뷰의 논리 이름 : new-form
  - 물리적 위치 이름 : /WEB-INF/views/new-form.jsp
- 이렇게 뷰의 논리적 이름과 물리적 위치 이름을 분리두면 뷰의 폴더 위치가 변경되어도 프론트 컨트롤러만 고치면 된다.

🔍 V3 구조

🔍 ModelView

서블릿의 종속성을 제거하기 위해 Model를 직접 만들고 추가로 View 이름까지 전달하는 객체를 만들어야 한다.
- 지금까지 컨트롤러에서 서블릿에 종속적인 HttpServletRequest를 사용했다
- 그러나 이번 V3 버전에서는 컨트롤러에서 HttpServletRequest를 사용할 수 없다.
- 직접 request.setAttribute() 메서드를 호출할 수도 없다.
- 따라서 Model 객체가 별도로 필요하다.

📌 ModelView 클래스

package hello.servlet.web.frontcontroller;

import lombok.Getter;
import lombok.Setter;

import java.util.HashMap;
import java.util.Map;

@Getter @Setter
public class ModelView {

    private String viewName;

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

    public ModelView(String viewName) {
        this.viewName = viewName;
    }
}

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

📌ControllerV3

package hello.servlet.web.frontcontroller.v3;

import hello.servlet.web.frontcontroller.ModelView;

import java.util.Map;

public interface ControllerV3 {

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

}

해당 컨트롤러는 서블릿 기술을 전혀 사용하지 않는다.
따라서 구현이 매우 단순해지고, 테스트 코드 작성시 테스트 하기 쉽다.
HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 paramMap에 담아서 호출하면 된다.
응답 결과로 뷰 이름과 뷰에 전달할 Model 데이터를 포함하는 ModelView 객체를 반환한다.

🔍 회원 등록 폼

📌 MemberFormControllerV3

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

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.v3.ControllerV3;

import java.util.Map;

public class MemberFormControllerV3 implements ControllerV3 {

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

}

ModelView를 생성할 때 new-form 이라는 view의 논리적 이름으로 지정한다.
실제 물리적 위치의 이름은 프론트 컨트롤러에서 처리할 것이다.

🔍 회원 저장

📌 MemberSaveControllerV3

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

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.v3.ControllerV3;

import java.util.Map;

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

파라미터 정보는 map에 담겨있으므로 map에서 필요한 요청 파라미터를 조회하면 된다.
mv.getModel().put("member", member);
- 모델은 단순히 map 이므로 모델에 뷰에 필요한 member 객체를 담고 반환한다.

🔍 회원 목록

📌 MemberListControllerV3

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

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.v3.ControllerV3;

import java.util.List;
import java.util.Map;

public class MemberListControllerV3 implements ControllerV3 {

    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    public ModelView process(Map<String, String> paramMap) {
        List<Member> members = memberRepository.findAll();
        ModelView mv = new ModelView("members");
        mv.getModel().put("members", members);

        return mv;
    }
}

🔍 프론트 컨트롤러 - V3

📌 FrontControllerServletV3

package hello.servlet.web.frontcontroller.v3;

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.MyView;
import hello.servlet.web.frontcontroller.v3.controller.MemberFormControllerV3;
import hello.servlet.web.frontcontroller.v3.controller.MemberListControllerV3;
import hello.servlet.web.frontcontroller.v3.controller.MemberSaveControllerV3;

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;

@WebServlet(name = "frontControllerServletV3", urlPatterns = "/front-controller/v3/*")
public class FrontControllerServletV3 extends HttpServlet{

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

    public FrontControllerServletV3() {
        controllerMap.put("/front-controller/v3/members/new-form", new MemberFormControllerV3());
        controllerMap.put("/front-controller/v3/members/save", new MemberSaveControllerV3());
        controllerMap.put("/front-controller/v3/members", new MemberListControllerV3());
    }

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String requestURI = request.getRequestURI();

        ControllerV3 controller = controllerMap.get(requestURI);

        if (controller==null) {
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }

        Map<String, String> paramMap = createParamMap(request);

        ModelView mv = controller.process(paramMap);

        String viewName = mv.getViewName(); // 논리 이름 ex) new-form

        MyView view = veiwResolver(viewName);

        view.render(mv.getModel(), request, response);

    }

    private MyView veiwResolver(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(paraName -> paramMap.put(paraName, request.getParameter(paraName)));
        return paramMap;
    }
}

📌 MyView

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

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 {
        modelToReqeustAttribute(model, request);
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }

    private void modelToReqeustAttribute(Map<String, Object> model, HttpServletRequest request) {
//        model.forEach((key, value) -> request.setAttribute(key, value));
        model.forEach(request::setAttribute);

    }

}

👀 참고 자료

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard

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

웹 애플리케이션을 개발할 때 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. 스프링 MVC의 핵심 원리와 구조를 이해하고, 더 깊이있는 백엔드 개발자로 성장할 수 있습니다., -

www.inflearn.com

https://tnsgud.tistory.com/656

request 객체 메소드 간단정리 및 getRequestURL()과 getRequestURI() 차이

Request 객체 메소드 간단정리 자바 Request 메소드들을 간단히 정리해 보았다. 자주사용하면서도 매번 찾게 되는 휘발성 기억력 때문에 정리를 해보았다. 깔끔하게 정리 해놓으신 분들도 많다는

tnsgud.tistory.com

728x90

'[ Spring ] > SpringMVC 1편' 카테고리의 다른 글

[Spring] 로깅 (Slf4j / Logback) (0)	2022.02.24
[Spring] MVC 구조 (0)	2022.02.22
[Spring] Servlet과 JSP로 MVC 패턴 구현하기 (0)	2022.02.18
[Spring] MVC 패턴 (Model - View - Controller) (0)	2022.02.18
[Spring] JSP로 회원 관리 웹 애플리케이션 만들기 (0)	2022.02.18

프론트 컨트롤러 패턴

🔍 프론트 컨트롤러 패턴 도입 전

🔍 프론트 컨트롤러 패턴 도입 후

프론트 컨트롤러 도입 - V1

🔍 V1 구조

🔍 회원 등록 컨트롤러

🔍 회원 저장 컨트롤러

🔍 회원 목록 컨트롤러

🔍 프론트 컨트롤러

View 분리 - V2

🔍 V2 구조

🔍 회원 등록 폼

🔍 회원 저장

🔍 회원 목록

🔍 프론트 컨트롤러 V2

Model 추가 - V3

🔍 V3 구조

🔍 ModelView

🔍 회원 등록 폼

🔍 회원 저장

🔍 회원 목록

🔍 프론트 컨트롤러 - V3

'[ Spring ] > SpringMVC 1편' 카테고리의 다른 글

티스토리툴바