Spring MVC 전체 구조

이전에 직접 만들었던 MVC 프레임워크와 Spring MVC를 비교해보면 그 구조가 거의 똑같다.

이전	Spring MVC
FrontController	DispatcherServlet
handlerMappingMap	HandlerMapping
MyHandlerAdapter	HandlerAdapter
ModelView	ModelAndView
viewResolver	ViewResolver
MyView	View

DispatcherServlet 구조

스프링 MVC도 프론트 컨트롤러 패턴으로 구현되어 있다. 스프링 MVC의 프론트 컨트롤러가 바로 디스패처 서블릿(DispatcherServlet) 이다.

DispatcherServlet도 부모 클래스에서 HttpServlet을 상속받아 사용하고, 서블릿으로 동작한다.

Spring Boot 구동시 DispatcherServlet을 서블릿으로 자동 등록하면서 모든 경로(urlPatterns="/") 에 대해 매핑한다.
→ 별도로 @WebServlet(name=" ", urlPattern=" ")을 등록할 필요가 없다.

요청 흐름

• 서블릿이 호출되면 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. 핸들러 조회
    mappledHandler = 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);
}

• mappledHandler = getHandler(processedRequest); : 요청에 맞는 적절한 핸들러를 찾아 반환한다.
• noHandlerFound(processedRequest, response); : 적절한 핸들러를 찾지 못한경우 404 에러코드를 반환한다.
• HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler()); : 찾은 핸들러를 처리할 수 있는 핸들러 어댑터를 찾는다. 만약 찾지 못할 경우, ServletException 발생
• mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); : 찾은 핸들러 어댑터를 이용해 로직을 수행하는 handle 메소드를 호출. ModelAndView를 반환하고 이를 이용해 렌더링까지 수행한다.
• processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException); : render() 메소드를 호출한다. render()에서는 ModelAndView에서 View를 찾아 뷰 리졸버를 이용해 뷰의 물리적 이름을 완성해서 forward 한다.

Spring MVC 동작 순서

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

스프링 MVC는 내부적으로 코드 분량도 매우 많고, 복잡해서 이 구조를 다 파악하는 것은 쉽지 않다. 해당 기능을 직접 확장하거나 나만의 컨트롤러를 만드는 일은 없고, 웹 애플리케이션을 만들때 필요로하는 대부분의 기능이 이미 다 구현되어 있다. 따라서 기본적인 사용법만 익혀 애노테이션을 사용하면 서버를 구현하는데 어려움이 없다. 다만 문제 발생 시 핵심 동작 방식을 알아두면 대응하기 용이할 것이다.

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

Controller 인터페이스

과거 버전의 스프링 컨트롤러 인터페이스는 다음과 같다.

org.springframework.web.servlet.mvc.Controller

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

이 형식의 컨트롤러를 간단하게 구현해보면 다음과 같다.

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/example")
public class ExController implements Controller {
    
    @Override
    ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        System.out.println("ex.handleRequest");
        return null;
    }
}

@Component: 이 컨트롤러는 /springmvc/example라는 이름의 스프링 빈으로 등록되었다. 빈의 이름으로 URL을 매핑할 것이다.

이 컨트롤러가 호출되려면 2가지가 필요하다.

• HandlerMapping
  → 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
  → 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요
• HandlerAdapter
  → 핸들러 매핑을 통해 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
  → Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾아야 한다.

스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분 구현해두었다. 따라서 개발자가 직접 이를 만드는 일은 거의 없다.

스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터는 다음과 같다.

• HandlerMapping

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

• HandlerAdpater

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

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

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

뷰 리졸버

View의 논리 이름을 물리 이름으로 완성시켜주는 뷰 리졸버를 Spring MVC에선 어떻게 만들어 줄까?

앞서 만든 ExController를 변경하면 다음과 같다. View를 사용할 수 있도록 리턴을 변경하였다.

@Override
ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
    System.out.println("ex.handleRequest");
    return new ModelAndView("new-form");
}

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 설정 정보를 사용한다.

위 구조에서 6, 7번 과정에서 뷰 리졸버가 동작한다.

스프링 부트가 자동 등록하는 뷰 리졸버의 일부는 다음과 같다.

1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아 반환한다.
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.

1. 핸들러 어댑터 호출
   → 핸들러 어댑터를 통해 new-form이라는 논리 뷰 이름을 획득한다.
