[스프링 MVC 1편] #5. 스프링 MVC - 구조 이해

[seyxxn]

5_스프링 MVC - 구조 이해

스프링 MVC 전체 구조

직접 만든 MVC 프레임워크 구조

SpringMVC 구조

• 직접 만든 MVC 프레임워크 구조와 SpringMVC 구조는 동일
  • 구조적으로 완전히 동일하다
• 차이점
  • FrontController -> DispatcherServlet
  • handlerMappingMap -> HandlerMapping
  • MyHandlerAdapter -> HandlerAdapter
  • ModelView -> ModelAndView
  • viewResolver -> ViewResolver
  • MyView -> View

DispatcherServlet 구조

• 스프링 MVC에도 우리가 만든 MVC 구조에서 사용하는 프론트 컨트롤러의 역할을 하는 DispatcherServlet이 존재한다
• 이 디스패처 서블릿이 스프링 MVC의 핵심

DispatcherServlet 등록

• 디스패처 서블릿은 부모 클래스에서 HttpServlet을 상속받아 사용, 서블릿으로 동작하게 됨
  • DispatcherServlet -> FrameworkServlet -> HttpServletBean -> HttpServlet
• 스프링부트는 DispatcherServlet을 서블릿으로 자동 등록하여 모든 경로(urlPatterns="/")에 대해 매핑을 진행
  • 참고 ) 더 자세한 경로의 우선순위가 더 높음

요청 흐름

• 서블릿이 호출되면 HttpServlet이 제공하는 service()가 호출됨

• 스프링 MVC는 DispatcherServlet의 부모인 FrameworkServlet에서 service()를 오버라이드 해두었음

• FrameworkService.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.handle(processedRequest, response, mappedHandler.getHandler());
    
    // 그리고 나서 호출되는 processDispatchResult 함수
    processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);

}

    // processDispatchResult 함수
    // -> 결론적으로 render 함수가 호출 됨
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response, HandlerExecutionChain mappedHandler, ModelAndView mv, Exception exception) throws Exception {
        // 뷰 렌더링 호출
        render(mv, request, response);
}

    // render 함수 (핵심!)
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);
}

SpringMVC 동작순서

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

SpringMVC의 인터페이스

• SpringMVC의 가장 큰 장점은 DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점
• 지금까지 설명한 대부분의 기능들을 인터페이스로 제공
  • 핸들러 매핑 (org.springframework.web.servlet.HandlerMapping)
  • 핸들러 어댑터 (org.springframework.web.servlet.HandlerAdapter)
  • 뷰 리졸버 (org.springframework.web.servlet.ViewResolver)
  • 뷰 (org.springframework.web.servlet.View)

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

SpringMVC에서 이미 많은 기능들을 인터페이스로 제공하고 있기 때문에 지금은 사용하지 않지만, 과거에 사용했던 스프링이 제공하는 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해보자!

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 jakarta.servlet.http.HttpServletRequest;
  import jakarta.servlet.http.HttpServletResponse;
  import org.springframework.stereotype.Component;
  import org.springframework.web.servlet.ModelAndView;
  import org.springframework.web.servlet.mvc.Controller;
  
  // 이 스프링 빈의 이름이 /springmvc/old-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");
          // http://localhost:8080/springmvc/old-controller 접속 시 출력 찍힘
          return null;
      }
  }

  • 이 컨트롤러는 /springmvc/old-controller라는 이름으로 스프링 빈이 등록 된다
  • 빈의 이름으로 URL을 매핑한다

OldController의 호출 과정

• 스프링 MVC 구조 동작을 살펴보면, 컨트롤러가 호출되기 위해서는 2가지가 필요
  • HandlerMapping(핸들러 매핑)
    • 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다
    • 예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요
  • HandlerAdapter(핸들러 어댑터)
    • 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요
    • 예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다

자주 등록하는 핸들러 매핑과 핸들러 어댑터

스프링은 이미 필요한 핸들러 매핑과 핸들러 어댑터를 대부분 구현해두었다

• HandlerMapping

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

• HandlerAdapter

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

핸들러 매핑, 핸들러 어댑터 모두 순서대로 찾고 만약 없으면 다음 순서로 넘어가는 방식이다

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

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

2. 핸들러 어댑터 조회

1. HandlerAdapter의 supports()를 순서대로 호출
2. SimpleControllerHandlerAdapter가 Controller 인터페이스를 지원하므로 대상이 됨

3. 핸들러 어댑터 실행

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

HttpRequestHandler

HttpRequestHandler는 서블릿과 가장 유사한 형태의 핸들러

• HttpRequestHandler

public interface HttpRequestHandler {
    void handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}

간단하게 구현해보자.

• MyhttpRequestHandler

package hello.servlet.web.springmvc.old;

import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.HttpRequestHandler;

import java.io.IOException;

// 1. 핸들러 매핑으로 핸들러를 조회하는데 빈 이름으로 조회된다
// 2. 그리고나서 어댑터를 뒤짐. HttpRequestHandler를 구현했음으로 어댑터 조회 됨
@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. 핸들러 매핑으로 핸들러 조회

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

2. 핸들러 어댑터 조회

1. HandlerAdapter의 supports()를 순서대로 호출
2. HttpRequestHandlerAdapter가 HttpRequestHandler 인터페이스를 지원하므로 대상이 됨

