스프링 MVC의 핵심 구조를 파악하기 전 스프링 MVC 패턴이 가지고 있는 프론트 컨트롤러 패턴에 대해 알아보고자 한다.
1. 프론트 컨트롤러(Front Controller)
1-1. 개요
(1) 이전에는 서블릿을 컨트롤러로 하고 JSP를 뷰 영역으로 하는 자체적인 MVC 패턴을 도입해 보았으나 여러 가지 문제점이 발생했다.
(공통 처리, 코드의 반복 작업 등) 이러한 부분을 개선하기 위해서는 프론트 컨트롤러 패턴이 필요하다.
1-2. 프론트 컨트롤러란 무엇일까?
(1) 프론트 컨트롤러 도입 이전엔 각 컨트롤러마다 공통으로 처리 가능한 로직을 설계했다. 클라이언트가 어떤 컨트롤러로 들어올지 모르기 때문에 위와 같은 설계 방식을 따라야 했다. 하지만 아래와 같이 프론트 컨트롤러를 도입한 상황을 살펴보자.
(2) 위와 같이 프론트 컨트롤러에 공통 처리 기능 로직을 다 몰아주고, 이후에 클라이언트의 각 요청에 맞는 컨트롤러로 보내어 처리될 수 있도록 프론트 컨트롤러 패턴이 도입되었다. 이렇게 공통의 관심사를 별도로 모아주는 소위 문지기 역할을 수행하는 컨트롤러를 앞에 두고 각 나머지 컨트롤러는 뒤에 배치시키는 패턴을 프론트 컨트롤러(Front Controller) 패턴이라고 한다.
1-3. 프론트 컨트롤러의 특징
(1) 프론트 컨트롤러도 일종의 서블릿이다. 해당 컨트롤러 하나로 클라이언트의 모든 요청을 받아들인다.
(2) 프론트 컨트롤러가 공통 처리 이후 요청에 맞는 컨트롤러를 찾아서 호출한다.
(3) 간단히 말하면 입구를 만들어주는 것이다.
(4) 궁극적으로 프론트 컨트롤러를 통해 공통 처리가 가능해진다.
(5) 프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿을 사용하지 않아도 된다
- 클라이언트의 요청에 대한 매핑을 할 때 자바 서블릿을 통해 매핑을 했다. 따라서 프론트 컨트롤러가 서블릿에 해당하고 나머지 컨트롤러들은 서블릿으로 구현하지 않아도 된다. 왜냐하면 프론트 컨트롤러가 나머지 컨트롤러를 직접 호출할 예정이기 때문이다.
- 클라이언트에서 요청이 오면 WAS 내부의 서블릿에서 요청을 받아들였다. 해당 역할을 프론트 컨트롤러가 해 주게 된다.
(6) 스프링 MVC와 프론트 컨트롤러
- 스프링 MVC의 핵심도 바로 프론트 컨트롤러 패턴에 있다. 스프링 MVC의 DispatcherServlet이 프론트 컨트롤러로 구현되어 있다.
2. 프론트 컨트롤러 도입
2-1. 컨트롤러 인터페이스
(1) 컨트롤러 인터페이스를 만드는 이유는 이후 사용자 요청에 따른 여러 가지 컨트롤러들이 필요하기 때문이고 프론트 컨트롤러는 해당 인터페이스에 의존하면서 여러 가지 컨트롤러들을 호출할 수 있게 된다.
- 여러 가지 컨트롤러들 : 회원 폼 등록, 회원 저장, 회원 리스트 출력 컨트롤러 등
public interface ControllerV1 {
void process (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}
(2) 서블릿과 비슷한 형태의 컨트롤러 인터페이스를 도입한다. 각 컨트롤러들은 해당 인터페이스를 구현하게 된다. 프론트 컨트롤러는 이 인터페이스를 호출해서 구현과 관계없이 로직의 일관성을 가져갈 수 있다.
2-2. MemberFormControllerV1 - 회원 등록 컨트롤러
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);
}
}
2-3. MemberSaveControllerV1 - 회원 저장 컨트롤러
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);
// Model에 데이터를 보관해야 함
request.setAttribute("member", member);
String viewPath = "/WEB-INF/views/save-result.jsp";
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);
}
}
2-4. MemberListControllerV1 - 회원 목록 컨트롤러
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);
}
}
(1) 회원 목록, 저장, 등록 컨트롤러의 경우 서블릿에서 사용하던 로직과 거의 유사하다. 이제 프론트 컨트롤러를 설계해 보자
2-5. FrontControllerServletV1 - 프론트 컨트롤러
@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");
// front-controller/v1/members
String requestURI = request.getRequestURI();
ControllerV1 controller = controllerMap.get(requestURI);
if (controller == null) {
response.setStatus(HttpServletResponse.SC_NOT_FOUND);
return;
}
controller.process(request, response);
}
}
(1) urlPatterns = "/front-controller/v1/*"
- /front-controller/v1를 포함한 모든 하위 요청은 해당 서블릿에서 받아들이게 된다.
(2) controllerMap
- 키가 요청 URL, 실제 값이 호출할 컨트롤러이다.
(3) service() 메서드
- 먼저 requestURI를 조회해서 실제 호출할 컨트롤러를 controllerMap에서 찾는다. 만약 없다면 404 상태 코드를 반환하게 된다.
- 컨트롤러를 찾고 controller.process(request, response)를 호출해서 해당 컨트롤러를 실행한다.
2-6. 정리
(1) 이제 구조적으로 프론트 컨트롤러를 도입시켰다. 이제부터 하나씩 불편했던 점들을 개선하면서 어떤 점이 달라지게 되었는지 확인해 보자.
3. View 영역 분리
3-1. 현재 모든 컨트롤러에 뷰로 이동하는 부분에 중복이 존재한다.
String viewPath = "/WEB-INF/views/new-form.jsp";
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);
(1) 이 부분을 개선하기 위해 별도로 뷰를 처리하는 객체를 생성하고자 한다.
3-2. View 영역 개선 구조
(1) 클라이언트의 요청이 오게 되면 Url 매핑 정보에서 요청 정보에 맞는 컨트롤러를 조회한다.
(2) 프론트 컨트롤러에서 해당 컨트롤러를 호출한다. 컨트롤러는 MyView만 반환한다.
(3) MyView에서 화면을 렌더링하기 위한 render() 메서드를 호출함으로써 사용자에게 동적인 화면이 뿌려진다.
3-3. MyView
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);
}
}
3-4. ControllerV2
public interface ControllerV2 {
MyView process (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}
3-5. MemberFormControllerV2 - 회원 등록 컨트롤러
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");
}
}
(1) 이제 각 컨트롤러들은 복잡한 dispatcher.forward()를 직접 생성해서 호출하지 않아도 된다. 단순히 MyView 객체를 생성하고 파라미터로 해당 컨트롤러 경로만 넣어주면 된다.
(2) ControllerV1, ControllerV2를 구현한 클래스를 비교해 보면 뷰를 뿌려주는 부분에 대한 코드의 중복이 제거된 것을 확인해 볼 수 있다.
3-6. MemberSaveControllerV2 - 회원 저장 컨트롤러
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);
// Model에 데이터를 보관해야 함
request.setAttribute("member", member);
return new MyView("/WEB-INF/views/save-result.jsp");
}
}
3-7. MemberListControllerV2 - 회원 목록 컨트롤러
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");
}
}
3-8. FrontControllerServletV2 - 프론트 컨트롤러
@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 {
System.out.println("FrontControllerServletV2.service");
// front-controller/v2/members
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);
}
}
(1) ControllerV2의 반환 타입이 MyView이므로 프론트 컨트롤러는 컨트롤러의 호출 결과로 MyView를 반환받게 된다. 그리고 view.render()를 호출하면 forward() 로직을 수행해서 JSP를 통해 뷰를 뿌려주게 된다.
4. Model 영역 추가
4-1. 서블릿의 종속성 제거
(1) 현재 컨트롤러 입장에선 HttpServletRequest, HttpServletResponse가 반드시 필요한지 생각해 봐야 한다.
(2) 요청 파라미터의 정보는 자바의 Map으로 대신 넘겨주도록 하면 현재 구조에서는 컨트롤러가 서블릿 기술을 모르더라도 동작할 수 있게 된다.
(3) request 객체를 Model로 사용하는 대신에 별도의 모델 객체를 만들어서 반환하게 해 주면 된다.
(4) 구현하는 컨트롤러가 서블릿 기술을 전혀 사용하지 않도록 변경해 보고자 한다. 이렇게 구성하게 되면 코드도 매우 단순해지고 테스트도 쉬워진다.
4-2. 뷰 이름 중복 제거
(1) 컨트롤러에서 지정하는 뷰 이름에 중복이 존재하는 것을 확인할 수 있다. 컨트롤러는 뷰의 논리 이름을 반환하고 실제 물리 위치의 이름은 프론트 컨트롤러에서 처리하도록 한다.
| 물리 경로 | 논리 경로 |
| /WEB-INF/views/new-form.jsp | new-form |
| /WEB-INF/views/save-result.jsp | save-result |
| /WEB-INF/views/members.jsp | members |
(2) 이렇게 설계하면 뷰의 디렉토리 위치가 함께 이동해도 프론트 컨트롤러만 수정하면 된다.
4-3. ModelView
(1) 지금까지 컨트롤러에서 서블릿에 종속적인 HttpServletRequest를 사용했다 그리고 모델도 request.setAttribute()를 통해 데이터를 저장하고 뷰에 전달했다.
(2) 서블릿 종속성 제거를 위해 직접 모델을 만들고 추가로 뷰 이름까지 전달하는 추가적인 객체를 만들어 보자
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;
}
}
(3) 뷰의 이름과 뷰를 렌더링할 때 필요한 모델 객체를 MyView에서 가지고 있다. model은 단순히 Map으로 되어 있으므로 컨트롤러에서 뷰에 필요한 데이터를 키, 값 형태로 넣어주면 된다.
4-5. ControllerV3
public interface ControllerV3 {
ModelView process(Map<String, String> paramMap);
}
(1) 해당 컨트롤러는 서블릿 기술을 전혀 사용하지 않고 있다. 따라서 구현이 단순해지고 테스트가 용이해진다.
(2) HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 paramMap에 담아서 호출해 주면 된다. process() 메서드의 응답 결과로 뷰 이름과 뷰에 전달할 모델 데이터를 포함하는 ModelView 객체를 반환하도록 한다.
4-6. MemberFormControllerV3 - 회원 등록 컨트롤러
public class MemberFormControllerV3 implements ControllerV3 {
@Override
public ModelView process(Map<String, String> paramMap) {
return new ModelView("new-form");
}
}
(1) ModelView를 생성할 때 new-form이라는 뷰의 논리 이름을 지정한다. 실제 물리적인 이름은 프론트 컨트롤러에서 위임받아 처리하게 된다.
4-7. MemberSaveControllerV3- 회원 저장 컨트롤러
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;
}
}
(1) paramMap.get("username)
- 파라미터 정보는 Map 내부에 담겨져 있다. Map에서 필요한 요청 파라미터 정보를 조회하면 된다.
(2) mv.getModel().put("member", member)
- 모델은 단순한 Map이므로 모델에 뷰에서 필요한 member 객체를 담고 반환해 준다.
4-8. MemberListControllerV3 - 회원 목록 컨트롤러
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;
}
}
4-9. FrontControllerServletV3 - 프론트 컨트롤러
@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 {
System.out.println("FrontControllerServletV3.service");
// front-controller/v3/members
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();// 논리 이름 new-form
MyView view = viewResolver(viewName);
view.render(mv.getModel(), request, response);
}
private static MyView viewResolver(String viewName) {
return new MyView("/WEB-INF/views/" + viewName + ".jsp");
}
// HttpServletRequest에 있는 파라미터 정보를 다 뽑아서 paramMap으로 반환한다.
private static 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;
}
}
4-10. 뷰 리졸버(View Resolver)
MyView view = viewResolver(viewName);(1) 뷰 리졸버의 경우 컨트롤러가 반환한 논리 이름을 실제 물리 뷰 이름으로 변환하는 역할을 한다.
(2) 그리고 실제 물리 경로가 존재하는 MyView 객체를 반환하게 된다.
(3) 논리 이름 : members
(4) 물리 이름 : /WEB-INF/views/members.jsp
view.render(mv.getModel(), request, response);(1) 뷰 객체를 통해서 HTML을 렌더링하게 된다.
(2) 뷰 객체의 render() 메서드의 경우 모델 정보도 함께 받게 된다.
(3) JSP는 request.getAttribute() 메서드로 데이터를 조회하기 때문에 모델의 데이터를 꺼내서 request.setAttribute() 메서드로 함께 담아둔다.
(4) JSP로 포워드해서 JSP를 렌더링하게 된다.
(5) 이렇게 뷰 리졸버를 따로 나누는 이유가 궁금할 수도 있다. 만약 뷰 파일이 담긴 물리 경로가 변경된다고 가정해 보자. 컨트롤러의 코드를 수정할 필요가 없고 뷰 리졸버 내부의 viewResolver 메서드 내부의 코드만 변경하면 된다. 따라서 물리적 이름과 논리적 이름을 나누어 놓으면 추후 변경사항 발생 시, 변경으로 인한 부수효과가 감소하게 된다.
5. 단순하고 실용적인 컨트롤러
5-1. 개요
(1) 앞서 설계된 컨트롤러는 서블릿 종속성 제거, 뷰 경로 중복 제거 등 어느 정도 잘 설계된 컨트롤러이다.
(2) 항상 ModelView 객체를 생성하고 반환해야 하는 부분이 조금은 번거로울 수 있다. 이 부분을 개선하여 컨트롤러에서 ModelView를 반환하지 않고 viewName만 반환하도록 보다 유연한 컨트롤러를 설계해 보자. 구현하고자 하는 아키텍처는 아래와 같다.
5-2. ControllerV4
public interface ControllerV4 {
/**
*
* @param paramMap
* @param model
* @return viewName
*/
String process(Map<String, String> paramMap, Map<String, Object> model);
}
(1) 이번엔 인터페이스에 ModelView가 없다. model 객체는 파라미터로 전달되기 때문에 바로 사용하면 되고 결과로 뷰의 이름만 반환해 주면 된다.
5-3. MemberFormControllerV4 - 회원 등록 컨트롤러
public class MemberFormControllerV4 implements ControllerV4 {
@Override
public String process(Map<String, String> paramMap, Map<String, Object> model) {
return "new-form";
}
}
(1) 위에서 언급된 것처럼 정말 단순하게 뷰 영역의 논리 이름만 반환하고 있다.
5-4. MemberSaveController - 회원 저장 컨트롤러
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에 데이터를 넣어주고 논리 뷰 이름을 반환한다.
model.put("member", member);
return "save-result";
}
}
(1) model.put("member", member);
- 모델이 파라미터로 전달되기 때문에 모델을 직접적으로 생성하지 않아도 된다.
5-5. MemberListController - 회원 목록 컨트롤러
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";
}
}
5-6. FrontControllerServletV4 - 프론트 컨트롤러
@WebServlet(name = "frontControllerServletV4", urlPatterns = "/front-controller/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 {
System.out.println("FrontControllerServletV1.service");
// front-controller/v4/members
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 static MyView viewResolver(String viewName) {
return new MyView("/WEB-INF/views/" + viewName + ".jsp");
}
private static 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;
}
}
(1) 이전 V3 버전과 상당히 유사한 프론트 컨트롤러가 완성되었다.
(2) 모델 객체 전달
Map<String, Object> model = new HashMap<>();
- 모델 객체를 프론트 컨트롤러에서 생성해서 직접 넘겨준다.
(3) 뷰의 논리적 이름을 직접적으로 반환한다.
String viewName = controller.process(paramMap, model);
MyView view = viewResolver(viewName);- 컨트롤러가 직접 뷰의 논리 이름을 반환하므로 이 값을 사용해서 실제 물리 뷰의 이름을 찾을 수 있게 된다.
5-7. 정리(개선된 점)
(1) 기존 구조에서 모델을 파라미터로 넘기고 뷰의 논리적 이름을 반환한다는 아이디어를 적용함으로써 컨트롤러를 구현하는 개발자 입장에서 더 간결한 코드를 작성할 수 있게 되었다.
6. 유연한 컨트롤러
6-1. 개요 - 어댑터 패턴
(1) 지금까지 개발된 프론트 컨트롤러는 한 가지 방식의 컨트롤러 인터페이스만 사용 가능하다.
(2) 어댑터 패턴을 적용해서 프론트 컨트롤러가 다양한 방식의 컨트롤러를 처리할 수 있도록 설계할 수 있다.
(3) 동작 패턴
- 클라이언트에서 HTTP 요청이 프론트 컨트롤러로 도착한다.
- 프론트 컨트롤러가 핸들러 매핑 정보(컨트롤러 매핑 정보)에서 핸들러를 조회한다.
- 이후 핸들러 어댑터 목록을 탐색하여 찾은 핸들러를 처리할 수 있는 핸들러 어댑터를 조회한다.
- 핸들러 어댑터를 찾아오고, handle()를 호출한다. 이후 실제 컨트롤러가 호출된다.
- 이후 ModelView를 반환한다
- viewResolver 호출 후 MyView를 반환한다.
- 최종적으로 렌더링하는 render()를 호출한다.
(4) 핸들러 어댑터
- 중간에 어댑터 역할을 하는 어댑터가 추가되었는데 해당 어댑터 이름이 바로 핸들러 어댑터다. 여기서 어댑터 역할을 수행하는 덕분에 다양한 종류의 컨트롤러를 호출할 수 있게 해 준다.
(5) 핸들러
- 컨트롤러의 이름을 더 넓은 범위인 핸들러로 표현했다. 이유는 이제 어댑터가 존재하기 때문에 컨트롤러의 개념뿐만이 아니라 어떠한 것이든 특정 종류의 어댑터만 있으면 모두 처리가 가능하기 때문이다.
6-2. MyHandlerAdapter
public interface MyHandlerAdapter {
boolean supports(Object handler);
ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException;
}
boolean supports(Object handler);(1) 핸들러는 컨트롤러를 말한다.
(2) 어댑터가 해당 컨트롤러를 처리할 수 있는지 판단하는 메서드다.
ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException;(3) 어댑터는 실제 컨트롤러를 호출하고 그 결과로 ModelView를 반환해 줘야 한다.
(4) 실제 컨트롤러가 ModelView를 반환하지 못하면 어댑터가 ModelView를 직접 생성해서라도 반환해야 한다.
(5) 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 해당 어댑터를 통해서 실제 컨트롤러가 호출된다.
6-3. ControllerV3HandlerAdapter
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) throws ServletException, IOException {
ControllerV3 controller = (ControllerV3) handler;
Map<String, String> paramMap = new HashMap<>();
ModelView mv = controller.process(paramMap);
return mv;
}
private static 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;
}
}
@Override
public boolean supports(Object handler) {
return (handler instanceof ControllerV3);
}(1) ControllerV3을 처리할 수 있는 어댑터인지 판별하는 메서드이다.
@Override
public ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException {
ControllerV3 controller = (ControllerV3) handler;
Map<String, String> paramMap = new HashMap<>();
ModelView mv = controller.process(paramMap);
return mv;
}(2) handler를 ControllerV3로 변환한 다음에 V3 형식에 맞도록 호출한다.
(3) 이후 ControllerV3는 ModelView를 반환하게 된다.
6-4. FrontControllerServletV5
@WebServlet(name = "frontControllerServletV5", urlPatterns = "/front-controller/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() {
// v3 추가
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());
handlerAdapters.add(new ControllerV4HandlerAdapter());
}
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// 핸들러를 찾아온다. (MemberFormControllerV3)
Object handler = getHandler(request);
if (handler == null) {
response.setStatus(HttpServletResponse.SC_NOT_FOUND);
return;
}
// 핸들러 어댑터를 찾아온다. (ControllerV3HandlerAdapter)
MyHandlerAdapter adapter = getHandlerAdapter(handler);
// 실제 컨트롤러를 호출한다
ModelView mv = adapter.handle(request, response, handler);
String viewName = mv.getViewName();// 논리 이름 new-form
MyView view = viewResolver(viewName);
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");
}
}
(1) 컨트롤러 → 핸들러
- 이전에는 컨트롤러를 직접 매핑해서 사용했지만, 이제는 어댑터를 사용해서 컨트롤러뿐만 아니라 어댑터가 지원하기만 하면 어떤 것이라도 URL에 매핑해서 사용할 수 있다. 이러한 이유 때문에 컨트롤러를 더 넓은 범위의 이름인 핸들러로 변경했다.
public FrontControllerServletV5() {
initHandlerMappingMap();
initHandlerAdapters();
}(2) 생성자
- 생성자는 핸들러 매핑과 어댑터를 초기화(등록)한다.
private final Map<String, Object> handlerMappingMap = new HashMap<>();(3) 매핑 정보
- 매핑 정보의 값이 어떠한 컨트롤러의 인터페이스에서 아무 값이나 받을 수 있는 Object로 변경되었다.
private Object getHandler(HttpServletRequest request) {
String requestURI = request.getRequestURI();
return handlerMappingMap.get(requestURI);
}(4) 핸들러 매핑
- 핸들러 매핑 정보인 handlerMappingMap에서 URL에 매핑된 핸들러(컨트롤러) 객체를 찾아서 반환한다.
private MyHandlerAdapter getHandlerAdapter(Object handler) {
for (MyHandlerAdapter adapter : handlerAdapters) {
if (adapter.supports(handler)) {
return adapter;
}
}
throw new IllegalArgumentException("handler adapter를 찾을 수 없습니다. handler = " + handler);
}(5) 핸들러를 처리할 수 있는 어댑터 조회
- handler를 처리할 수 있는 어댑터를 adapter.supports(handler)를 통해 탐색한다.
- handler가 ControllerV3 인터페이스를 구현했다면 ControllerV3HandlerAdapter 객체가 반환되고 찾지 못한다면 IllegalArgumentException 예외가 발생한다.
// 실제 컨트롤러를 호출한다
ModelView mv = adapter.handle(request, response, handler);(6) 어댑터 호출
- handle() 메서드를 통해 실제 어댑터가 호출된다. 어댑터는 컨트롤러를 호출하고 그 결과를 어댑터에 맞추어 반환하게 된다.
7. Reference
※ 해당 포스팅은 InFlearn에서 (전) 우아한형제들, 배달의 민족 서비스 개발팀장(기술이사)으로 재직하셨던 김영한님의 "스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술" 강의를 듣고 공부한 내용을 정리하였습니다.
https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의
웹 애플리케이션을 개발할 때 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. 스프링 MVC의 핵심 원리와 구조를 이해하고, 더 깊이있는 백엔드 개발자로 성장할 수 있습니다., 원
www.inflearn.com
※ 해당 포스팅에 대해 내용 추가가 필요하다고 생각되면 기존 포스팅 내용에 다른 내용이 추가될 수 있습니다.
개인적으로 공부하며 정리한 내용이기에 오타나 틀린 부분이 있을 수 있으며, 이에 대해 댓글로 알려주시면 감사하겠습니다!
'백엔드(Back-End) > Spring MVC' 카테고리의 다른 글
| 웹 서버(Web Server), 웹 애플리케이션 서버(Web Application Server), 자바 서블릿(Java Servlet) 정리 (0) | 2023.11.02 |
|---|
댓글