[Spring MVC] [1] 4. MVC 프레임워크 만들기_1

윤경·2021년 9월 7일
TILspringMVC
0

Spring MVC

목록 보기
5/26
post-thumbnail

[1] 프론트 컨트롤러 패턴 소개

프론트 컨트롤러 📌 도입 전

프론트 컨트롤러 📌 도입 후

FrontController 패턴 특징

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

  • 프론트 컨트롤러가 요청에 맞는 컨트롤러를 찾아 호출
    ➡️ 즉, 입구가 하나

  • 공통 처리 가능

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

FrontController는 스프링 웹 MVC의 핵심!
DispatcherServlet는 FrontController 패턴으로 구현

[2] 프론트 컨트롤러 도입 - v1

v1: 기존 코드는 유지하며 프론트 컨트롤러 하나만 살~짝 도입!

구조

✔️ 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 {

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

        Member member = new Member(username, age);
        System.out.println("member = " + member);
        memberRepository.save(member);

        // Model에 데이터를 보관해야 함
        request.setAttribute("member", member); // request 객체 내 저장소에 저장

        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 {
        System.out.println("MvcMemberListServlet.service");
        List<Member> members = memberRepository.findAll();

        request.setAttribute("members", members);   // "members": key, members: value

        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;

// v1 아래 어떤 url이 들어와도 이 서블릿을 호출하게 됨
@WebServlet(name = "frontControllerServletV1", urlPatterns = "/front-controller/v1/*")
public class FrontControllerServletV1 extends HttpServlet {

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

    // command+n -> constructor -> select None
    public FrontControllerServletV1() {
        // 이 url 요청이 오면 new MemberFormControllerV1 이게 실행 됨
        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"); // 원래는 sout보다 log로 찍는 것이 좋음

        // uri로 들어오는 /front-controller/v1/members/new-form 이런식으ㅁ requestURI로 받을 수 있음
        String requestURI = request.getRequestURI();

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

        controller.process(request, response);
    }
}

urlPatterns
urlPatterns = "/front-controller/v1/*": /front-controller/v1 를 포함한 하위 모든 요청은 이 서블릿에서 받아들임

controllerMap
key: 매핑 URL
value: 호출될 컨트롤러

service()
먼저 requestURI를 조회해 실제 호출할 컨트롤러를 controllerMap에서 찾음. ➡️ 없다면 404 반환

컨트롤러를 찾고 controller.process(request, response); 를 호출해 해당 컨트롤러 실행

JSP
JSP는 이전 MVC에서 사용했던 것 그대로 사용 (jsp에서 action 건들지 않기 !! ex. action="save")

[3] View 분리 - v2

v1에서 모든 컨트롤러에서 뷰로 이동하는 부분에 중복과 코드가 지저분하다.

구조

✔️ MyView

위치가 중요!! frontcontroller에 바로 만들기

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

✔️ 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 {
    // V1과 똑같지만 V2에서는 MyView를 반환하도록
    MyView process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;

}

➡️ 컨트롤러가 뷰를 반환

✔️ 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()를 직접 생성해 호출하지 않아도 됨. MyView 객체를 생성하고 뷰 이름을 넣고 반환하기만 하면 됨.

ControllerV1 대비 중복이 제거됨.

✔️ 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.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
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");
    }
}

✔️ FrontControllerServletV2

package hello.servlet.web.frontcontroller.v2;

import hello.servlet.web.frontcontroller.MyView;
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 아래 어떤 url이 들어와도 이 서블릿을 호출하게 됨
@WebServlet(name = "frontControllerServletV2", urlPatterns = "/front-controller/v2/*")
public class FrontControllerServletV2 extends HttpServlet {

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

