[김영한 스프링 MVC 1] 스프링 MVC

Programming/스프링

[김영한 스프링 MVC 1] 스프링 MVC - 구조 이해

지고르 2023. 10. 22. 01:27

스프링 MVC 전체 구조

직접 만든 MVC 프레임워크 - 실제 스프링 MVC 구조 비교

FrontController → DispatcherServlet
handlerMappingMap → HandlerMapping
MyHandlerAdapter → HandlerAdapter
ModelView → ModelAndView
viewResolver → ViewResolver
MyView → View

DispatcherServlet

스프링 MVC의 핵심

DispacherServlet => 부모 클래스에서 HttpServlet을 상속받아 사용, 서블릿으로 동작
(DispatcherServlet → FrameworkServlet → HttpServletBean → HttpServlet)

스프링 부트는 DispacherServlet을 서블릿으로 자동으로 등록 → 모든 경로(urlPatterns="/")에 대해 매핑

서블릿 호출 시 HttpServlet.service() 호출됨 (스프링 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);
}

Spring MVC 구조

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 인터페이스

=> 과거 버전 스프링 컨트롤러

Controller

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

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

}

/springmvc/old-controller 라는 이름의 스프링 빈으로 등록함

=> 빈의 이름으로 URL 매핑

컨트롤러 호출 방식

핸들러 매핑

핸들러 매핑에서 컨트롤러를 찾을 수 있어야 함
ex) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요

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

핸들러 어댑터

핸들러 매핑을 통해 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요
ex) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 함

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

OldController 호출 순서

1. 핸들러 매핑으로 핸들러 조회
HandlerMapping 을 순서대로 실행해, 핸들러를 찾음
빈 이름으로 핸들러를 찾아 BeanNameUrlHandlerMapping 실행 성공 시 핸들러인 OldController 반환

2. 핸들러 어댑터 조회
HandlerAdapter 의 supports() 를 순서대로 호출
SimpleControllerHandlerAdapter 가 Controller 인터페이스를 지원하므로 대상이 됨

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

HttpRequestHandler

=> Controller 인터페이스가 아닌 다른 핸들러
=> 서블릿과 가장 유사한 형태

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

}

동작 순서

1. 핸들러 매핑으로 핸들러 조회
HandlerMapping 을 순서대로 실행, 핸들러를 찾음
빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping 가 실행에 성공, 핸들러인 MyHttpRequestHandler를 반환

2. 핸들러 어댑터 조회
HandlerAdapter 의 supports() 를 순서대로 호출
HttpRequestHandlerAdapter 가 HttpRequestHandler 인터페이스를 지원하므로 대상이 됨

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

@RequestMapping

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

RequestMappingHandlerMapping
RequestMappingHandlerAdapter

뷰 리졸버

OldController View 조회

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 new ModelAndView("new-form"); /////
    }

}

application.properties

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

코드 추가 => 경로 편리하게 설정 가능하도록

뷰 리졸버 동작 방식

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

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

동작 순서

1. 핸들러 어댑터 호출
핸들러 어댑터를 통해 new-form이라는 논리 뷰 이름 획득

2. ViewResolver 호출
new-form 이라는 뷰 이름으로 viewResolver를 순서대로 호출
BeanNameViewResolver 는 new-form 이라는 이름의 스프링 빈으로 등록된 뷰 탐색 → 없음
InternalResourceViewResolver 호출

3. InternalResourceViewResolver
InternalResourceView를 반환

4. 뷰 - InternalResourceView
JSP처럼 forward()를 호출해서 처리할 수 있는 경우에 사용

5. view.render()
view.render() 가 호출, InternalResourceView 는 forward() 를 사용해 JSP 실행

※ InternalResourceViewResolver => JSTL 라이브러리가 있으면 InternalResourceView를 상속받은 JstlView를 반환

※
JSP => forward() 통해 해당 JSP로 이동(실행)해야 렌더링됨

JSP 외 뷰 템플릿들은 forward() 과정 없이 바로 렌더링됨

※

Thymeleaf 뷰 템플릿 => ThymeleafViewResolver를 등록해야 함

최근에는 라이브러리만 추가해도 스프링 부트가 자동화해줌

스프링 MVC - 시작

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

RequestMapping

연관된 핸들러 매핑, 핸들러 어댑터 : RequestMappingHandlerMapping, RequestMappingHandlerAdapter

=> 실무에서 99% 해당 컨트롤러 사용

RequestMappingHandlerMapping => 클래스 레벨에 @Controller 붙어있는 스프링 빈을 매핑 정보로 인식

SpringMemberFormControllerV1

package hello.servlet.web.springmvc.v1;

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

}

@Controller : 스프링이 스프링빈으로 자동 등록 (내부에 @Component 있어 컴포넌트 스캔 대상이 됨)

@RequestMapping : 요청 정보를 매핑함 => 해당 url 호출 시 이 메소드 호출됨

ModelAndView : 모델, 뷰 정보 담아 반환

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 org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
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); ////
        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 javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;
import java.util.Map;

@Controller
public class SpringMemberListControllerV1 {

    private final MemberRepository memberRepository = MemberRepository.getInstance();

    @RequestMapping("/springmvc/v1/members")
    public ModelAndView process(HttpServletRequest request, HttpServletResponse response) {
        List<Member> members = memberRepository.findAll();
        ModelAndView mv = new ModelAndView("members");
        mv.addObject("members", members);

        return mv;
    }

}

스프링 MVC - 컨트롤러 통합

@RequestMapping => 클래스 레벨, 메소드 레벨의 조합 가능

=> 클래스 레벨로 작성 시 중복 url 제거 가능

SpringMemberControllerV2

package hello.servlet.web.springmvc.v2;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;

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

    @RequestMapping ////
    private ModelAndView members(HttpServletRequest request, HttpServletResponse response) {
        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;

@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
    private String members(Model model) {
        List<Member> members = memberRepository.findAll();

        model.addAttribute("members", members);

        return "members";
    }

}

Model 파라미터

뷰 논리 이름 직접 반환

@RequestParam으로 HTTP 요청 파라미터 수신 (get, post 모두 지원)

정리