1. 스프링 MVC 전체 구조
저번 섹션에서 직접 만든 MVC 프레임워크와 스프링 MVC 구조를 비교해보자.
- 전체적으로 보면 구조가 매우 비슷하다. 객체들 이름만 바꾸고, 기능을 확장하면 거의 똑같이 볼 수 있다.
- FrontController → DispatcherServlet
- handlerMappingMap → HandlerMapping
- MyHandlerAdapter → HandlerAdapter
- ModelView → ModelAndView
- viewResolver 메서드 → ViewResolver Interface
- MyView class→ View Interface
DispatcherServlet 구조 살펴보기
스프링 MVC도 프론트 컨트롤러 패턴으로 구현돼 있다. 그 프론트 컨트롤러가 바로 DispatcherServlet이고, 스프링 MVC의 핵심이라고 볼 수 있다.
- 코드를 열어보면 엄청 길기 때문에 핵심 코드를 위주로 살펴봐야 한다.
org.springframework.web.servlet.DispatcherServlet
a. DispatcherServlet 서블릿 등록
DispatcherServlet도 부모 class에서 HttpServlet을 상속 받아 사용하고, 서블릿으로 동작한다.
스프링 부트는 DispatcherServlet을 서블릿으로 자동 등록하면서 모든 경로(urlPatterns = "/")에 대해 매핑한다.
- @WebServlet 같은 애노테이션이 없기 때문에 스프링 부트에서 자바 코드로 DispatcherServlet을 등록하고 내장 톰켓을 띄운다.
- 더 자세한 경로가 우선순위가 높기 때문에 기존에 등록한 서블릿(/front-controller/*)도 함께 동작한다.
b. 요청 흐름
서블릿이 호출되면 HttpServlet이 제공하는 service()가 호출된다.
- 스프링 MVC는 DispatcherServlet의 부모인 FrameworkServlet에서 service()를 오버라이드 해뒀다.
- FrameworkServlet.service()를 시작으로, 여러 메서드가 호출되면서 DispatcherServlet.doDispatch()가 호출된다.
DispatcherServlet의 핵심인 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.handler(processedRequest, response, mappedHandler.getHandler());
processedDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
HandlerExecutionChain mappedHandler, ModelAndView mv, Exception exception) throw 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);
}
스프링 MVC 동작 순서
- 핸들러 조회: 핸들러 매핑을 통해 요청 URL에 매핑된 핸들러(Controller)를 조회한다.
- 스프링에선 URL뿐만 아니라 다른 정보(ex. Http Header 정보)도 활용한다.
- 핸들러 어댑터 조회: 1에서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터를 조회한다.
- 핸들러 어댑터 실행: 2에서 찾은 핸들러 어댑터를 실행한다.
- 핸들러 실행: 핸들러 어댑터가 실제 핸들러를 실행한다.
- ModelAndView 반환: 핸들러 어댑터는 핸들러가 반환하는 정보를 ModelAndView로 변환해서 반환한다.
- viewResolver 호출: 뷰 리졸버를 찾고 실행한다.
- JSP의 경우: InternalResourceViewResolver가 자동 등록되고, 사용된다.
- View 반환: 뷰 리졸버는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체를 반환한다.
- JSP의 경우: InternalResourceView(JstlView)를 반환하는데, 내부에 forward() 로직이 있다.
- 뷰 렌더링: 뷰를 통해서 뷰를 렌더링 한다.
- Thymeleaf의 경우: 자바 코드에서 바로 렌더링해 HttpResponse 객체에 담아 보내버린다.
Interface 살펴보기
스프링 MVC의 큰 강점은 DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다. 지금까지 설명한 대부분을 확장 가능할 수 있게 Interface로 제공한다.
- 이 Interface들만 구현해서 DispatcherServlet에 등록하면 나만의 Controller를 만들 수도 있다.
주요 Interface 목록은 아래와 같다. 우리가 Map이나 메서드로 구현했던 것들이 이미 Interface로 다 구현돼 있다.
- 핸들러 매핑: org.springframework.web.servlet.HandlerMapping
- 핸들러 어댑터: org.springframework.web.servlet.HandlerAdapter
- 뷰 리졸버: org.springframework.web.servlet.ViewResolver
- 뷰: org.springframework.web.servlet.View
정리
스프링 MVC는 코드 분량도 매우 많고, 복잡해서 내부 구조를 다 파악하기가 어렵다. 웹 애플리케이션을 만들 때 필요로 하는 대부분의 기능이 이미 다 구현돼 있기 때문에 나만의 Controller를 만들 일은 거의 없긴 하다.
핵심 동작 방식을 알아두면 나중에 문제가 발생했을 때 어떤 부분에서 문제가 발생했는지 쉽게 파악하고 해결할 수 있다. 또, 확장이 필요할 때 어떤 부분에서 확장해야 할지 감을 잡을 수 있다.
(이건 알고리즘 문제를 풀 때도 적용할 수 있을 것 같다.)
2. 핸들러 매핑과 핸들러 어댑터
핸들러 매핑과 핸들러 어댑터가 어떻게 사용되는지 알아보자.
과거 버전 Controller Interface
지금은 전혀 쓰지 않지만, 과거에 주로 사용했던 스프링이 제공하는 간단한 Controller로 핸들러 매핑과 어댑터를 이해해보자. 참고로 아래 Interface는 @Controller 애노테이션과 완전 다르다.
org.springframework.web.servlet.mvc.Controller
public interface Controller {
// 직접 만든 MVC 프레임워크 v3와 비슷함
ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response)
throws Exception;
}
직접 구현하면서 이해해보자.
- @Component: 이 Controller는 /springmvc/old-controller라는 이름의 스프링 빈으로 등록됐다.
- 빈의 이름으로 URL을 매핑할 것이다.
@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;
}
}
이 Controller가 호출되려면 다음 2가지가 필요하다.
- HandlerMapping(핸들러 매핑)
- 핸들러 매핑에서 이 Controller를 찾을 수 있어야 한다.
- ex. 스프링 빈의 이름으로 핸들러를 찾을 수 있는 특수한 핸들러 매핑이 필요하다.
- HandlerAdapter(핸들러 어댑터)
- 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
- ex. Controller Interface를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.
참고
스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분 구현해뒀다. 개발자가 직접 핸들러 매핑과 핸들러 어댑터를 만드는 일은 거의 없다.
스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터 (중요한 부분만 설명)
- HandlerMapping
...
0 = RequestMappingHandlerMapping : 애노테이션 기반의 Controller인 @RequestMapping에서 사용
1 = BeanNameUrlHandlerMapping : 스프링 빈의 이름(=URL)으로 핸들러를 찾음
...
- HandlerAdapter
...
0 = RequestMappingHandlerAdapter : 애노테이션 기반의 Controller인 @RequestMapping에서 사용
1 = HttpRequestHandlerAdapter : HttpRequestHandler 처리 (아래에서 더 알아볼 예정)
2 = SimpleControllerHandlerAdapter : Controller Interface(애노테이션X, 과거에 사용) 처리
...
핸들러 매핑도, 핸들러 어댑터도 모두 순서대로 찾았는데 없다면 다음 순서로 넘어간다.
- 핸들러 매핑으로 핸들러 조회
- HandlerMapping을 순서대로(0, 1) 실행해서, 핸들러를 찾는다. → 1
- 이 경우, 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping이 실행에 성공하고, 핸들러인 OldController를 반환한다.
- 핸들러 어댑터 조회
- HandlerAdapter의 supports()를 순서대로(0, 1, 2) 호출한다. → 2
- SimpleControllerHandlerAdapter가 Controller Interface를 실행하면서 핸들러 정보도 함께 넘겨준다.
- 핸들러 어댑터 실행
- DispatcherServlet이 조회한 SimpleControllerHandlerAdapter를 실행하면서 핸들러 정보도 함께 넘겨준다.
- SimpleControllerHandlerAdapter는 핸들러인 OldController를 내부에서 실행하고, 그 결과를 반환한다.
정리 - OldController 핸들러 매핑, 어댑터
OldController를 실행하면서 사용된 객체는 다음과 같다.
HandlerMapping = BeanNameUrlHandlerMapping
HandlerAdapter = SimpleControllerHandlerAdapter
HttpRequestHandler
핸들러 매핑과 어댑터를 더 잘 이해하기 위해 Controller Interface가 아닌 다른 핸들러를 알아보자. HttpRequestHandler 핸들러(Controller)는 서블릿과 가장 유사한 형태의 핸들러다.
public interface HttpRequestHandler {
void handlerRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, 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");
}
}
핸들러 매핑도, 핸들러 어댑터도 모두 순서대로 찾았는데 없다면 다음 순서로 넘어간다.
- 핸들러 매핑으로 핸들러 조회
- HandlerMapping을 순서대로(0, 1) 실행해서, 핸들러를 찾는다. → 1
- 이 경우, 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping이 실행에 성공하고, 핸들러인 MyHttpRequestHandler를 반환한다.
- 핸들러 어댑터 조회
- HandlerAdapter의 supports()를 순서대로(0, 1, 2) 호출한다. → 1
- HttpRequestHandlerAdapter가 HttpRequestHandler Interface를 지원하므로 대상이 된다.
- 핸들러 어댑터 실행
- DispatcherServlet이 조회한 HttpRequestHandlerAdapter를 실행하면서 핸들러 정보도 함께 넘겨준다.
- HttpRequestHandlerAdapter는 핸들러인 MyHttpRequestHandler를 내부에서 실행하고, 그 결과를 반환한다.
정리 - MyHttpRequestHandler 핸들러 매핑, 어댑터
MyHttpRequestHandler를 실행하면서 사용된 객체는 다음과 같다.
HandlerMapping = BeanNameUrlHandlerMapping
HandlerAdapter = HttpRequestHandlerAdapter
@RequestMapping
- 조금 뒤에서 설명하겠지만, 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping과 RequestMappingHandlerAdapter이다.
- RequestMappingHandlerMapping: 애노테이션에 있는 메타 URL 정보로 핸들러를 찾는다.
- RequestMappingHandlerAdapter: @RequestMapping이나 @Controller가 돼 있는 핸들러를 처리하는 핸들러 어댑터다.
- @RequestMapping의 앞글자를 따서 만든 이름인데, 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 Controller를 지원하는 매핑과 어댑터다. 실무에서는 99.9%가 이 방식의 Controller를 사용한다.
3. 뷰 리졸버
이번에는 뷰 리졸버에 대해 자세히 알아본다. 뷰 리졸버는 View의 논리 이름을 물리 이름으로 변환하는 역할을 한다.
OldController 뷰 조회 추가
위에 구현한 OldController에서 null 대신 ModelAndView에 View의 논리 이름을 넣어 반환하도록 변경한다.
@Override
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response)
throws Exception {
System.out.println("OldController.handleRequest");
return new ModelAndView("new-form"); // null 대신 ModelAndView에 뷰의 논리 이름을 넣어 반환
}
이후 서버를 실행하고 웹 브라우저에서 확인해보면 Whitelabel Error Page가 나오고, 콘솔엔 OldController.handlerRequest가 출력된 걸 확인할 수 있다.
- Controller는 정상 호출되지만, Whitelabel Error Page 오류가 발생한다.
에러를 해결하기 위해 application.properties에 다음 코드를 추가해야 한다.
spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp
- 뷰 리졸버 - InternalResourceViewResolver
- 스프링 부트는 InternalResourceViewResolver라는 뷰 리졸버를 자동으로 등록하는데, 이때 application.properties에 등록한 spring.mvc.view.prefix와 spring.mvc.view.suffix 설정 정보를 사용해서 등록한다.
- 적용 시 new-form 앞에 /WEB-INF/views/를 붙이고, 뒤에 .jsp를 붙여 물리 이름으로 변환한다.
- ex. new-form → /WEB-INF/views/new-form.jsp
참고
권장하진 않지만, 설정 없이 다음과 같이 전체 경로를 주어도 동작하기는 한다.
return new ModelAndView("/WEB-INF/views/new-form.jsp");
뷰 리졸버 동작 방식
스프링 부트가 자동 등록하는 뷰 리졸버 (중요한 부분만 설명)
- ViewResolver
...
1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다. (ex. 엑셀 파일 생성 기능에 사용)
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.
...
동작방식은 아래와 같다.
- 핸들러 어댑터 호출
- 핸들러 어댑터를 통해 new-form이라는 논리 View 이름을 획득한다.
- ViewResolver 호출
- new-form이라는 View 이름으로 viewResolver를 순서대로(1, 2) 호출한다. → 2
- BeanNameViewResolver는 new-form이라는 이름의 스프링 빈으로 등록된 View를 찾아야 하는데, 없다.
- InternalResourceViewResolver가 호출된다.
- InternalResourceViewResolver
- 이 뷰 리졸버는 InternalResourceView를 반환한다.
- 이름대로 내부에서 자원을 찾을 수 있을 때 사용한다.
- View - InternalResourceView
- InternalResourceView는 JSP처럼 forward()를 호출해서 처리할 수 있는 경우에 사용한다.
- 우리 직접 만든 MyView와 비슷하다고 보면 된다.
- view.render()
- view.render()가 호출되고, InternalResourceView는 forward()를 사용해 JSP를 실행한다.
참고
InternalResourceViewResolver는 만약 JSTL 라이브러리가 있으면 InternalResourceView를 상속받은 JstlView를 반환한다. JstlView는 JSTL 태그 사용 시 약간의 부가 기능이 추가된다.
참고
다른 View는 실제 View를 렌더링하지만, JSP의 경우 forward()를 통해서 해당 JSP로 이동(실행)해야 렌더링이 된다. JSP를 제외한 나머지 뷰 템플릿들은 forward() 과정 없이 바로 렌더링된다.
참고
Thymeleaf 뷰 템플릿을 사용하면, ThymeleafViewResolver를 등록해야 한다. 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.
4. 스프링 MVC
시작하기
스프링이 제공하는 Controller는 애노테이션을 기반으로 동작하기 때문에 매우 유연하고 실용적이다. 프레임워크가 발전하면서 유연한 Controller를 제공할 수 있게 됐다.
위에서 말했듯이 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 아래와 같다. 지금까지 만들었던 프레임워크에서 사용했던 Controller들을 @RequestMapping 애노테이션 기반의 스프링 MVC Controller로 변경해 보자. 저번 섹션과 비슷하게 점진적으로 발전시켜 보려고 한다.
- @RequestMapping
- RequestMappingHandlerMapping
- RequestMappingHandlerAdapter
a. 회원 등록 폼 Controller
@Controller
public class SpringMemberFormControllerV1 {
@RequestMapping("/springmvc/v1/members/new-form")
public ModelAndView process() {
return new ModelAndView("/new-form");
}
}
- @Controller
- 내부에 @Component 애노테이션이 있어서 컴포넌트 스캔의 대상이 되기 때문에 스프링이 자동으로 스프링 빈으로 등록한다.
- 스프링 MVC에서 애노테이션 기반 Controller로 인식한다.
- @RequestMapping
- 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다.
- 애노테이션을 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.
- ModelAndView
- model과 View 정보를 담아서 반환하면 된다.
RequestMappingHandlerMapping은 스프링 빈 중에서 @Controller가 class 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.
- 참고로 @RestController는 해당 애노테이션 내부에 @Controller를 포함하고 있으므로 스프링 Controller로 인식된다.
- 스프링 부트 3.0 이전엔 @RequestMapping도, 함께 스프링 Controller로 인식해주는 애노테이션이었다.
b. 회원 저장 Controller
@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);
System.out.println("member = " + member);
memberRepository.save(member);
ModelAndView mv = new ModelAndView("save-result");
mv.addObject("member", member);
return mv;
}
}
- mv.addObject("member", member);
- 스프링이 제공하는 ModelAndView를 통해 Model 데이터를 추가할 때는 addObject()를 사용하면 된다. 이 데이터는 이후 View를 렌더링 할 때 사용된다.
c. 회원 목록 조회 Controller
@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;
}
}
URL마다 실행해보면 정상적으로 작동하는 것을 확인할 수 있다.
컨트롤러 통합
@RequestMapping을 잘 보면 class 단위가 아니라 메서드 단위에 적용된 것을 확인할 수 있다. 따라서 Controller class를 유연하게 하나로 통합할 수 있다.
- @RequestMapping의 기본 매핑 경로는 "/"다.
/**
* class 단위 -> 메서드 단위
* @RequestMapping class 레벨과 메서드 레벨 조합
*/
@Controller
@RequestMapping("/springmvc/v2/members")
public class SpringMemberControllerV2 {
private MemberRepository memberRepository = MemberRepository.getInstance();
@RequestMapping("/new-form")
public ModelAndView newForm() {
return new ModelAndView("new-form");
}
@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);
System.out.println("member = " + member);
memberRepository.save(member);
ModelAndView mv = new ModelAndView("save-result");
mv.addObject("member", member);
return mv;
}
@RequestMapping // 기본값이 "/"
public ModelAndView members() {
List<Member> members = memberRepository.findAll();
ModelAndView mv = new ModelAndView("members");
mv.addObject("members", members);
return mv;
}
}
Controller class를 통합하는 것을 넘어 class 레벨과 메서드 레벨의 조합까지 가능하다.
- class 레벨 @RequestMapping("/springmvc/v2/members")
- 메서드 레벨 @RequestMapping("/new-form") → /springmvc/v2/members/new-form
- 메서드 레벨 @RequestMapping("/save") → /springmvc/v2/members/save
- 메서드 레벨 @RequestMapping → /springmvc/v2/members
실용적인 방식
저번 섹션에서 v3는 ModelView를 개발자가 직접 생성해서 반환했기 때문에 불편했던 기억이 날 것이다. 물론 v4를 만들면서 실용적으로 개선한 기억도 날 것이다. 스프링 MVC는 개발자가 편리하게 개발할 수 있도록 수 많은 편의 기능을 제공한다. 실무에서는 지금부터 설명하는 방식을 주로 사용한다.
/**
* v3
* Model 도입
* ViewName 직접 반환
* @RequestParam 사용
* @RequestMapping -> @GetMapping, @PostMapping
*/
@Controller
@RequestMapping("/springmvc/v3/members")
public class SpringMemberControllerV3 {
private MemberRepository memberRepository = MemberRepository.getInstance();
@GetMapping("/new-form")
public 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";
}
@GetMapping // 기본값이 "/"
public String members(Model model) {
List<Member> members = memberRepository.findAll();
model.addAttribute("members", members);
return "members";
}
}
- Model 파라미터
- save(), members()를 보면 Model을 파라미터로 받는 것을 확인할 수 있다. 스프링 MVC도 이런 편의 기능을 제공한다.
- ViewName 직접 반환
- View의 논리 이름을 반환할 수 있다.
- @RequestParam 사용
- 스프링은 HTTP 요청 파라미터를 @RequestParam으로 받을 수 있다.
- @RequestParam("username")은 request.getParameter("username")과 거의 같은 코드라고 생각하면 된다.
- 물론, GET 쿼리 파라미터, POST Form 방식을 모두 지원한다.
- @RequestMapping → @GetMapping, @PostMapping
- @RequestMapping은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다.
- 예를 들어, URL이 /new-form이고, HTTP Method가 GET인 경우를 모두 만족하는 매핑을 하려면 다음과 같이 처리하면 된다.
- 참고로 GET, POST, PUT, DELETE, PATCH 모두 애노테이션이 준비돼 있다.
- @RequestMapping은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다.
아래와 같이 사용하는 경우, POST 방식의 접근을 막을 수 있어 유용함
@RequestMapping(value = "/new-form", method = RequestMethod.GET)
@GetMapping("/new-form")
@PostMapping("/new-form")