Spring

[인프런/스프링 MVC 1편] 5. 스프링 MVC - 구조 이해

주니어주니 2023. 5. 2. 19:56

 

 

1. 스프링 MVC 전체 구조

 

 

1-1. 직접 만들어본 MVC 구조와 스프링 MVC 구조 비교

 

직접 만든 MVC 프레임워크

 

스프링 MVC 프레임워크

 

  • 직접 만든 MVC 프레임워크 -> 스프링 MVC 프레임워크 비교
    • FrontController -> DispatcherServlet (핵심)
    • handlerMappingMap -> HandlerMapping
    • MyHandlerAdapter -> HandlerAdapter
    • ModelView -> ModelAndView
    • viewResolver -> VIewResolver
    • MyView -> View

 

 

2. DispatcherServlet 구조 살펴보기 (스프링 MVC의 핵심)

 

 

2-1. DispatcherServlet 서블릿 등록

  • 부모 클래스에서 HttpServlet을 상속받아서 사용, 서블릿으로 동작
    • DispatcherServlet -> FrameworkServlet -> HttpServletBean -> HttpServlet
  • 스프링부트는 DispatcherServlet을 서블릿으로 자동 등록하면서 모든경로(urlPatterns="/")에 대해서 매핑
    (-> 모든 요청에 대해 이 서블릿이 호출됨)
    (더 자세한 경로가 우선순위가 더 높기 때문에 기존에 등록한 서블릿도 함께 동작)

 

2-2. 요청 흐름

  • 서블릿 호출 -> HttpServlet이 제공하는 service() 호출
  • 스프링 MVC는 DispatcherServlet의 부모인 FrameworkServlet에서 service()를 오버라이드 해둠
  • FrameworkServlet.service()를 실행하면 여러 메소드가 호출되면서 DispatcherServlet.doDispatch() 호출
    ( 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(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);
    
}

 

 

2-3. Spring MVC 구조 동작 순서

 

 

 

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

 

 

2-4. 인터페이스 살펴보기

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

 

 


 

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

3-1. Controller 인터페이스의 구현 컨트롤러인 경우

 

1) Controller 인터페이스

과거 버전 스프링 컨트롤러

public interface Controller {

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

 

 

2) OldController (Controller 인터페이스 구현)

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

    ( 스프링 빈의 이름으로 URL을 요청("~~/springmvc/old-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;

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

 

 

3) 실행

  • http://localhost:8080/springmvc/old-controller

 

 

4) 컨트롤러가 호출(실행)되기 위해 필요한 HandlerMapping(핸들러 매핑), HandlerAdapter(핸들러 어댑터)

=> 스프링 부트가 자동 등록 !

  • HandlerMapping (핸들러 매핑)
    • 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 함
      (ex. '스프링 빈의 이름'으로 핸들러를 찾을 수 있는 핸들러 매핑 필요)
    • 순서대로 핸들러 조회
      0순위 - @RequestMapping이 있는지 먼저 찾음
      1순위 - 빈 이름으로 등록된 핸들러를 찾아서 실행
0 = RequestMappingHandlerMapping : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = BeanNameUrlHandlerMapping : 스프링 빈의 이름으로 핸들러를 찾는다.

 

  • HandlerAdapter (핸들러 어댑터)
    • 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터 필요
      (ex. Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행 필요)
0 = RequestMappingHandlerAdapter : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
1 = HttpRequestHandlerAdapter : HttpRequestHandler 처리
2 = SimpleControllerHandlerAdapter : Controller 인터페이스(애노테이션X, 과거에 사용) 처리

 

 

5) 실행 순서

 

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

 

6) 정리 - OldController 핸들러매핑, 어댑터

  • HandlerMapping : BeanNameUrlHandlerMapping 객체 사용
  • HandlerAdapter : SimpleControllerHandlerAdapter 객체 사용

 

 

 

3-2. HttpRequestHandler 인터페이스의 구현 컨트롤러인 경우

 

1) HttpRequestHandler 인터페이스

 

public interface HttpRequestHandler {

    void handleRequest(HttpServletRequest request, HttpServletResponse response)
    throws ServletException, IOException;
    
}

 

 

2) MyHttpRequestHandler (HttpRequestHandler 인터페이스 구현)

  • @Component("/springmvc/request-handler") : 스프링 빈에 등록, 빈의 이름으로 URL 매핑
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;

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

 

 

3) 실행

  • http://localhost:8080/springmvc/request-handler

 

 

4) 실행 순서 => 핸들러 매핑, 핸들러 어댑터 -> 스프링 부트가 자동 등록 !

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

 

 

5) 정리 - MyHttpRequestHandler 핸들러매핑, 어댑터

  • HandlerMapping : BeanNameUrlHandlerMapping 객체 사용
  • HandlerAdapter : HttpRequestHandlerAdapter 객체 사용

 

 


 

4. 뷰 리졸버

 

4-1. 뷰 리졸버 추가해보기

 

1) OldController - VIew를 조회할 수 있도록 return 값 변경

 

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;

@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");    // 논리이름
    }
}

 

 

2) 실행

  • http://localhost:8080/springmvc/old-controller
  • 컨트롤러는 정상 호출되지만, 웹 브라우저는 Whitelabel Error Page
  • application.properties prefix, suffix 추가 => 웹 브라우저 정상 출력
    • 뷰 리졸버 - InternalResourceViewResolve
      : 스프링 부트는 InternalResourceViewResolve라는 뷰 리졸버를 자동으로 등록하는데, 이때
      application.properties에 등록한 prefix, suffix 설정정보를 사용해서 등록함 !
spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

 

 

4-2. 뷰 리졸버 동작 방식

 

스프링 MVC 구조

 

1) 스프링 부트가 자동 등록하는 뷰 리졸버 (더 많음)

  • 1 = BeanNameVIewResolver : 빈 이름으로 뷰를 찾아서 반환 
  • 2 = InternalResourceViewResolve : JSP를 처리할 수 있는 뷰 반환

 

2) 동작 순서

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

 

 

💡 참고
InternalResourceViewResolver는 만약 JSTL 라이브러리가 있으면 InternalResourceView를 상속받은 JstlView 반환. JstlView는 JSTL 태그 사용시 약간의 부가기능 추가
💡 참고
JSP의 경우 forward()를 통해서 JSP로 이동(실행)해야 렌더링 됨
나머지 뷰 템플릿들은 forward() 없이 자바 코드로 바로 실제 뷰 렌더링
💡 참고
Thymeleaf 뷰 템플릿을 사용하면 ThymeleafViewResolver를 등록해야 함
근데 라이브러리만 추가하면 스프링부트에서 모두 자동화

 

 


 

5. 스프링 MVC - 시작하기

 

스프링은 어노테이션을 활용하여 매우 유연하고 실용적인 컨트롤러를 만듦

 

1) 어노테이션을 활용한 유연, 실용적인 컨트롤러

 

(1) @Controller 활용

  • 스프링이 자동으로 스프링 빈으로 등록
    : 원래 @Component가 하는데, @Controller의 내부에 컴포넌트 어노테이션이 포함되어 있어서, 컴포넌트 스캔의 대상이 됨 -> 스프링 빈의 이름으로 등록됨
  • 스프링 MVC에서 어노테이션 기반 컨트롤러(매핑시킬 수 있는 컨트롤러)로 인식
    : RequestMappingHandlerMapping이 아 얘는 매핑시킬 수 있는 컨트롤러구나하고 꺼낼 수 있는 대상이 됨 
    (스프링 3.0 이상부터는 RequestMappingHandlerMapping이 @Controller가 클래스 레벨에 붙어있어야만 매핑 컨트롤러로 인식함) 

 

(2) @RequestMapping 활용

  • URL 요청정보에 맞는 컨트롤러를 매핑, 실행 
  • 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터 (위에서 살펴봄)
    RequestMappingHandlerMapping
    RequestMappingHandlerAdapter
  • 해당 URL이 호출되면 이 메소드 호출 (어노테이션 기반으로 동작하기 때문에 메소드 이름은 임의로 지음)

 

 

2) 이전에 만들었던 컨트롤러를 @RequestMapping 기반의 스프링 MVC 컨트롤러로 변경하기

 

(1) SpringMemeberFormControllerV1 - 회원등록 컨트롤러

  • @Controller
  • @RequestMapping
    • 해당 URL이 호출되면 이 메소드 호출
  • ModelAndView
    • 모델과 뷰 정보를 담아서 반환

 

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

 

 

 

(2) SpringMemberSaveControllerV1 - 회원저장 컨트롤러

  • mv.addObject("member", member)
    • 스프링이 제공하는 ModelAndView 객체에 Model 데이터를 추가할 때는 addObject()를 사용해서 편리하게 추가

 

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 {

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

 

 

 

(3) 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 {

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

 

 


 

6. 스프링 MVC - 컨트롤러 통합 

 

@RequestMapping이 클래스 단위가 아니라 메소드 단위에 적용되어 있음

-> 클래스 단위에 붙여서 클래스를 하나로 통합 !

 

 

(1) SpringMemberControllerV2 - 클래스 통합

  • 회원가입, 저장, 목록 컨트롤러를 하나로 통합 
  • 중복되는 경로를 클래스 단위의 @RequestMapping(" ")에 넣어줌 

 

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;

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

    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
    public ModelAndView members() {

        List<Member> members = memberRepository.findAll();

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

        return mv;
    }
}

 

 


 

7. 스프링 MVC - 실용적인 방식 (실무 방식)

 

ModelAndView를 반환하지 X -> Model, @RequestParam, @GetMapping, @PostMapping 도입, ViewName 직접 반환

 

 

(1) SpringMemberControllerV3 

  • Model 파라미터
    • Model 객체에 데이터 담음
  • ViewName 직접 반환
    • 뷰의 논리 이름 직접 반환
  • @RequestParam
    • 요청파라미터를 받음
  • @GetMapping, @PostMapping
    • = @RequestMapping(value = "/new-form", method = RequestMethod.GET)

 

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.*;
import org.springframework.web.servlet.ModelAndView;

import java.util.List;

@Controller
@RequestMapping("/springmvc/v3/members")
public class SpringMemberControllerV3 {

    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) {

        // @RequestParam 으로 요청파라미터 받음
        Member member = new Member(username, age);
        memberRepository.save(member);

        // model에 member 객체 넣어줌
        model.addAttribute("member", member);

        // 뷰 이름 직접 반환
        return "save-result";
    }

    @GetMapping
    public String members(Model model) {

        List<Member> members = memberRepository.findAll();

        // model에 members 객체 넣어줌
        model.addAttribute("members", members);

        // 뷰 이름 직접 반환
        return "members";
    }
}