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

[chaelink]

섹션 5. 스프링 MVC - 구조 이해

1. 스프링 MVC 전체 구조

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

Spring MVC 구조

두 구조가 거의 동일한 것을 볼 수 있다!

직접 만든 MVC 프레임워크	Spring MVC
FrontController	DispatcherServlet
handlerMappingMap	HandlerMapping
MyHandlerAdapter	HandlerAdapter
ModelView	ModelAndView
viewResolver	ViewResolver
MyView	View

DispatcherServlet 구조 살펴보기

org.springframework.web.servlet.DispatcherServlet

• 스프링 mvc도 프론트 컨트롤러 패턴으로 구현됨
• 스프링 mvc의 프론트 컨트롤러가 바로 디스패처 서블릿
• 디스패처 서블릿이 스프링 mvc의 핵심!

DispatcherServlet 서블릿 등록

• 부모 클래스에서 HttpServlet 을 상속 받아 사용, 서블릿으로 동작

  • DispatcherServlet -> FrameworkServlet -> HttpServletBean -> HttpServlet

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

  • 더 자세한 경로가 높은 우선 순위를 갖는다, 기존에 등록한 서블릿도 함께 동작

요청 흐름

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

doDispatch() 를 분석한 동작 순서

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`

정리 : 스프링 MVC는 분량이 많고 복잡하여 모두 파악하기는 쉽지 않다. 또한, 이미 대부분의 기능이 구현되어 있어 나만의 컨트롤러를 만들일은 없다. 하지만 동작 방식을 알아두어야 향후 문제가 발생했을 때 발생 지점을 파악하고 해결하기 용이하다, 확장 포인트에 대한 감을 잡을 수 있다.

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

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

Controller 인터페이스

과거 버전 스프링 Controller

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

 }

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

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 매핑

OldController가 호출 될 수 있는 이유는?

1. HandlerMapping (핸들러 매핑)

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

2. HandlerAdapter (핸들러 어댑터)

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

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

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

   • BeanNameUrlHandlerMapping 가 실행 성공, 핸들러인 OldController 반환

2. 핸들러 어댑터 조회

   • Controller 인터페이스를 지원하는 SimpleControllerHandlerAdapter가 대상이 됨

3. 핸들러 어댑터 실행

   • 디스패처 서블릿이 조회한 SimpleControllerHandlerAdapter 실행, 핸들러 정보도 넘겨줌
   • SimpleControllerHandlerAdapter는 핸들러인 OldController 를 내부에서 실행, 결과 반환

HttpRequestHandler

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

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. 핸들러 매핑으로 핸들러 조회

   • BeanNameUrlHandlerMapping 가 실행 성공, 핸들러인 MyHttpRequestHandler반환

2. 핸들러 어댑터 조회

   • HttpRequestHandler 인터페이스를 지원하는 HttpRequestHandlerAdapter가 대상이 됨

3. 핸들러 어댑터 실행

   • 디스패처 서블릿이 조회한 HttpRequestHandlerAdapter 실행, 핸들러 정보도 넘겨줌
   • HttpRequestHandlerAdapter는 핸들러인 MyHttpRequestHandler를 내부에서 실행, 결과 반환

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

3. 뷰 리졸버

OldController - view를 조회할 수 있도록 변경

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

return new ModelAndView("new-form"); 코드를 추가하였다

실행

• localhost:8080/springmvc/old-controller 를 실행
• 컨트롤러는 정상 동작하지만 웹 브라우저에는 Whitelabel Error Page 가 뜬다

실행 - 해결방법

1. application.propertires 에 코드 추가하기

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

InternalResourceViewResolver (뷰 리졸버)

• 스프링 부트가 자동 등록하는 뷰 리졸버
• application.propertires 에 등록한 설정 정보 사용

뷰 리졸버 동작 방식

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

1 = BeanNameViewResolver         : 빈 이름으로 뷰를 찾아서 반환한다. (예: 엑셀 파일 생성 기능에 사용)
 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 실행

참고(JSRL)
InternalResourceViewResolver 는 만약 JSTL 라이브러리가 있으면 InternalResourceView를 상속받은 JstlView 반환, JSTL 태그 사용시 약간의 부가 기능이 추가됨

참고
JSP가 아닌 다른 뷰 템플릿들은 forward() 과정 없이 바로 렌더링 됨

참고(Thymleaf)
타임리프 뷰 템플릿은 ThymeleafViewResolver 를 등록해야한다. 최근에는 라이브러리만 추가하면 스프링부트가 모두 자동화해준다

4. 스프링 MVC - 시작하기

@RequestMapping

스프링이 만든, 애노테이션을 활용한 매우 유연하고 실용적인 컨트롤러

• @RequestMapping

  • RequestMappingHandlerMapping
  • RequestMappingHandlerAdapter

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

• 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 방식, 실무에서 대부분 사용

회원 등록 폼 변경

@Controller
 public class SpringMemberFormControllerV1 {

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

• @Controller

  • 스프링이 자동으로 스프링 빈에 등록(내부에 컴포넌트 애노테이션이 있음)
  • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식

• @RequestMapping

  • 요청 정보 매핑, 해당 URL이 호출되면 이 메서드가 호출된다
  • 애노테이션 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다

• ModelAndView

  • 모델과 뷰 정보를 담아서 반환

회원 저장 변경

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

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

회원 목록 변경

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

5. 스프링 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;
    }
}

기존의 중복이 있는 코드

• @RequestMapping("/springmvc/v2/members/new-form")
• @RequestMapping("/springmvc/v2/members")
• @RequestMapping("/springmvc/v2/members/save")

컨트롤러를 통합하여 중복 제거

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

• 클래스 레벨 @RequestMapping("/springmvc/v2/members")
  • 메서드 레벨 @RequestMapping("/new-form")
  • 메서드 레벨 @RequestMapping("/save")
  • 메서드 레벨 @RequestMapping

6. 스프링 MVC - 실용적인 방식

과거에는 개발자가 직접 ModelView 를 생성해서 반환하였으나, 스프링 MVC는 개발자의 편리한 개발을 위해 많은 편의 기능을 제공한다

/**
 * 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 으로 받을 수 있다.

@RequestMapping -> @GetMapping, @PostMapping

• @RequestMapping 은 다음과 같은 방식으로 HTTP METHOD를 구분할 수 있다
  • @RequestMapping(value = "/new-form", method = RequestMethod.GET)
• 이는 @GetMapping, @PostMapping 으로 더 편리하게 사용할 수 있다
  • 내부에 @RequestMapping 애노테이션을 가지고 있다

[6om1n]

마지막까지 더 파이팅입니다 ~~! 중간에 표로 정리되어있는 부분이 깔끔하네요 👍

[chaelink]

감사합니당~ 표 열심히 만들었는데 알아봐주시니 행복하네욤ㅎㅎ