    // command+n -> constructor -> select None
    public FrontControllerServletV2() {
        // 이 url 요청이 오면 new MemberFormControllerV2 이게 실행 됨
        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 {

        // uri로 들어오는 /front-controller/v2/members/new-form 이런식으ㅁ requestURI로 받을 수 있음
        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를 반환받음.

view.render() 호출시 forward 로직을 수행해 JSP 실행

프론트 컨트롤러로 인해 MyView 객체의 render() 호출하는 부분을 일관성 있게 처리함.
각 컨트롤러가 MyView 객체를 생성만 해 반환하면 됨.

[4] Model 추가 - v3

V3 버전에서는 서블릿 종속성이 제거, 뷰 이름 중복을 제거했다.

컨트롤러 입장에서는 HttpServletRequest, HttpServletResponse가 필요 없다.
요청 파라미터 정보는 자바의 Map으로 대신 넘기도록해 컨트롤러가 서블릿 기술을 몰라도 동작할 수 있다.

request 객체를 Model로 사용하는 대신 별도의 Model 객체를 만들어 반환하자. (컨트롤러가 서블릿 기술을 전혀 사용하지 않도록 변경하자)

컨트롤러에서 지정하는 (/WEB-INF/views/)뷰 이름에 중복이 있다. 컨트롤러는 뷰의 이름 논리를 반환하고, 실제 물리 위치의 이름은 프론트 컨트롤러에서 처리하도록 해보자.
➡️ 변경의 지점을 하나로 두는 것은 좋은 설계 🙃

구조

✔️ ModelView

지금껏 컨트롤러에서 서블릿에 종속적인 HttpServletRequest를 사용하고 Model 또한 request.setAttribute()를 통해 데이터를 저장, 뷰에 저장했다.

이제 request 자체가 없기 때문에 Model을 직접 만들고 View 이름까지 전달하도록 객체를 생성하자.

package hello.servlet.web.frontcontroller;

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

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

    public ModelView(String viewName) { // command+n constructor
        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;
    }
}

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

✔️ MemberFormControllerV3

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

import hello.servlet.web.frontcontroller.ModelView;
import hello.servlet.web.frontcontroller.v3.ControllerV3;
import org.springframework.ui.Model;

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

paramMap.get("username");: 파라미터 정보는 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;
    }
}

✔️ 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;

// v1 아래 어떤 url이 들어와도 이 서블릿을 호출하게 됨
@WebServlet(name = "frontControllerServletV3", urlPatterns = "/front-controller/v3/*")
public class FrontControllerServletV3 extends HttpServlet {

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

    // command+n -> constructor -> select None
    public FrontControllerServletV3() {
        // 이 url 요청이 오면 new MemberFormControllerV2 이게 실행 됨
        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 {

        // uri로 들어오는 /front-controller/v3/members/new-form 이런식으ㅁ requestURI로 받을 수 있음
        String requestURI = request.getRequestURI();

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

        // 메소드를 뽑음
        Map<String, String> paramMap = createParaMap(request);
        ModelView mv = controller.process(paramMap);

        String viewName = mv.getViewName();// 논리이름 new-form
        // /WEB-INF/views/new-form.jsp
        MyView view = new MyView("/WEB-INF/views/" + viewName + ".jsp");

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

    private Map<String, String> createParaMap(HttpServletRequest request) {
        Map<String, String> paramMap = new HashMap<>();
        // 모든 파라미터 이름을 다 가져와서 돌리며 key=paramName, value=request.getParameter(paramName) 를 다 꺼내
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> paramMap.put(paramName, request.getParameter(paramName)));
        return paramMap;
    }
}

뷰 리졸버
MyView view = viewResolver(viewName): 컨트롤러가 반환한 논리 뷰 이름을 실제 뷰 경로로 변환

view.render(mv.getModel(), request, response): 뷰 객체를 통해 HTML 화면을 렌더링
JSP는 request.getAttribute()로 데이터를 조회하기 때문에, 모델의 데이터를 꺼내 request.setAttribute()로 담아둔다. JSP로 포워드해 JSP를 렌더링.

📌 view.render(mv.getModel(), request, response); 에서 mv.getModel()로 파라미터가 하나 더 생기다보니 create(command+enter)를 해줘야 함 ⬇️

✔️ (수정) 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 {
        modelToRequestAttribute(model, request);

        // modelToRequestAttribute을 수행하고 jsp가 오면 getRequestDispatcher를 수행
        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));    // map에 루프를 다 돌리는 코드
    }

}

profile
윤경
개발 바보 이사 중
이전 포스트

[Spring MVC] [1] 3. 서블릿, JSP, MVC 패턴

다음 포스트

[Spring MVC] [1] 4. MVC 프레임워크 만들기_2

0개의 댓글