Spring mvc 아키텍처

오늘은 spring mvc 아키텍처에 대해서 알아보자
Spring mvc에 대해 깊게 이해하려면 우선 Dispatcher Servlet에대해 알아야한다.

Dispatcher Servlet

• Dispatcher Servlet이란 Spring mvc에서 사용하는 servlet으로 '/' 경로에 매핑하여 들어오는 모든 요청을 모두 처리하도록 되어있다.
• 지금껏 우리는 spring을 사용하면서 @GetMapping("/user") 이런식으로 컨트롤러의 메소드에 request mapping을 했을탠데 사실 이 매핑을 해주고 있는 것은 Dispatcher Servlet이고 실질적으로 Spring은 하나의 servlet만 사용하고 있다.
• 쉽게 말해서 Dispatcher Servlet이 모든 요청을 일단 받고 해당 요청을 @GetMapping 등 mapping 어노테이션을 활용하여 매핑해놓은 컨트롤러의 메소드로 요청을 전달해 주는 방식이다. (아직 와닿지 않을 수 있는데 앞으로 자세하게 설명하겠다.)

DispatcherServlet 구조 살펴보기

org.springframework.web.servlet.DispatcherServlet

• DispatcherServlet은 앞서 설명한 것 처럼 다음 그림을 보면 모든 http 요청을 받아서 처리한다.
• 그리고 이 DispatcherServlet이 바로 스프링 MVC의 핵심이다.

DispacherServlet 서블릿 등록

• DispacherServlet 도 부모 클래스에서 HttpServlet 을 상속 받아서 사용하고, 서블릿으로 동작한다.
• 스프링 부트는 DispacherServlet 을 서블릿으로 자동으로 등록하면서 모든 경로( urlPatterns="/" )에 대해서 매핑한다.
  • 참고: 더 자세한 경로가 우선순위가 높다. 그래서 기존에 추가로 등록한 서블릿도 함께 동작한다.

요청 흐름

• 서블릿이 호출되면 HttpServlet 이 제공하는 serivce() 가 호출된다. (servlet은 보통 service()함수를 호출하면서 요청을 처리한다.)
• 스프링 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);
	
}

동작 순서

1. 핸들러 조회: 핸들러 매핑을 통해 요청 URL에 매핑된 핸들러(컨트롤러)를 조회한다.
2. 핸들러 어댑터 조회: 핸들러를 실행할 수 있는 핸들러 어댑터를 조회한다.
3. 핸들러 어댑터 실행: 핸들러 어댑터를 실행한다.
4. 핸들러 실행: 핸들러 어댑터가 실제 핸들러를 실행한다.
5. ModelAndView 반환: 핸들러 어댑터는 핸들러가 반환하는 정보를 ModelAndView로 변환해서 반환한다.
6. viewResolver 호출: 뷰 리졸버를 찾고 실행한다.
   JSP의 경우: InternalResourceViewResolver 가 자동 등록되고, 사용된다.
7. View 반환: 뷰 리졸버는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체를 반환한다.
   (JSP의 경우 InternalResourceView(JstlView) 를 반환하는데, 내부에 forward() 로직이 있다.)
8. 뷰 렌더링: 뷰를 통해서 뷰를 렌더링 한다.

주요 인터페이스 목록

• 핸들러 매핑: org.springframework.web.servlet.HandlerMapping
• 핸들러 어댑터: org.springframework.web.servlet.HandlerAdapter
• 뷰 리졸버: org.springframework.web.servlet.ViewResolver
• 뷰: org.springframework.web.servlet.View

핸들러 매핑과 핸들러 어댑터

과거버전 스프링 컨테이너

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

이 컨트롤러가 호출되려면 다음 2가지가 필요하다.
1. HandlerMapping(핸들러 매핑)
핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.

2. HandlerAdapter(핸들러 어댑터)
핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.

HandlerMapping

0 = RequestMappingHandlerMapping : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = BeanNameUrlHandlerMapping : 스프링 빈의 이름으로 핸들러를 찾는다.

HandlerAdapter

0 = RequestMappingHandlerAdapter : 애노테이션 기반의 컨트롤러인 @RequestMapping에서
사용
1 = HttpRequestHandlerAdapter : HttpRequestHandler 처리
2 = SimpleControllerHandlerAdapter : Controller 인터페이스(애노테이션X, 과거에 사용)
처리

1. 핸들러 매핑으로 핸들러 조회

• HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.
• 이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는BeanNameUrlHandlerMapping 가 실행에 성공하고 핸들러인 OldController 를 반환한다.

2. 핸들러 어댑터 조회

• HandlerAdapter 의 supports() 를 순서대로 호출한다.
• SimpleControllerHandlerAdapter 가 Controller 인터페이스를 지원하므로 대상이 된다.

3. 핸들러 어댑터 실행

• 디스패처 서블릿이 조회한 SimpleControllerHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.
• SimpleControllerHandlerAdapter 는 핸들러인 OldController 를 내부에서 실행하고, 그 결과를 반환한다.

HttpRequestHandler

Controller 인터페이스가 아닌 다른 핸들러를 알아보자.
HttpRequestHandler 핸들러(컨트롤러)는 서블릿과 가장 유사한 형태의 핸들러이다.

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

1. 핸들러 매핑으로 핸들러 조회

• HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.
• 이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping 가 실행에 성공하고 핸들러인 MyHttpRequestHandler 를 반환한다.

2. 핸들러 어댑터 조회

• HandlerAdapter 의 supports() 를 순서대로 호출한다.
• HttpRequestHandlerAdapter 가 HttpRequestHandler 인터페이스를 지원하므로 대상이 된다.

3. 핸들러 어댑터 실행

• 디스패처 서블릿이 조회한 HttpRequestHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.
• HttpRequestHandlerAdapter 는 핸들러인 MyHttpRequestHandler 를 내부에서 실행하고, 그 결과를 반환한다

@RequestMapping

가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는
RequestMappingHandlerMapping ,
RequestMappingHandlerAdapter 이다.
@RequestMapping 의 앞글자를 따서 만든 이름인데, 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다. 실무에서는 99.9% 이 방식의 컨트롤러를 사용한다

핸들러 메소드(HandlerMethod)란?

• HandlerMethod는 @RequestMapping과 그 하위 어노테이션(@GetMapping, @PostMapping 등)이 붙은 메소드의 정보를 추상화한 객체이다.
• 디스패처 서블릿은 애플리케이션이 실행될 때 모든 컨트롤러 빈의 메소드를 살펴서 매핑 후보가 되는 메소드들을 추출한 뒤, 이를 HandlerMethod 형태로 저장해둔다. 그리고 실제 요청이 들어오면 저장해 둔 목록에서 요청 조건에 맞는 HandlerMethod를 참조해서 매핑되는 메소드를 실행한다.
• HandlerMethod는 그 자체가 실행가능한 객체가 아니라 메소드를 실행하기 위해 필요한 참조정보를 담고 있는 객체로써 다음과 같은 정보들을 가지고 있다.
  • 빈 객체
  • 메소드 메타정보
  • 메소드 파라미터 메타정보
  • 메소드 어노테이션 메타정보
  • 메소드 리턴 값 메타정보

RequestMappingHandlerMapping

• 여기서 HTTP 요청을 HandlerMethod 객체로 변환하는 작업하거나 해당 요청에 매핑되는 HandlerMethod를 반환하는 작업은 RequestMappingHandlerMapping이 담당한다.
• 즉 저장된 HandlerMethod 중에서 해당 요청에 매핑되는 HandlerMethod를 반환한다.
• 그 다음 디스패처 서블릿이 핸들러 어댑터(Handler Adapter)를 통해 HandlerMethod의 정보를 이용해 요청에 매핑되는 메소드를 실행한다.

뷰 리졸버

1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다. (예: 엑셀 파일 생성 기능에 사용)
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.

뷰 리졸버 동작 방식

1. 핸들러 어댑터 호출

• 핸들러 어댑터의 return 값을 통해 new-form 이라는 논리 뷰 이름을 획득한다.

2. ViewResolver 호출

• new-form 이라는 뷰 이름으로 viewResolver를 순서대로 호출한다.
• BeanNameViewResolver 는 new-form 이라는 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없다.
• InternalResourceViewResolver 가 호출된다.

3. InternalResourceViewResolver

• 이 뷰 리졸버는 InternalResourceView 를 반환한다.

4. 뷰 - InternalResourceView

• InternalResourceView 는 JSP처럼 포워드 forward() 를 호출해서 처리할 수 있는 경우에 사용한다.

5. view.render()

• view.render() 가 호출되고 InternalResourceView 는 forward() 를 사용해서 JSP를 실행한다.