-
[Spring] MVC 프레임 워크 만들기 ( 1 ), 프론트 컨트롤러, 어댑터 구조Back-end/Spring 2022. 3. 18. 16:58
안녕하세요 이번 포스팅에서는 기존 MVC패턴에서 컨트롤러의 중복을 제공하는 수문장 역할을 하는 프론트 컨트롤러에 대해 알아보겠습니다!!
프론트 컨트롤러 패턴 소개
프론트 컨트롤러 도입 전
프론트 컨트롤러 도입 후
FrontController 패턴 특징
- 프론트 컨트롤러 서블릿 하나로 클라이언트의 요청을 받음
- 프론트 컨트롤러가 요청에 맞는 컨트롤러를 찾아서 호출
- 입구를 하나로!!
- 공통 처리 기능
- 프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿을 사용하지 않아도 됨
스프링 웹 MVC와 프론터 컨트롤러
스프링 웹 MVC의 핵심도 바로 FrontController입니다.
스프링 웹 MVC의 DispatcherServlet이 FrontController 패턴으로 구현되어 있습니다.
프론트 컨트롤러 도입 -v1
프론트 컨트롤러를 단계적으로 도입해봅시다.
이번 목표는 기존 코드를 최대한 유지하면서, 프론트 컨트롤러를 도입하는 것입니다.
먼저 구조를 맞추어두고 점진적으로 리팩터링 해보겠습니다.
ControllerV1
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 - 회원 등록 컨트롤러
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 - 회원 저장 컨트롤러
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); 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 - 회원 목록 컨트롤러
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 - 프론트 컨트롤러
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 = "/frontcontroller/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); } }
프론트 컨트롤러 분석
urlPatterns = "/front-controller/v1/*" : /front-controller/v1를 포함한 하위 모든 요청은 이 서블릿에서 받아들입니다.
controllerMap
- key : 매핑 URL
- value : 호출될 컨트롤러
service()
먼저 이 requestURI를 조회해서 실제 호출할 컨트롤러를 controllerMap에서 찾습니다. 만약 없다면 404 상태 코드를 반환하고 return 합니다.
컨트롤러를 찾고 controller.process(request, response); 을 호출해서 해당 컨트롤러를 실행합니다.
JSP
JSP는 이전 MVC에서 사용했던 것을 그대로 사용합니다.
View 분리 -v2
현재 모든 컨트롤러에서 뷰로 이동하는 부분에 중복이 있고, 깔끔하지 않습니다.
이 부분을 깔끔하게 분리하기 위해 별도로 뷰를 처리하는 객체를 만들어 봅시다.
MyView
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
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; }
MemberFormControllerV2- 회원 등록 폼
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을 구현한 클래스와 ControllerV2를 구현한 클래스를 비교해보면, 이 부분의 중복이 확실하게 제거된 것을 확인할 수 있습니다.
MemberSaveControllerV2-회원 저장
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- 회원 목록
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
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; @WebServlet(name = "frontControllerServletV2", urlPatterns = "/frontcontroller/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를 반환받습니다. 그리고 view.render()를 호출하면 forward 로직을 수행해서 JSP가 실행됩니다.
MyView.render()
프론트 컨트롤러의 도입으로 MyView 객체의 render()를 호출하는 부분을 모두 일관되게 처리할 수 있습니다. 각각의 컨트롤러는 MyView 객체를 생성만 해서 반환하면 됩니다.
Model 추가 -v3
서블릿 종속성 제거
컨트롤러 입장에서 HttpServletRequest, HttpServletResponse이 꼭 필요할까요?
요청 파라미터 정보는 자바의 Map으로 대신 넘기도록 하면 지금 구조에서는 컨트롤러가 서블릿 기술을 몰라도 동작할 수 있습니다.
그리고 request 객체를 Model로 사용하는 대신에 별도의 Model 객체를 만들어서 반환하면 됩니다.
우리가 구현하는 컨트롤러가 서블릿 기술을 전혀 사용하지 않도록 변경해봅시다.
이렇게 하면 구현 코드도 매우 단순해지고, 테스트 코드 작성이 쉽습니다.
뷰 이름 중복 제거
컨트롤러에서 지정하는 뷰 이름에 중복이 있는 것을 확인할 수 있습니다. 컨트롤러는 뷰의 논리 이름을 반환하고, 실제 물리 위치의 이름은 프론트 컨트롤러에서 처리하도록 단순화 합시다. 이렇게 해두면 향후 뷰의 폴더 위치가 함께 이동해도 프론트 컨트롤러만 고치면 됩니다.
ModelView
지금까지 컨트롤러에서 서블릿에 종속적인 HttpServletRequest를 사용했습니다. 그리고 Model도 request.setAttribute()를 통해 데이터를 지정하고 뷰에 전달했습니다.
서블릿의 종속성을 제거하기 위해 Model을 직접 만들고, 추가로 View이름까지 전달하는 객체를 만들어봅시다.
(이번 버전에서는 컨트롤러에서 HttpServletRequest를 사용할 수 없습니다. 따라서 직접 request.setAttribute()를 호출할 수 없습니다. 따라서 Model이 별도로 필요합니다.)
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) { 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 객체를 가지고 있습니다. model은 단순히 map으로 되어있으므로 컨트롤러에서 뷰에 필요한 데이터를 key, value로 넣어주면 됩니다.
ControllerV3
import hello.servlet.web.frontcontroller.ModelView; import java.util.Map; public interface ControllerV3 { ModelView process(Map<String, String> paramMap); }
이 컨트롤러는 서블릿 기술을 전혀 사용하지 않습니다. 따라서 구현이 매우 단순해지고 테스트 코드 작성 시 테스트하기 쉽습니다.
HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 paramMap에 담아서 호출해주면 됩니다.
응답 결과로 뷰 이름과 뷰에 전달할 Model 데이터를 포함하는 ModelView 객체를 반환하면 됩니다.
MemberFormControllerV3 - 회원 등록 폼
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 - 회원 저장
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에 담겨있습니다. map에서 필요한 요청 파라미터를 조회하면 됩니다.
mv.getModel(). upt("member", member);
모델은 단순한 map이므로 모델의 뷰에서 필요한 member 객체를 담고 반환합니다.
MemberListControllerV3 - 회원 목록
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
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 = "/frontcontroller/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(); MyView view = viewResolver(viewName); view.render(mv.getModel(), request, response); } 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; } private MyView viewResolver(String viewName) { return new MyView("/WEB-INF/views/" + viewName + ".jsp"); } }
이 상태에서 view.render() 코드에서 컴파일 오류가 발생합니다. 다음 코드를 참고해서 MyView 객체에 필요한 메서드를 추가합시다.
createParamMap()
HttpServletRequest에서 파라미터 정보를 꺼내서 Map으로 변환합니다. 그리고 해당 Map(paramMap)을 컨트롤러에 전달하면서 호출합니다.
뷰 리졸버
MyView view = viewResolver(viewName)
컨트롤러가 반환하는 논리 뷰 이름을 실제 물리 뷰 경로로 변경합니다. 그리고 실제 물리 경로가 있는 MyView객체를 반환합니다.
논리 뷰 이름 : members
물리 뷰 경로 : /WEB-INF/views/members.jsp
view.render(mv.getModel(), request, response)
-뷰 객체를 통해서 HTML 화면을 렌더링 합니다.
-뷰 객체의 render()는 모델 정보도 함께 받습니다.
-JSP는 request.getAttribute()로 데이터를 조회하기 때문에, 모델의 데이터를 꺼내서 request.setAttibute로 담아둡니다.
-JSP로 포워드 해서 JSP를 렌더링 합니다.
MyView
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); 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)); } }
단순하고 실용적인 컨트롤러 -v4
앞서 만든 v3 컨트롤러는 서블릿 종속성을 제거하고 뷰 경로의 중복을 제거하는 등, 잘 설계된 컨트롤러입니다.
그런데 실제 컨트롤러 인터페이스를 구현하는 개발자 입장에서 보면, 항상 ModelView 객체를 생성하고 반환해야 하는 부분이 조금은 번거롭습니다.
좋은 프레임워크는 아키텍처도 중요하지만, 그와 더불어 실제 개발하는 개발자가 단순하고 편리하게 사용할 수 있어야 합니다. 소위 실용성이 있어야 합니다.
이번에는 v3를 조금 변경해서 실제 구현하는 개발자들이 매우 편리하게 개발할 수 있는 v4 버전을 개발해봅시다.
기본적인 구조는 V3와 같습니다. 대신에 컨트롤러가 ModelView를 반환하지 않고 viewName 만 반환합니다.
ControllerV4
import java.util.Map; public interface ControllerV4 { /** * @param paramMap * @param model * @return viewName */ String process(Map<String, String> paramMap, Map<String, Object> model); }
이번 버전은 인터페이스에 ModelView가 없습니다. model 객체는 파라미터로 전달되기 때문에 그냥 사용하면 되고 결과로 뷰의 이름만 반환해주면 됩니다.
실제 구현 코드를 봅시다.
MemberFormControllerV4
import hello.servlet.web.frontcontroller.v4.ControllerV4; import java.util.Map; public class MemberFormControllerV4 implements ControllerV4 { @Override public String process(Map<String, String> paramMap, Map<String, Object> model) { return "new-form"; } }
정말 단순하게 new-form이라는 뷰의 논리 이름만 반환하면 됩니다.
MemberSaveControllerV4
import hello.servlet.domain.member.Member; import hello.servlet.domain.member.MemberRepository; import hello.servlet.web.frontcontroller.v4.ControllerV4; import java.util.Map; public class MemberSaveControllerV4 implements ControllerV4 { private MemberRepository memberRepository = MemberRepository.getInstance(); @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"; } }
model.put("member", member)
모델이 파라미터로 전달되기 때문에 모델을 직접 생성하지 않아도 됩니다.
MemberListControllerV4
import hello.servlet.domain.member.Member; import hello.servlet.domain.member.MemberRepository; import hello.servlet.web.frontcontroller.v4.ControllerV4; import java.util.List; import java.util.Map; public class MemberListControllerV4 implements ControllerV4 { private MemberRepository memberRepository = MemberRepository.getInstance(); @Override public String process(Map<String, String> paramMap, Map<String, Object> model) { List<Member> members = memberRepository.findAll(); model.put("members", members); return "members"; } }
FrontControllerServletV4
import hello.servlet.web.frontcontroller.MyView; import hello.servlet.web.frontcontroller.v4.controller.MemberFormControllerV4; import hello.servlet.web.frontcontroller.v4.controller.MemberListControllerV4; import hello.servlet.web.frontcontroller.v4.controller.MemberSaveControllerV4; 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 = "frontControllerServletV4", urlPatterns = "/frontcontroller/v4/*") public class FrontControllerServletV4 extends HttpServlet { private Map<String, ControllerV4> controllerMap = new HashMap<>(); public FrontControllerServletV4() { controllerMap.put("/front-controller/v4/members/new-form", new MemberFormControllerV4()); controllerMap.put("/front-controller/v4/members/save", new MemberSaveControllerV4()); controllerMap.put("/front-controller/v4/members", new MemberListControllerV4()); } @Override protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { String requestURI = request.getRequestURI(); ControllerV4 controller = controllerMap.get(requestURI); if (controller == null) { response.setStatus(HttpServletResponse.SC_NOT_FOUND); return; } 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); } 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; } private MyView viewResolver(String viewName) { return new MyView("/WEB-INF/views/" + viewName + ".jsp"); } }
FrontControllerServletV4는 사실 이전 버전과 거의 동일합니다.
모델 객체 전달
Map <String, Object) model = new HashMap <>(); //추가
모델 객체를 프론트 컨트롤러에서 생성해서 넘겨줍니다. 컨트롤러에서 모델 객체에 값을 담으면 여기에 그대로 담겨있게 됩니다.
뷰의 논리 이름을 직접 반환
컨트롤러가 직접 뷰의 논리 이름을 반환하므로 이 값을 사용해서 실제 물리 뷰를 찾을 수 있습니다.
정리
이번 버전의 컨트롤러는 매우 단순하고 실용적입니다. 기존 구조에서 모델을 파라미터로 넘기고, 뷰의 논리 이름을 반환한다는 작은 아이디어를 적용했을 뿐인데, 컨트롤러를 구현하는 개발자 입장에서 보면 이제 군더더기 없는 코드를 작성할 수 있습니다. 또한 중요한 사실은 여기까지 한 번에 온 것이 아니라는 점입니다. 프레임워크가 점진적으로 발전하는 과정 속에서 이런 방법도 찾을 수 있었습니다
유연한 컨트롤러 1 - v5
만약 어떤 개발자는 ControllerV3 방식으로 개발하고 싶고, 어떤 개발자는 ControllerV4 방식으로 개발하고 싶다면 어떻게 해야 할까요?
어댑터 패턴
지금까지 우리가 개발한 프런트 컨트롤러는 한가지 방식의 컨트롤러 인터페이스만 사용할 수 있습니다. ControllerV3 , ControllerV4 는 완전히 다른 인터페이스입니다. 따라서 호환이 불가능합니다. 마치 v3는 110v이고, v4는 220v 전기 콘센트 같은 것입니다. 이럴 때 사용하는 것이 바로 어댑터입니다. 어댑터 패턴을 사용해서 프론트 컨트롤러가 다양한 방식의 컨트롤러를 처리할 수 있도록 변경해봅시다.
V5 구조
핸들러 어댑터 : 중간에 어댑터 역할을 하는 어댑터가 추가되었는데 이름이 핸들러 어댑터입니다. 여기서 어댑터 역할을 해주는 덕분에 다양한 종류의 컨트롤러를 호출할 수 있습니다.
핸들러 : 컨트롤러의 이름을 더 넓은 범위인 핸들러로 변경했습니다. 그 이유는 이제 어댑터가 있기 때문에 꼭 컨트롤러의 개념뿐만 아니라 어떠한 것이든 해당하는 종류의 어댑터만 있으면 다 처리할 수 있기 때문입니다.
MyHandlerAdapter
어댑터는 이렇게 구현해야 한다는 어댑터용 인터페이스입니다.
import hello.servlet.web.frontcontroller.ModelView; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; public interface MyHandlerAdapter { boolean supports(Object handler); ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException; }
boolean supports(Object handler)
- handler는 컨트롤러를 말한다.
- 어댑터가 해당 컨트롤러가 처리할 수 있는지 판단하는 메서드다.
ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
- 어댑터는 실제 컨트롤러를 호출하고 그 결과로 ModelView를 반환해야 한다.
- 실제 컨트롤러가 ModelView를 반환하지 못하면 어댑터가 ModelView를 직접 생성해서라도 반환해야 한다.
- 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해서 실제 컨트롤러가 호출된다.
실제 어댑터를 구현해봅시다.
먼저 ControllerV3을 지원하는 어댑터를 구현합니다.
ControllerV3 HandlerAdapter
import hello.servlet.web.frontcontroller.ModelView; import hello.servlet.web.frontcontroller.v3.ControllerV3; import hello.servlet.web.frontcontroller.v5.MyHandlerAdapter; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.util.HashMap; import java.util.Map; public class ControllerV3HandlerAdapter implements MyHandlerAdapter { @Override public boolean supports(Object handler) { return (handler instanceof ControllerV3); } @Override public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) { ControllerV3 controller = (ControllerV3) handler; Map<String, String> paramMap = createParamMap(request); ModelView mv = controller.process(paramMap); return mv; } 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; } }
하나씩 분석해봅시다.
ControllerV3을 처리할 수 있는 어댑터를 뜻합니다.
handler를 컨트롤러 V3로 변환한 다음에 V3형식에 맞도록 호출합니다.
supports()를 통해 ControllerV3만 지원하기 때문에 타입 변환은 걱정 없이 실행해도 됩니다.
ControllerV3는 ModelView를 반환하므로 그대로 ModelView를 반환하면 됩니다.
FrontControllerServletV5
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 hello.servlet.web.frontcontroller.v5.adapter.ControllerV3HandlerAdapter; import hello.servlet.web.frontcontroller.v5.adapter.ControllerV4HandlerAdapter; 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.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; @WebServlet(name = "frontControllerServletV5", urlPatterns = "/frontcontroller/v5/*") public class FrontControllerServletV5 extends HttpServlet { private final Map<String, Object> handlerMappingMap = new HashMap<>(); private final List<MyHandlerAdapter> handlerAdapters = new ArrayList<>(); public FrontControllerServletV5() { initHandlerMappingMap(); initHandlerAdapters(); } 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()); } private void initHandlerAdapters() { handlerAdapters.add(new ControllerV3HandlerAdapter()); } @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; } MyHandlerAdapter adapter = getHandlerAdapter(handler); ModelView mv = adapter.handle(request, response, handler); MyView view = viewResolver(mv.getViewName()); view.render(mv.getModel(), request, response); } private Object getHandler(HttpServletRequest request) { String requestURI = request.getRequestURI(); return handlerMappingMap.get(requestURI); } private MyHandlerAdapter getHandlerAdapter(Object handler) { for (MyHandlerAdapter adapter : handlerAdapters) { if (adapter.supports(handler)) { return adapter; } } throw new IllegalArgumentException("handler adapter를 찾을 수 없습니다. handler=" + handler); } private MyView viewResolver(String viewName) { return new MyView("/WEB-INF/views/" + viewName + ".jsp"); } }
컨트롤러 -> 핸들러
이전에는 컨트롤러를 직접 매핑해서 사용했습니다. 그런데 이제는 어댑터를 사용하기 때문에, 컨트롤러뿐만 아니라 어댑터가 지원하기만 하면 어떤 것이라도 URL에 매핑해서 사용할 수 있습니다. 그래서 이름을 컨트롤러에서 더 넓은 범위의 핸들러로 변경했습니다.
생성자는 핸들러 매핑과 어댑터를 초기화(등록) 합니다.
매핑 정보
매핑 정보의 값이 ControllerV3, ControllerV4 같은 인터페이스에서 아무 값이나 받을 수 있는 Object로 변경되었습니다.
핸들러 매핑
핸들러 매핑 정보인 handlerMappingMap에서 URL에 매핑된 핸들러(컨트롤러) 객체를 찾아서 반환합니다.
핸들러를 처리할 수 있는 어댑터 조회
handler를 처리할 수 있는 어댑터를 adapter.supports(handler)를 통해서 찾습니다.
handler가 ControllerV3 인터페이스를 구현했다면, ControllerV3 HandlerAdapter 객체가 반환됩니다.
어댑터 호출
어댑터의 handle(request, response, handler) 메서드를 통해 실제 어댑터가 호출됩니다. 어댑터는 handler를 호출하고 그 결과를 어댑터에 맞추어 반환합니다.
ControllerV3 HandlerAdapter의 경우 어댑터의 모양과 컨트롤러의 모양이 유사해서 변환 로직이 단순합니다.
정리
지금은 V3컨트롤러를 사용할 수 있는 어댑터와 ControllerV3만 들어 있어서 크게 감흥이 없을 것입니다. ControllerV4를 사용할 수 있도록 기능을 추가해봅시다.
유연한 컨트롤러 2 -v5
FrontControllerServletV5에 ControllerV4 기능도 추가해봅시다.
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()); //V4 추가 handlerMappingMap.put("/front-controller/v5/v4/members/new-form", new MemberFormControllerV4()); handlerMappingMap.put("/front-controller/v5/v4/members/save", new MemberSaveControllerV4()); handlerMappingMap.put("/front-controller/v5/v4/members", new MemberListControllerV4()); } private void initHandlerAdapters() { handlerAdapters.add(new ControllerV3HandlerAdapter()); handlerAdapters.add(new ControllerV4HandlerAdapter()); //V4 추가 }
핸들러 매핑에 ControllerV4를 사용하는 컨트롤러를 추가하고, 해당 컨트롤러를 처리할 수 있는 어댑터인 ControllerV4 HandlerAdapter도 추가합시다.
ControllerV4HandlerAdapter
import hello.servlet.web.frontcontroller.ModelView; import hello.servlet.web.frontcontroller.v4.ControllerV4; import hello.servlet.web.frontcontroller.v5.MyHandlerAdapter; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.util.HashMap; import java.util.Map public class ControllerV4HandlerAdapter implements MyHandlerAdapter { @Override public boolean supports(Object handler) { return (handler instanceof ControllerV4); } @Override public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) { ControllerV4 controller = (ControllerV4) handler; Map<String, String> paramMap = createParamMap(request); Map<String, Object> model = new HashMap<>(); String viewName = controller.process(paramMap, model); ModelView mv = new ModelView(viewName); mv.setModel(model); return mv; } 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; } }
하나씩 분석해봅시다.
handler가 ControllerV4인 경우에만 처리하는 어댑터입니다.
handler를 ControllerV4로 캐스팅하고, paramMap, model을 만들어서 해당 컨트롤러를 호출합니다.
그리고 viewName을 반환받습니다.
어댑터에서 이 부분이 단순하지만 중요한 부분입니다.
어댑터가 호출하는 ControllerV4는 뷰의 이름을 반환합니다. 그런데 어댑터는 뷰의 이름이 아니라 ModelView를 만들어서 반환해야 합니다. 여기서 어댑터가 꼭 필요한 이유가 나옵니다. ControllerV4는 뷰의 이름을 반환했지만 어댑터는 이것을 ModelView로 만들어서 형식을 맞추어 반환합니다. 마치 110v 전기 콘센트를 220v 전기 콘센트로 변경하듯이!!
다음 포스팅에서는 우리가 지금 까지 만든 프레임 워크와 스프링 프레임워크를 비교해보겠습니다!!
'Back-end > Spring' 카테고리의 다른 글
[Spring] 핸들러 매핑과 핸들러 어댑터 (0) 2022.03.21 [Spring] 스프링 MVC - 구조 이해 (0) 2022.03.20 [Spring] 서블릿의 기본적인 개요, Request, Response, GET, POST, JSON, HTTP message (0) 2022.03.18 [Spring]서블릿의 기본 사용법 예제 ( 2 ), JSP로 회원 웹 애플리케이션 개발 그리고 MVC패턴의 등장, MVC의 한계 (0) 2022.03.18 [Spring] 서블릿의 기본 사용법 예제 ( 1 ) (0) 2022.03.18