📖 ✏️
이 글은 스프링 MVC의 전체 구조를 이해하기 위해 핵심적인 기능인 핸들러, 핸들러 어댑터, 뷰 리졸버의 동작 원리를 학습하고 다양하게 적용해본 과정을 정리한 포스팅이다.
스프링 MVC는 코드 분량이 많고 복잡하다. 내부 구조를 다 파악하기는 쉽지 않다. 하지만 발전을 거듭해 온 스프링 MVC에 필요한 기능이 없어서 직접 컨트롤러를 개발할 일도 없을 것이다. 스프링 MVC는 전 세계 수많은 개발자의 요구사항에 맞추어 기능을 계속 확장해 왔다. 웹 애플리케이션을 만들 때 필요로 하는 대부분의 기능이 이미 다 구현되어 있다.
스프링 MVC는 핵심 동작 방식을 이해하고 있으면 좋다. 그래야만 문제가 발생했을 때, 원인을 빠르게 파악할 수 있다. 또한, 확장이 필요할 때 어디를 손봐야 할지 감을 잡을 수 있다.
스프링 MVC의 전체 구조를 살펴보며, 핵심적인 기능인 핸들러, 핸들러 어댑터, 뷰 리졸버의 동작 원리를 파악해 볼 것이다. 그리고 마지막으로 애노테이션 방식으로 앞서 언급한 스프링 MVC의 핵심 기능을 사용해보자.
Spring MVC 구조
org.springframework.web.servlet.DispatcherServlet
스프링 MVC는 프론트 컨트롤러 패턴으로 구현되어 있다. 디스패처 서블릿(DispatcherServlet)이 스프링 MVC의 프론트 컨트롤러 역할을 한다. 디스패처 서블릿(DispatcherServlet)이 스프링 MVC의 핵심이다.
DispacherServlet
은 부모 클래스에서 HttpServlet
을 상속 받는다. 그러므로, 동일하게 서블릿으로 동작한다.
아래 상속 구조를 참고하자.
DispatcherServlet
-> FrameworkServlet
-> HttpServletBean
-> HttpServlet
스프링 부트는 DispacherServlet
을 서블릿으로 자동 등록하면서 모든 경로(urlPatterns="/")에 대해서 매핑한다. 단, 세부 경로가 명시되어 있으면 우선순위가 더 높게 부여된다. 따라서, 기존에 등록된 서블릿도 함께 동작한다.
DispacherServlet
이 호출되면 HttpServlet
이 제공하는 serivce()
가 호출된다. 스프링 MVC는 DispatcherServlet
의 부모인 FrameworkServlet
에서 service()
를 오버라이드한다.
FrameworkServlet.service()
를 시작으로 여러 메서드가 호출되면서 DispacherServlet.doDispatch()
가 호출된다.
지금부터 DispacherServlet
의 핵심인 doDispatch()
코드를 분석해보자. 최대한 간단히 설명하기 위해 예외처리, 인터셉터 기능은 제외했다.
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
ModelAndView mv = null;
// 1. 핸들러 조회
mappedHandler = getHandler(processedRequest);
if (mappedHandler == null) {
noHandlerFound(processedRequest, response);
return;
}
//2.핸들러 어댑터 조회-핸들러를 처리할 수 있는 어댑터
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// 3. 핸들러 어댑터 실행 -> 4. 핸들러 어댑터를 통해 핸들러 실행 -> 5. ModelAndView 반환
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response, HandlerExecutionChain mappedHandler, ModelAndView
mv, Exception exception) throws Exception {
// 뷰 렌더링 호출
render(mv, request, response);
}
protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) throws Exception {
View view;
String viewName = mv.getViewName();
//6. 뷰 리졸버를 통해서 뷰 찾기, 7.View 반환
view = resolveViewName(viewName, mv.getModelInternal(), locale, request);
// 8. 뷰 렌더링
view.render(mv.getModelInternal(), request, response);
}
ModelAndView
로 변환해서 반환한다. InternalResourceViewResolver
가 자동 등록되고, 사용된다. InternalResourceView(JstlView)
를 반환한다. 내부에 forward()
로직이 있다. 스프링 MVC의 큰 강점은 DispatcherServlet
코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다. 핵심 기능의 대부분을 인터페이스로 제공하여, 쉽게 확장 할 수 있다.
이 인터페이스들만 구현해서 DispatcherServlet
에 등록하면 여러분만의 컨트롤러를 만들 수도 있다.
주요 인터페이스 목록
org.springframework.web.servlet.HandlerMapping
org.springframework.web.servlet.HandlerAdapter
org.springframework.web.servlet.ViewResolver
org.springframework.web.servlet.View
스프링 MVC가 지원하는 핸들러 매핑과 핸들러 어댑터는 어떤 것들이 있는지, 어떻게 사용해야 하는지 살펴보자.
지금은 전혀 사용하지 않지만, 과거에 주로 사용했던 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해보자.
과거 버전 스프링 컨트롤러
org.springframework.web.servlet.mvc.Controller
public interface Controller {
ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}
스프링도 처음에는 이런 딱딱한 형식의 컨트롤러를 제공했다.
참고
Controller 인터페이스는 @Controller 애노테이션과는 전혀 다르다.
package hello.servlet.web.springmvc.old;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component("/springmvc/old-controller")
public class OldController implements Controller {
@Override
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
System.out.println("OldController.handleRequest");
return null;
}
}
@Component
: 이 컨트롤러는 /springmvc/old-controller
라는 이름의 스프링 빈으로 등록되었다. 빈의 이름으로 URL을 매핑할 것이다.
실행
OldController.handleRequest
이 출력된다.이 컨트롤러는 어떻게 호출될 수 있을까?
이 컨트롤러가 호출되려면 다음 2가지가 필요하다.
스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분을 지원한다. 개발자가 직접 핸들러 매핑과 핸들러 어댑터를 만드는 일은 거의 없다.
(실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략)
HandlerMapping 작업 우선순위
0 = RequestMappingHandlerMapping : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = BeanNameUrlHandlerMapping : 스프링 빈의 이름으로 핸들러를 찾는다.
HandlerAdapter 작업 우선순위
0 = RequestMappingHandlerAdapter : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = HttpRequestHandlerAdapter : HttpRequestHandler 처리
2 = SimpleControllerHandlerAdapter : Controller 인터페이스(애노테이션X, 과거에 사용) 처리
핸들러 매핑과 핸들러 어댑터 모두 순서대로 해당하는 것이 있는지 찾는다. 없다면 다음 순서로 넘어간다.
HandlerMapping
을 순서대로 실행해서, 핸들러를 찾는다. BeanNameUrlHandlerMapping
이 실행에 성공하고 핸들러인 OldController
를 반환한다. HandlerAdapter
의 supports()
를 순서대로 호출한다. SimpleControllerHandlerAdapter
가 Controller
인터페이스를 지원하므로 대상이 된다. SimpleControllerHandlerAdapter
를 실행하면서 핸들러 정보도 함께 넘겨준다.SimpleControllerHandlerAdapter
는 핸들러인 OldController
를 내부에서 실행하고, 그 결과를 반환한다.결론
OldController
를 실행하면서 사용된 객체는 다음과 같다.HandlerMapping = BeanNameUrlHandlerMapping HandlerAdapter = SimpleControllerHandlerAdapter
만약 Controller 인터페이스가 아닌 다른 핸들러라면 어떻게 찾을까? 핸들러 매핑과, 어댑터를 더 잘 이해하기 위해 다른 핸들러인 HttpRequestHandler(컨트롤러)
를 대상으로 다시 한 번 과정을 살펴보자. 참고로 HttpRequestHandler(컨트롤러)
는 서블릿과 가장 유사한 형태의 핸들러이다.
HttpRequestHandler 인터페이스
public interface HttpRequestHandler {
void handleRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException;
}
간단하게 구현해보자.
MyHttpRequestHandler
package hello.servlet.web.springmvc.old;
import org.springframework.stereotype.Component;
import org.springframework.web.HttpRequestHandler;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Component("/springmvc/request-handler")
public class MyHttpRequestHandler implements HttpRequestHandler {
@Override
public void handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
System.out.println("MyHttpRequestHandler.handleRequest");
}
}
실행
MyHttpRequestHandler.handleRequest
가 출력된다.HandlerMapping
을 순서대로 실행해서, 핸들러를 찾는다.BeanNameUrlHandlerMapping
가 실행에 성공하고 핸들러인 MyHttpRequestHandler
를 반환한다. HandlerAdapter
의 supports()
를 순서대로 호출한다. HttpRequestHandlerAdapter
가 HttpRequestHandler
인터페이스를 지원하므로 대상이 된다. 핸들러 어댑터 실행
HttpRequestHandlerAdapter
를 실행하면서 핸들러 정보도 함께 넘겨준다. HttpRequestHandlerAdapter
는 핸들러인 MyHttpRequestHandler
를 내부에서 실행하고, 그 결과를 반환한다. 결론
HttpRequestHandler
를 실행하면서 사용된 객체는 다음과 같다.HandlerMapping = BeanNameUrlHandlerMapping HandlerAdapter = HttpRequestHandlerAdapter
가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping
, RequestMappingHandlerAdapter
이다.
@RequestMapping
의 앞글자를 따서 만든 이름이다. 최근 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다. 실무에서는 99.9% 이 방식의 컨트롤러를 사용한다고 한다.
뷰 리졸버에 대해서 자세히 알아보기 위해 OldController
를 View 조회가 가능하도록 변경해보자.
View를 사용할 수 있도록 다음 코드를 추가했다. new-form은 JSP 파일이다.
return new ModelAndView("new-form");
package hello.servlet.web.springmvc.old;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component("/springmvc/old-controller")
public class OldController implements Controller {
@Override
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
System.out.println("OldController.handleRequest");
return new ModelAndView("new-form");
}
}
실행
Whitelabel Error Page
가 나오고, 콘솔에 OldController.handleRequest
이 출력된다.실행해보면 컨트롤러를 정상 호출되지만, Whitelabel Error Page
오류가 발생한다.
application.properties
에 다음 코드를 추가해야 한다.
spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp
스프링 부트는 InternalResourceViewResolver
라는 뷰 리졸버를 자동으로 등록한다. 이때, application.properties
에 등록한 spring.mvc.view.prefix
, spring.mvc.view.suffix
설정 정보를 사용하여 등록한다.
참고로 설정 없이 다음과 같이 전체 경로를 주어도 동작한다. 다만, 권장하지 않는 방식이다.
return new ModelAndView("/WEB-INF/views/new-form.jsp");
실행
스프링 MVC 구조
(실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략)
1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다. (예: 엑셀 파일 생성 기능에 사용)
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.
핸들러 어댑터 호출
new-form
이라는 논리 뷰 이름을 획득한다. ViewResolver 호출
new-form
이라는 뷰 이름으로 viewResolver
를 순서대로 호출한다.BeanNameViewResolver
는 new-form
이라는 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없다. InternalResourceViewResolver
가 호출된다. InternalResourceView
를 반환한다. 뷰 - InternalResourceView
InternalResourceView
는 JSP처럼 포워드 forward()
를 호출해서 처리할 수 있는 경우에 사용한다. view.render()
가 호출되고, InternalResourceView
는 forward()
를 사용해서 JSP를 실행한다. 참고
InternalResourceViewResolver
는 만약 JSTL 라이브러리가 있으면InternalResourceView
를 상속받은JstlView
를 반환한다.JstlView
는 JSTL 태그 사용시 약간의 부가 기능이 추가된다.
참고
다른 뷰는 실제 뷰를 렌더링하지만, JSP의 경우forward()
통해서 해당 JSP로 이동(실행)해야 렌더링이 된다. JSP를 제외한 나머지 뷰 템플릿들은forward()
과정 없이 바로 렌더링 된다.
참고
Thymeleaf 뷰 템플릿을 사용하면ThymeleafViewResolver
를 등록해야 한다. 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.
스프링이 제공하는 컨트롤러는 애노테이션 기반으로 동작한다. 매우 유연하고 실용적이다. 하지만 스프링이 처음부터 이런 유연한 컨트롤러를 제공한 것은 아니다.
스프링은 애노테이션을 활용한 매우 유연하고, 실용적인 컨트롤러를 만들었는데 이것이 바로 @RequestMapping
애노테이션을 사용하는 컨트롤러이다.
@RequestMapping을 사용하는 핸들러와 어댑터
앞서 보았듯이 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping
, RequestMappingHandlerAdapter
이다.
@RequestMapping
의 앞글자를 따서 만든 이름인데, 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 핸들러 매핑과 어댑터다.
지금까지 만들었던 프레임워크에서 사용했던 컨트롤러를 @RequestMapping
기반의 스프링 MVC 컨트롤러로 변경해보자.
package hello.servlet.web.springmvc.v1;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
public class SpringMemberFormControllerV1 {
@RequestMapping("/springmvc/v1/members/new-form")
public ModelAndView process() {
return new ModelAndView("new-form");
}
}
@Controller
@Component
애노테이션이 있어서 컴포넌트 스캔의 대상이 된다.) @RequestMapping
ModelAndView
RequestMappingHandlerMapping
은 스프링 빈 중에서 @RequestMapping
또는 @Controller
가 클래스 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.
따라서 다음 코드도 동일하게 동작한다.
@Component //컴포넌트 스캔을 통해 스프링 빈으로 등록
@RequestMapping
public class SpringMemberFormControllerV1 {
@RequestMapping("/springmvc/v1/members/new-form")
public ModelAndView process() {
return new ModelAndView("new-form");
}
}
물론 컴포넌스 스캔 없이 다음과 같이 스프링 빈으로 직접 등록해도 동작한다.
@RequestMapping
public class SpringMemberFormControllerV1 {
@RequestMapping("/springmvc/v1/members/new-form")
public ModelAndView process() {
return new ModelAndView("new-form");
}
}
ServletApplication
//스프링 빈 직접 등록
@Bean
TestController testController() {
return new TestController();
}
실행
package hello.servlet.web.springmvc.v1;
import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Controller
public class SpringMemberSaveControllerV1 {
private MemberRepository memberRepository = MemberRepository.getInstance();
@RequestMapping("/springmvc/v1/members/save")
public ModelAndView process(HttpServletRequest request, HttpServletResponse response) {
String username = request.getParameter("username");
int age = Integer.parseInt(request.getParameter("age"));
Member member = new Member(username, age);
memberRepository.save(member);
ModelAndView mv = new ModelAndView("save-result");
mv.addObject("member", member);
return mv;
}
}
mv.addObject("member", member)
ModelAndView
를 통해 Model 데이터를 추가할 때는 addObject()
를 사용하면 된다. 이 데이터는 이후 뷰를 렌더링 할 때 사용된다. package hello.servlet.web.springmvc.v1;
import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import java.util.List;
@Controller
public class SpringMemberListControllerV1 {
private MemberRepository memberRepository = MemberRepository.getInstance();
@RequestMapping("/springmvc/v1/members")
public ModelAndView process() {
List<Member> members = memberRepository.findAll();
ModelAndView mv = new ModelAndView("members");
mv.addObject("members", members);
return mv;
}
}
실행
@RequestMapping
을 잘 보면 클래스 단위가 아니라 메서드 단위에 적용된 것을 확인할 수 있다. 따라서 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.
package hello.servlet.web.springmvc.v2;
import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;
/**
* 클래스 단위 -> 메서드 단위
* @RequestMapping 클래스 레벨과 메서드 레벨 조합
*/
@Controller
@RequestMapping("/springmvc/v2/members")
public class SpringMemberControllerV2 {
private MemberRepository memberRepository = MemberRepository.getInstance();
@RequestMapping("/new-form")
private ModelAndView newForm() {
return new ModelAndView("new-form");
}
@RequestMapping
public ModelAndView members() {
List<Member> members = memberRepository.findAll();
ModelAndView mv = new ModelAndView("members");
mv.addObject("members", members);
return mv;
}
@RequestMapping("/save")
public ModelAndView save(HttpServletRequest request, HttpServletResponse response) {
String username = request.getParameter("username");
int age = Integer.parseInt(request.getParameter("age"));
Member member = new Member(username, age);
memberRepository.save(member);
ModelAndView mv = new ModelAndView("save-result");
mv.addObject("member", member);
return mv;
}
}
컨트롤러 클래스를 통합하는 것을 넘어서 조합도 가능하다. 다음 코드는 /springmvc/v2/members
라는 중복 경로가 존재한다.
@RequestMapping("/springmvc/v2/members/new-form")
@RequestMapping("/springmvc/v2/members")
@RequestMapping("/springmvc/v2/members/save")
물론 이렇게 사용해도 되지만, 컨트롤러를 통합한 예제 코드를 보면 중복을 어떻게 제거했는지 확인할 수 있다. 클래스 레벨에 다음과 같이 @RequestMapping
을 두면 메서드 레벨과 조합이 된다.
조합 결과
@RequestMapping("/springmvc/v2/members")
@RequestMapping("/new-form")
-> /springmvc/v2/members/new-form
@RequestMapping("/save")
-> /springmvc/v2/members/save
@RequestMapping
-> /springmvc/v2/members
이전 포스팅인 MVC 프레임워크 만들기에서 v3은 ModelView
를 개발자가 직접 생성해서 반환했기 때문에, 불편했던 기억이 날 것이다. 반면, v4를 만들면서 실용적으로 개선한 기억도 있을 것이다.
스프링 MVC는 개발자가 편리하게 개발할 수 있도록 수 많은 편의 기능을 제공한다. 실무에서는 지금부터 설명하는 방식을 주로 사용한다고 한다.
package hello.servlet.web.springmvc.v3;
import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* v3
* Model 도입
* ViewName 직접 반환
*
* @RequestParam 사용
* @RequestMapping -> @GetMapping, @PostMapping
*/
@Controller
@RequestMapping("/springmvc/v3/members")
public class SpringMemberControllerV3 {
private MemberRepository memberRepository = MemberRepository.getInstance();
@GetMapping("/new-form")
private String newForm() {
return "new-form";
}
@PostMapping("/save")
public String save(@RequestParam("username") String username,
@RequestParam("age") int age,
Model model) {
Member member = new Member(username, age);
memberRepository.save(member);
model.addAttribute("member", member);
return "save-result";
}
@PostMapping()
public String members(Model model) {
List<Member> members = memberRepository.findAll();
model.addAttribute("members", members);
return "members";
}
}
Model 파라미터
ViewName 직접 반환
@RequestParam 사용
@RequestParam
으로 받을 수 있다. @RequestParam("username")
은 request.getParameter("username")
와 거의 같은 코드라 생각하면 된다. 물론, GET 쿼리 파라미터, POST Form 방식을 모두 지원한다. @RequestMapping -> @GetMapping, @PostMapping
@RequestMapping
은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다. 예를 들어서 URL이 /new-form
이고, HTTP Method가 GET인 경우를 모두 만족하는 매핑을 하려면 아래와 같이 처리한다.@RequestMapping(value = "/new-form", method = RequestMethod.GET)
이것을 @GetMapping
, @PostMapping
으로 더 편리하게 사용할 수 있다. 참고로 Get, Post, Put, Delete, Patch 모두 애노테이션이 준비되어 있다.
@GetMapping
코드를 열어서 @RequestMapping
애노테이션을 내부의 모습을 확인해보면 도움이 될 것이다.
실행