[인프런 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술] 5장. 스프링 MVC - 구조 이해

• 해당 내용은, '인프런 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 (유료 - 69,300) 김영한님 강의'를 개인적으로 개념정리를 위해 정리한 내용입니다.

---

DispacherServlet 서블릿 등록

• DispacherServlet 도 부모 클래스에서 HttpServlet 을 상속 받아서 사용하고, 서블릿으로 동작한다.
  • DispatcherServlet → FrameworkServlet → HttpServletBean → HttpServlet
• 스프링 부트는 DispacherServlet 을 서블릿으로 자동으로 등록하면서 모든 경로( urlPatterns="/" )에 대해서 매핑한다.
  • 참고: 더 자세한 경로가 우선순위가 높다. 그래서 기존에 등록한 서블릿도 함께 동작한다.
• 요청 흐름
  • 서블릿이 호출되면 HttpServlet 이 제공하는 serivce() 가 호출된다.
  • 스프링 MVC는 DispatcherServlet 의 부모인 FrameworkServlet 에서 service() 를 오버라이드 해두었다.
  • FrameworkServlet.service() 를 시작으로 여러 메서드가 호출되면서 DispacherServlet.doDispatch() 가 호출된다.
  • 지금부터 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. 뷰 렌더링: 뷰를 통해서 뷰를 렌더링 한다.

 

인터페이스 살펴보기

스프링 MVC의 큰 강점은 DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수있다는 점이다. 지금까지 설명한 대부분을 확장 가능할 수 있게 인터페이스로 제공한다. 이 인터페이스들만 구현해서 DispatcherServlet 에 등록하면 여러분만의 컨트롤러를 만들 수도 있다.

 

주요 인터페이스 목록

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

---

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

핸들러 매핑과 핸들러 어댑터가 어떤 것들이 어떻게 사용되는지 알아보자. 지금은 전혀 사용하지 않지만, 과거에 주로 사용했던 스프링이 제공하는 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해보자.

 

Controller 인터페이스

과거 버전 스프링 컨트롤러 org.springframework.web.servlet.mvc.Controller

public interface Controller {
	ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse
	response) throws Exception;
}

참고 : Controller 인터페이스는 @Controller 애노테이션과는 전혀 다르다.

 

OldController

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을 매핑할 것이다.

실행 http://localhost:8080/springmvc/old-controller

콘솔에 OldController.handleRequest 이 출력되면 성공

 

이 컨트롤러는 어떻게 호출될 수 있을까?

• HandlerMapping(핸들러 매핑)
  • 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
  • 예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.
• HandlerAdapter(핸들러 어댑터)
  • 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
  • 예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.
  • 스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분 구현해두었다. 개발자가 직접 핸들러 매핑과 핸들러 어댑터를 만드는 일은 거의 없다.
• 스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터
  • (실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략)

HandlerMapping

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

HandlerAdapter

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

핸들러 매핑도, 핸들러 어댑터도 모두 순서대로 찾고 만약 없으면 다음 순서로 넘어간다.

1. 핸들러 매핑으로 핸들러 조회
2. HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.
3. 이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping 가 실행에 성공하고 핸들러인 OldController 를 반환한다.
4. 핸들러 어댑터 조회
5. HandlerAdapter 의 supports() 를 순서대로 호출한다.
6. SimpleControllerHandlerAdapter 가 Controller 인터페이스를 지원하므로 대상이 된다.
7. 핸들러 어댑터 실행
8. 디스패처 서블릿이 조회한 SimpleControllerHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.
9. SimpleControllerHandlerAdapter 는 핸들러인 OldController 를 내부에서 실행하고, 그 결과를 반환한다.
10. 정리 - OldController 핸들러매핑, 어댑터
    1. OldController 를 실행하면서 사용된 객체는 다음과 같다.
       1. HandlerMapping = BeanNameUrlHandlerMapping
       2. HandlerAdapter = SimpleControllerHandlerAdapter

---

HttpRequestHandler

핸들러 매핑과, 어댑터를 더 잘 이해하기 위해 Controller 인터페이스가 아닌 다른 핸들러를 알아보자. 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");
 }
}

실행 : http://localhost:8080/springmvc/request-handler

웹 브라우저에 빈 화면이 나오고, 콘솔에 MyHttpRequestHandler.handleRequest 가 출력되면 성공이다

1. 핸들러 매핑으로 핸들러 조회
2. HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.
3. 이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping 가 실행에 성공하고 핸들러인 MyHttpRequestHandler 를 반환한다.
4. 핸들러 어댑터 조회
5. HandlerAdapter 의 supports() 를 순서대로 호출한다.
6. HttpRequestHandlerAdapter 가 HttpRequestHandler 인터페이스를 지원하므로 대상이 된다.
7. 핸들러 어댑터 실행
8. 디스패처 서블릿이 조회한 HttpRequestHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.
9. HttpRequestHandlerAdapter 는 핸들러인 MyHttpRequestHandler 를 내부에서 실행하고, 그 결과를 반환한다.
10. 정리 - MyHttpRequestHandler 핸들러매핑, 어댑터 MyHttpRequestHandler 를 실행하면서 사용된 객체는 다음과 같다. HandlerMapping = BeanNameUrlHandlerMapping HandlerAdapter = HttpRequestHandlerAdapter
11. @RequestMapping 조금 뒤에서 설명하겠지만, 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping , RequestMappingHandlerAdapter 이다. @RequestMapping 의 앞글자를 따서 만든 이름인데, 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다. 실무에서는 99.9% 이 방식의 컨트롤러를 사용한다

---

뷰 리졸버

뷰 리졸버 - InternalResourceViewResolver

스프링 부트는 InternalResourceViewResolver 라는 뷰 리졸버를 자동으로 등록하는데, 이때 application.properties 에 등록한 spring.mvc.view.prefix , spring.mvc.view.suffix 설정 정보를 사용해서 등록한다. 참고로 권장하지는 않지만 설정 없이 다음과 같이 전체 경로를 주어도 동작하기는 한다. return new ModelAndView("/WEB-INF/views/new-form.jsp")

spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

뷰 리졸버 동작 방식

스프링 부트가 자동 등록하는 뷰 리졸버

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

1. 핸들러 어댑터 호출 핸들러 어댑터를 통해 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를 실행한다.

참고

Thymeleaf 뷰 템플릿을 사용하면 ThymeleafViewResolver 를 등록해야 한다. 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.

 

---

스프링 MVC - 시작하기

@RequestMapping

• RequestMappingHandlerMapping
• RequestMappingHandlerAdapter
• 앞서 보았듯이 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는
  • RequestMappingHandlerMapping ,RequestMappingHandlerAdapter 이다.
• @Controller :
  • 스프링이 자동으로 스프링 빈으로 등록한다. (내부에 @Component 애노테이션이 있어서 컴포넌트 스캔의 대상이 됨)
  • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.
• @RequestMapping : 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다. 애노테이션을 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.
• ModelAndView : 모델과 뷰 정보를 담아서 반환하면 된다.

---

스프링 MVC - 실용적인 방식

@RequestParam 사용

스프링은 HTTP 요청 파라미터를 @RequestParam 으로 받을 수 있다. @RequestParam("username") 은 request.getParameter("username") 와 거의 같은 코드라 생각하면 된다.

물론 GET 쿼리 파라미터, POST Form 방식을 모두 지원한다.

 

---

스프링 MVC 구조에서 핸들러 어댑터 위치?

1. 클라이언트의 요청이 들어오면 DispatcherServlet이 요청을 수신합니다.

2. DispatcherServlet은 HandlerMapping에게 요청을 전달하여 적절한 handler(=controller)를 찾습니다.

3. HandlerMapping은 요청을 기반으로 적절한 handler(=controller)를 찾아 반환합니다.

4. DispatcherServlet은 반환된 handler(=controller)를 실행할 수 있는 적절한 HandlerAapter에게 전달합니다. 스프링은 HandlerAdapter 인터페이스를 구현한 다양한 클래스들을 갖고 있습니다. 예를 들어 만약 @RequestMapping 애노테이션을 사용하는 handler(=controller)의 경우, RequestMappingHandlerAdapter에게 전달되고, 만약 @RestController 애노테이션을 사용하는 handler(=controller)의 경우,HttpRequestHandlerAdapter에게 전달됩니다.

5. HandlerAdapter 구현체가 handler(=controller)를 실행할 수 있도록 요청 값 변환, 검증, 반환 값 변환 등의 작업을 수행했다면 그 결과를 handler(=controller)에게 하고, handler(=controller)는 비즈니스 로직 수행을 완료하고, 필요한 데이터를 Model에 저장합니다.

6. handler(=controller)는 ModelAndView 객체를 생성하고, Model를 ModelAndView에 추가합니다.

7. ModelAndView 객체는 ViewResolver에게 전달됩니다.

8. ViewResolver는 논리적인 View(ex. "myForm")를 물리적인 View(ex. "WEB/views/myForm.jsp")로 변환합니다.

9. 변환된 View는 DispatcherServlet에 반환됩니다.

10. DispatcherServlet은 View를 실행하여 클라이언트에게 응답을 생성합니다.

11. 응답은 클라이언트에게 전송되고, 요청-응답 주기가 완료됩니다.