[Spring MVC] 05. 스프링 MVC - 구조 이해

 

5. 스프링 MVC - 구조 이해

#Spring/MVC

정리

이전 챕터에서 직접 만들었던 MVC 프레임워크와 아래 스프링 MVC를 비교해보자.

1 ~ 8 단계 구조가 같고, 이름만 다르다.

• FrontController DispatcherServlet
• handlerMappingMap HandlerMapping
• MyHandlerAdapter HandlerAdapter
• ModelView ModelAndView
• viewResolver ViewResolver(인터페이스)
• MyView View(인터페이스)

달라진 부분을 하나씩 살펴보자

DispatcherServlet

org.springframework.web.servlet.DispatcherServlet

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

DispatcherServlet 서블릿 등록

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

요청 흐름

• 서블릿이 호출되면 HttpServlet이 제공하는 service()가 호출된다.
• 스프링 MVC는 DispatcherServlet의 부모인 FrameworkServlet에서 service()를 오버라이드 해두었다.
• FrameworkServlet.service()를 시작으로 여러 메서드가 호출되면서 DispatcherServlet.doDispatch()가 호출된다.

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 반환
    view.render(mv.getModelInternal(), request, response);
}

우리가 전에 직접 구현했던 프론트 컨트롤러와 구조가 매우 유사하다는 것을 알 수 있다.
차이점이 있다면, 스프링은

• 핸들러 조회시 스프링은 단순히 URL로만 하는 건 아니고, 헤더도 고려해서 조회한다.
• 핸들러 어댑터는 우리가 직접 만들었던 ModelView가 아니라 ModelAndView를 반환한다.
• viewResolver는 인터페이스이다.
  • JSP의 경우: InternalResourceViewResolver가 자동 등록되고, 사용된다.
• View 반환: 뷰 리졸버는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체를 반환한다.
  • 여기서 view는 우리가 이전에 만들었던 MyView와 다르게 인터페이스로 구현되어 있다.
  • JSP의 경우 InternalResourceView (JstlView)를 반환하는데, 내부에 forward() 로직이 있다.

스프링 MVC의 큰 강점은 DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다. 지금까지 설명한 대부분을 확장 가능할 수 있게 인터페이스로 제공한다.

주요 인터페이스 목록

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

우리가 이 기능을 직접 확장할 일은 없다고 봐도 된다. 하지만, 동작 방식을 알아둬야 향후 문제가 발생했을 때 어떤 부분에서 문제가 발생했는지 쉽게 파악하고, 문제를 해결할 수 있다.

그리고 확장 포인트가 필요할 때, 어떤 부분을 확장해야 할지 감을 잡을 수 있다.

- 인프런 김영한 강사님 -

스프링 핸들러 매핑과 핸들러 어댑터

과거에 주로 사용했던 스프링이 제공하는 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해보자.

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

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

우리가 전에 구현했던 v3버전 컨트롤러와 매우 유사하다. 스프링도 처음에는 이런 딱딱한 형식의 컨트롤러를 제공했다. (애노테이션과는 무관한 인터페이스이다)

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

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

실행: http://localhost:8080/springmvc/old-controller
url 정보를 스프링 빈 이름으로만 등록했는데, 정상적으로 호출된다. 어떻게 호출된 것일까?

이 컨트롤러가 호출되려면 핸들러 매핑과 핸들러 어댑터 과정을 거쳐야 한다.

• 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.
• 핸들러 매핑을 통해 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.

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

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

HandlerMapping

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

HandlerAdapter

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

핸들러 매핑에서 1번 순서, 핸들러 어댑터에서 2번 순서로 조회됬다는 것을 알 수 있다.

HttpRequestHandler

핸들러 어댑터에서 2번 말고 1번 HttpRequestHandler를 구현해보자.

HttpRequestHandler

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

MyHttpRequestHandler

@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번 순서로 조회됬다는 것을 알 수 있다.

물론 실무에서는 99.9% 애노테이션 기반 @RequestMapping 방식을 사용한다.

뷰 리졸버

만약 위의 OldController에서 “new-form”이라는 논리이름을 담은 ModelAndView를 반환하면 어떻게 될까?

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

실행해보면 오류가 발생한다.

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

실제로는 다음과 같이 동작하고 있다.

@ServletComponentScan // 서블릿 자동 등록
@SpringBootApplication
public class ServletApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServletApplication.class, args);
    }

    @Bean
    ViewResolver internalResourceViewResolver() {
        return new InternalResourceViewResolver("/WEB-INF/views", ".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를 실행한다.

스프링 MVC 적용

자바에 애노테이션이 생기면서, 스프링이 애노테이션 기반 컨트롤러를 제공하기 시작했다.

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

직접 @RequestMapping을 이용하여 컨트롤러를 바꿔보자.

V1

등록 폼

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

@Controller: 스프링이 자동으로 스프링 빈으로 등록한다. (내부에 @Component 애노테이션이 있어서 컴포넌트 스캔의 대상이 됨)
@RequestMapping: 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다. 애노테이션을 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.

그리고 기존처럼 논리 이름을 담은 ModelAndView를 반환해주면 된다.

주의

스프링 부트 3.0(스프링 프레임워크 6.0)부터는 클래스 레벨에 @RequestMapping 이 있어도 스프링 컨트롤러로 인식하지 않는다. 오직 @Controller 가 있어야 스프링 컨트롤러로 인식한다. 또한, 내부에 @Controller를 포함하고 있으면 스프링 컨트롤러로 인식된다.

저장 컨트롤러

@Controller
public class SpringMemberSaveControllerV1 {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/springmvc/v1/members/save")
    public ModelAndView process(HttpServletRequest request, HttpServletResponse response) {
		// 중략
        memberRepository.save(member);
        ModelAndView mv = new ModelAndView("save-result");
        mv.addObject("member", member);
        return mv;
    }
}

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

회원 목록 컨트롤러도 이런식으로 만들면 된다.

여기까지 봤을 때 불편한 점이 많을 것이다. 일단 구조가 v3 기반이라 v4 버전처럼 개선할 수 있을 것 같기도 하고, @RequestMapping 을 잘 보면 클래스 단위가 아니라 메서드 단위에 적용된 것을 확인할 수 있다. 따라서 컨트롤러 클래스를 유연하게 하나로 통합할 수 있을 것 같다.

먼저 여러 컨트롤러를 하나의 클래스로 통합시켜보자.

V2- 컨트롤러 통합

/**
 * 클래스 단위 -> 메서드 단위
 * @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("/new-form") → /springmvc/v2/members/new-form
• 메서드 레벨 @RequestMapping("/save") → /springmvc/v2/members/save
• 메서드 레벨 @RequestMapping → /springmvc/v2/members

V3 - 실용적인 방식

아까 말했던 것 처럼 프론트 컨트롤러 버전 v3 v4로 개선하는 과정을 여기에다가 적용해보고, 다른 것도 개선해보자.

@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 으로 더 편리하게 사용할 수 있다. (내부에 위와 같이 동작하도록 구현되어 있다.) 참고로 @Get, @Post, @Put, @Delete, @Patch 모두 애노테이션이 준비되어 있다

Ref) 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 강의 | 김영한 - 인프런