[Spring MVC] 4. 스프링 MVC 구조 이해하기

📝 스프링 MVC 전체 구조

• 직접 만든 MVC 프레임워크와 스프링 MVC를 비교해보자.

직접 만든 MVC 프레임워크

스프링 MVC 구조

• 직접 만든 MVC 프레임워크 → 스프링 MVC 비교
  • FrontController → DispatcherServlet
  • handlerMappingMap → HandlerMapping
  • MyHandlerAdapter → HandlerAdapter
  • ModelView → ModelAndView
  • viewResolver → ViewResolver
  • MyView → View

 

📜 DispatcherServlet 구조 살펴보기

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

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

 

📜 DispatcherServlet 요청 흐름

• 서블릿이 호출되면 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);
}

• 코드를 살펴보면 우리가 직접 구현한 MVC 프레임워크와 매우 유사한 과정을 거치고 있다는 것을 확인할 수 있다.
• 즉, 스프링 MVC의 전체적인 동작 순서는 다음과 같다.

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

 

📜 스프링 MVC - 인터페이스

• 스프링 MVC의 큰 강점은 DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다.
• 스프링은 지금까지 설명한 대부분을 확장 가능할 수 있게 인터페이스로 제공한다.
• 이 인터페이스들만 구현해서 DispatcherServlet에 등록하기만 하면 여러분만의 컨트롤러를 만들 수도 있다.
• 주요 인터페이스 목록
  • 핸들러 매핑: org.springframework.web.servlet.HandlerMapping
  • 핸들러 어댑터: org.springframework.web.servlet.HandlerAdapter
  • 뷰 리졸버: org.springframework.web.servlet.ViewResolver
  • 뷰: org.springframework.web.servlet.View

---

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

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

 

📜 Controller 인터페이스

• 스프링도 처음에는 아래와 같은 딱딱한 형식의 컨트롤러를 제공했다.

public interface Controller {

    ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}

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

• 이를 간단하게 구현해보자.

@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(핸들러 매핑)
    • 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
    • 예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.
  • HandlerAdapter(핸들러 어댑터)
    • 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
    • 예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.
• 스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분 구현해두었다.
• 따라서 개발자가 직접 핸들러 매핑과 핸들러 어댑터를 만드는 일은 거의 없다.

 

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

• 스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터를 살펴보자.
• 실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략되었다.
• 앞의 숫자는 우선순위를 의미한다.

HandlerMapping

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

 

HandlerAdapter

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

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

 

📜 Controller 호출 과정

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

---

📝 뷰 리졸버

• 이번에는 뷰 리졸버에 대해서 자세히 알아보자

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

• 먼저 View를 사용할 수 있도록 Controller 코드를 수정해주었다.
• 실행해보면 컨트롤러를 정상 호출되지만, 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");

 

📜 뷰 리졸버 동작 방식

• 스프링 부트가 자동으로 등록하는 뷰 리졸버는 다음과 같다. (실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 생략한다.)
• 앞의 숫자는 우선순위를 나타낸다.

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를 실행한다.

InternalResourceViewResolver는 만약 JSTL 라이브러리가 있으면 InternalResourceView를 상속받은 JstlView를 반환한다. JstlView는 JSTL 태그 사용시 약간의 부가 기능이 추가된다.

다른 뷰는 실제 뷰를 렌더링하지만, JSP의 경우 forward() 통해서 해당 JSP로 이동(실행)해야 렌더링이 된다. JSP를 제외한 나머지 뷰 템플릿들은 forward() 과정 없이 바로 렌더링 된다.

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

---

📝 스프링 MVC - 시작하기

• 이제 본격적으로 스프링 MVC를 시작해보자.
• 스프링이 제공하는 컨트롤러는 애노테이션 기반으로 동작해서, 매우 유연하고 실용적이다.
• 과거에는 자바 언어에 애노테이션이 없기도 했고, 스프링도 처음부터 이런 유연한 컨트롤러를 제공한 것은 아니다.

 

📜 @RequestMapping

• 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping, RequestMappingHandlerAdapter이다.
• @RequestMapping의 앞글자를 따서 만든 이름인데, 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다.
• 실무에서는 99.9% 이 방식의 컨트롤러를 사용한다.
• 그럼 이제 본격적으로 애노테이션 기반의 컨트롤러를 사용해보자.
• 지금까지 만들었던 프레임워크에서 사용했던 컨트롤러를 @RequestMapping 기반의 스프링 MVC 컨트롤러 변경해보자.