3. 핸들러 어댑터 실행

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

@RequestMapping

• 가장 우선순위가 높은 핸들러 매핑, 핸들러 어댑터
  • RequestMappingHandlerMapping, RequestMappingHandlerAdapter
• 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지우너하는 매핑과 어댑터
• 뒤에서 다시 설명함

뷰 리졸버

• OldController - View 조회할 수 있도록 변경

package hello.servlet.web.springmvc.old;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;

// 이 스프링 빈의 이름이 /springmvc/old-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");
        // http://localhost:8080/springmvc/old-controller 접속 시 출력 찍힘
        return new ModelAndView("new-form");
        // 변경된 부분 -> View를 사용할 수 있도록 함
    }
}

• 🚨 이 상태로 실행해보면 컨트롤러는 정상 호출되어 출력이 찍히지만, 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 설정 정보를 사용해서 등록

스프링 MVC 구조에서의 뷰 리졸버 동작 방식

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

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 실행

스프링 MVC - 시작하기

@RequestMapping

• 매우 유연하고, 실용적인 컨트롤러

• 우선순위가 가장 높은 핸들러 매핑과 핸들러 어댑터

  • RequestMappingHandlerMapping
  • RequestMappingHandlerAdapter

• SpringMemberFormControllerV1 - 회원 등록 폼

  package hello.servlet.web.springmvc.v1;
  
  import org.springframework.stereotype.Component;
  import org.springframework.stereotype.Controller;
  import org.springframework.web.bind.annotation.RequestMapping;
  import org.springframework.web.servlet.ModelAndView;
  
  @Controller
  public class SpringMemberFormControllerV1 {
  
      @RequestMapping("/springmvc/v1/members/new-form")
      public ModelAndView process(){ // 메서드 이름 변경해도 됨
          return new ModelAndView("new-form"); // viewName을 넘겨줘야함
      }
  }

  • @Controller
    • 컨트롤러 애노테이션을 붙였기 때문에 스프링이 자동으로 스프링 빈으로 등록함 (내부에 컴포넌트 애노테이션이 있어서 컴포넌트 스캔의 대상이 된다)
    • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식
  • @RequestMapping
    • 요청 정보를 매핑
    • 해당 URL이 호출되면 이 메서드(process)가 호출
    • 애노테이션을 기반으로 동작하기 때문에 메서드의 이름은 임의로 변경할 수 있음
  • ModelAndView
    • 모델과 뷰 정보를 담아서 반환하면 된다

  @Component //컴포넌트 스캔을 통해 스프링 빈으로 등록
  @RequestMapping
  public class SpringMemberFormControllerV1 {
          @RequestMapping("/springmvc/v1/members/new-form")
          public ModelAndView process() { 
              return new ModelAndView("new-form");
          }
      }

  • 이렇게 작성해도 동일하게 동작한다

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

  • @Component 컴포넌트 스캔없이 스프링 빈으로 직접 등록해도 동작한다

    • 단, 스프링 부트 3.0부터는 클래스 레벨에 @RequestMapping이 있어도 스프링 컨트롤러로 인식하지 않음. 오직 @Controller가 있어야 스프링 컨트롤러로 인식한다

  • ServletApplication

        //스프링 빈 직접 등록
        @Bean
        SpringMemberFormControllerV1 springMemberFormControllerV1() {
            return new SpringMemberFormControllerV1();
        }

• SpringMemberSaveControllerV1 - 회원 저장

package hello.servlet.web.springmvc.v1;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.ModelView;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.Map;

@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);
        memberRepository.save(member);

        ModelAndView mv = new ModelAndView("save-result");
        mv.addObject("member", member);
        // 스프링이 제공하는 ModelAndView를 통해 Model 데이터를 추가할 때는 addObject() 사용
        return mv;
    }
}

• SpringMemberListControllerV1 - 회원 목록

package hello.servlet.web.springmvc.v1;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import hello.servlet.web.frontcontroller.ModelView;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.List;
import java.util.Map;

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

스프링 MVC - 컨트롤러 통합

위에서 작성했던 코드를 살펴보면, @RequestMapping이 클래스 단위로 구성되어 있다. 각각의 클래스가 특정 기능(회원 등록 폼, 회원 저장, 회원 목록)을 담당하며 각각의 클래스에서 @RequestMapping을 사용해서 URL 패턴을 매핑하고 있다.
컨트롤러 통합에서 수정 된 코드에서는 메서드 단위의 컨트롤러를 구성한다. 클래스 하나에 여러 개의 요청 메서드가 있으며, 각각의 메서드가 특정 URL 패턴과 매핑되어 있다.

• SpringMemberControllerV2

package hello.servlet.web.springmvc.v2;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.List;

/**
 * 클래스 단위 -> 메서드 단위로 변경됨
 * @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"); // viewName을 넘겨줘야함
    }



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

}

스프링 MVC - 실용적인 방식

실무에서 주로 사용하는 방식에 속한다

• SpringMemberControllerV3

package hello.servlet.web.springmvc.v3;

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

/**
 * 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 직접 반환
  • 뷰의 논리 이름을 반환할 수 있다
• @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을 사용하면 더 편리하게 사용 가능

---

🔗 출처

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

[6om1n]

역시 👏 최고입니당 😆