2. ViewResolver 호출
   → new-form이라는 뷰 이름으로 viewResolver를 순서대로 호출한다.
   → BeanNameViewResolver는 new-form 이라는 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없다.
   → InternalResourceViewResolver가 호출된다.
3. InternalResourceViewResolver
   → 뷰 리졸버는 InternalResourceView를 반환한다.
4. 뷰 - InternalResourceView
   → InternalResourceView는 JSP처럼 포워드를 호출해서 처리할 수 있는 경우에 사용한다.
5. view.render()
   → view.render()가 호출되고 InternalResourceView는 forward()를 사용해 JSP를 실행한다.

스프링 MVC - 시작하기

스프링이 제공하는 컨트롤러는 애노테이션 기반으로 동작해서, 매우 유연하고 실용적이다.

@RequestMapping

기존에 @WebServlet에서 urlPattern을 사용하고, Component에 빈 이름으로 URL을 작성해서 사용했지만, 이 애노테이션을 사용해서 편리하게 컨트롤러를 구현하게 되었다.

@RequestMapping

• RequestMappingHandlerMapping
• RequestMappingHandlerAdapter

여러 핸들러 매핑과 핸들러 어댑터가 등록되고 우선순위가 있는데, 이 중 가장 우선순위가 높은 핸들러 매핑과 어댑터는 RequestMappingHandlerMapping, RequestMappingHandlerAdapter 이다. @RequestMapping 애노테이션은 이 핸들러 매핑과 어댑터의 앞글자를 따서 만든 애노테이션이다. 실무에서는 이 방식의 컨트롤러를 사용한다.

@Controller
public class SpringMemberFormControllerV1 {
    
    @RequestMapping("/springmvc/v1/members/new-form")
    public ModelAndView process() {
        return new ModelAndView("new-form");
    }
}

• @Controller: 스프링이 자동으로 스프링 빈으로 등록한다. 내부에 @Component 애노테이션이 있다. 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.
• @RequestMapping: 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메소드가 호출된다.
• ModelAndView: 모델과 뷰 정보를 담아서 반환하면 된다.

@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);
        Member save = memberRepository.save(member);
        
        ModelAndView mv = new ModelAndView("save-result");
        mv.addObject("member", member);
        return mv;
    }
}

• mv.addObject("member", member): 스프링이 제공하는 ModelAndView를 통해 Model 데이터를 추가할 때는 addObject()를 사용하면 된다. 이 데이터는 이후 뷰를 렌더링할 때 사용된다.

스프링 MVC - 컨트롤러 통합

@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);
        Member save = 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;
    }
}

조합

컨트롤러 클래스를 통합하는 것을 넘어 조합도 가능한데, 클래스 레벨의 @RequestMapping("/springmvc/vX/members/") 애노테이션을 추가해주고, 각각의 메소드 레벨에서 중복 경로를 제거해주면 클래스 레벨과 메소드 레벨이 조합되서 등록된다.

조합 결과

• 클래스 레벨 @RequestMapping("/springmvc/vX/members/")
  • 메소드 레벨 @RequestMapping("/new-form") : /springmvc/vX/members/new-form
  • 메소드 레벨 @RequestMapping("/save") : /springmvc/vX/members/save
  • 메소드 레벨 @RequestMapping : /springmvc/vX/members

스프링 MVC - 실용적인 방식

실무에서는 주로 이 방식을 사용한다.

@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);
        Member save = 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을 파라미터로 받으면 된다. 기존처럼 ModelAndView 객체를 만들고 여기에 데이터를 넣어주지 않아도 된다.
• viewName 직접 반환: 애노테이션 기반의 컨트롤러는 ModelAndView 뿐 아니라 ViewName을 직접 반환해도 동작한다.
• @RequestParam 사용
  → 스프링은 HTTP 요청 파라미터를 @RequestParam으로 받을 수 있다.
  → @RequestParam("username")은 request.getParameter("username")와 거의 같은 코드라 생각하면 된다.
  → GET 쿼리 파라미터, POST Form 방식을 모두 지원한다.
• @RequestMapping → @GetMapping, @PostMapping
  → @RequestMapping은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다. Get, Post, Put, Delete, Patch 모두 애노테이션이 준비되어 있다.

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.GET)
public @interface GetMapping {
    ...
}

References

• 김영한님의 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술