@Controller
public class SpringMemberFormControllerV1 {

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

• @Controller
  • 스프링이 자동으로 스프링 빈으로 등록한다. (내부에 @Component 애노테이션이 있어서 컴포넌트
    스캔의 대상이 됨)
  • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.
• @RequestMapping
  • 요청 정보를 매핑한다.
  • 해당 URL이 호출되면 이 메서드가 호출된다.
  • 애노테이션을 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.
• ModelAndView: 모델과 뷰 정보를 담아서 반환하면 된다.
• 참고로 RequestMappingHandlerMapping은 스프링 빈 중에서 @RequestMapping 또는 @Controller가
  클래스 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.
• 따라서 다음 코드도 동일하게 동작한다.

@Component //컴포넌트 스캔을 통해 스프링 빈으로 등록
@RequestMapping
public class SpringMemberFormControllerV1 {

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

• 물론 컴포넌스 스캔 없이 다음과 같이 스프링 빈으로 직접 등록해도 동작한다.

스프링 부트 3.0(스프링 프레임워크 6.0)부터는 클래스 레벨에 @RequestMapping이 있어도 스프링 컨트롤러로 인식하지 않는다. 오직 @Controller가 있어야 스프링 컨트롤러로 인식한다. 따라서 @Controller가 없는 위 코드는 더이상 스프링 컨트롤러로 인식되지 않는다.
참고로 @RestController는 해당 애노테이션 내부에 @Controller를 포함하고 있으므로 인식 된다.

---

📝 스프링 MVC - 컨트롤러 통합

• @RequestMapping을 잘 보면 클래스 단위가 아니라 메서드 단위에 적용된 것을 확인할 수 있다.
• 따라서 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.

/**
* 클래스 단위 -> 메서드 단위
* @RequestMapping 클래스 레벨과 메서드 레벨 조합
*/
@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);
        memberRepository.save(member);

        ModelAndView mav = new ModelAndView("save-result");
        mav.addObject("member", member);

        return mav;
    }

    @RequestMapping
    public ModelAndView members() {
        List<Member> members = memberRepository.findAll();

        ModelAndView mav = new ModelAndView("members");
        mav.addObject("members", members);

        return mav;
    }
}

• 컨트롤러 클래스를 통합하는 것을 넘어서 조합도 가능하다.
• 예를 들어, 다음 코드들은 /springmvc/v2/members라는 부분에 중복이 있다.
  • @RequestMapping("/springmvc/v2/members/new-form")
  • @RequestMapping("/springmvc/v2/members")
  • @RequestMapping("/springmvc/v2/members/save")
• 물론 이렇게 사용해도 되지만, 컨트롤러를 통합한 예제 코드를 보면 중복을 어떻게 제거했는지 확인할 수 있다.
• 클래스 레벨에 다음과 같이 @RequestMapping을 두면 메서드 레벨과 조합이 된다.

@Controller
@RequestMapping("/springmvc/v2/members")
public class SpringMemberControllerV2 {}

• 결과적으로 다음과 같은 조합 결과가 나온다.
  • 클래스 레벨: @RequestMapping("/springmvc/v2/members")
    • 메서드 레벨: @RequestMapping("/new-form") → /springmvc/v2/members/new-form
    • 메서드 레벨: @RequestMapping("/save") → /springmvc/v2/members/save
    • 메서드 레벨: @RequestMapping → /springmvc/v2/members

---

📝 스프링 MVC - 실용적인 방식

• MVC 프레임워크 만들기에서 v3는 ModelView를 개발자가 직접 생성해서 반환했기 때문에, 불편했던 기억이 날 것이다. 물론 v4를 만들면서 실용적으로 개선한 기억도 날 것이다.
• 스프링 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);
        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 직접 반환
  • 뷰의 논리 이름을 직접 반환할 수 있다.
• @RequestParam 사용
  • 스프링은 HTTP 요청 파라미터를 @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으로 더 편리하게 사용할 수 있다.
    • @GetMapping("/new-form")
  • 참고로 Get, Post, Put, Delete, Patch 모두 애노테이션이 준비되어 있다.

---

📌 Reference

• https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard