Spring MVC 구조 이해

Spring MVC의 전체적인 구조와 핵심 동작 방식을 알아야,

향후 문제가 발생했을 때 대처가 가능하고, 확장 포인트가 필요할 때 감을 잡을 수 있다.

---

1. 전체 구조와 동작 순서

Spring MVC 전체 구조

직접 만든 MVC 프레임워크와 구조가 동일하다

동작 순서

프론트 컨트롤러가 핸들러를 찾아 어댑터로 실행하고, 반환 결과로 뷰를 렌더링한다.

1. 핸들러 조회 : 핸들러 매핑을 통해 URL에 매핑된 핸들러(컨트롤러) 조회
2. 어댑터 조회 : 핸들러를 실행할 수 있는 핸들러 어댑터 조회
3. 어댑터 실행 : 프론트 컨트롤러(Dispatcher Servlet)에서 인터페이스(어탭터)를 통해
4. 핸들러 실행 : 핸들러를 실행하고, 어댑터는 반환 정보를 프론트 컨트롤러에서 일괄 처리할 수 있는
5. ModelAndView 반환 : ModelAndView로 변환해서 반환한다.
6. viewResolver 호출 : 뷰 리졸버(IF)는 뷰의 논리 이름을 물리 이름으로 바꾸고, 렌더링 역할을 담당하는 뷰 객체 반환
7. View 반환 : ※ JSP의 경우 InternalResourceView(JstlView)를 반환하는데, 내부에 forward() 로직이 있다
8. 뷰 렌더링 : 뷰를 통해서 뷰를 렌더링한다

---

 

2. DispatcherServlet

스프링 MVC도 프론트 컨트롤러 패턴으로 구현되어 있으며  프론트 컨트롤러가 바로 디스패처 서블릿이다.

org.springframework.web.servlet.DispatcherServlet

DispatcherServlet 등록

DispatcherServlet도 결국 HttpServlet을 상속 받아 서블릿으로 동작한다.

스프링 부트는 DispatcherServlet을 서블릿으로 자동 등록하면서 모든 경로(urlPatterns="/')에 대해 매핑한다.

※ 더 자세한 경로가 우선순위가 높다. 그래서 기존에 직접 만들어 등록한 프론트컨트롤러 서블릿이 우선순위가 높다.

요청 흐름

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

DispacherServlet 의 핵심인 doDispatch() 코드 분석

DispacherServlet.doDispatch()

 

---

 

3. 주요 인터페이스

스프링 MVC의 큰 강점은,

대부분을 확장 가능할 수 있게 인터페이스로 제공하기 때문에

DispatcherServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다.

이 인터페이스들만 구현해서 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. @Controller가 아니다.

org.springframework.web.HttpRequestHandler

 

정상적으로 로그가 남는다.

그런데 핸들러를 어떻게 찾았고, 어떻게 실행될 수 있었을까?

 

어떤 종류의 컨트롤러이든, 호출되려면 다음 2가지가 필요하다.

다양한 핸들러별로 아래 인터페이스의 구현체들이 지원된다.

• HandlerMapping - 각 요청에 따른 핸들러를 매핑해준다.
  위 경우 빈 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요.
• HandlerAdapter - 찾은 핸들러를 실행할 수 있는 어댑터가 필요하다
  위 경우 Controller 인터페이스, HttpRequestHandler 인터페이스를 실행할 수 있는 어탭터가 필요.
  

스프링 부트가 빈으로 자동 등록하는 핸들러 매핑 / 어댑터 구현체들

핸들러 매핑도, 핸들러 어댑터도 모두 순서대로 찾고 만약 없으면 다음 순서로 넘어간다

 

HandlerMapping

DispatcherServlet의 doDispatch()에서 getHandler()할 때 활용되는 인터페이스

DispatcherServlet 클래스의 필드

핸들러 매핑이 인터페이스로 구성되어, 여러 핸들러 매핑 방식을 처리 가능!

(실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략)

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

BeanNameUrlHandlerMapping 도 HandlerMapping을 상속 받음

 

 

HandlerAdapter

DispatcherServlet의 doDispatch()에서 getHandlerAdapter()할 때 활용되는 인터페이스

DispatcherServlet 클래스의 필드

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

SimpleControllerHandlerAdapter 도 HandlerAdapter의 구현체

 

동작 순서

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

1. HandlerMapping 을 순서대로 실행해서, 핸들러를 찾는다.

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

DispatcherServlet.getHandler()

2. 핸들러 어댑터 조회

1. HandlerAdapter 의 supports() 를 순서대로 호출한다.

2. SimpleControllerHandlerAdapter 가 Controller 인터페이스를 지원하므로 대상이 된다.

DispatcherServlet.getHandlerAdapter()

3. 핸들러 어댑터 실행

1. 디스패처 서블릿이 조회한 SimpleControllerHandlerAdapter 를 실행하면서 핸들러 정보도 함께 넘겨준다.

2. SimpleControllerHandlerAdapter 는 핸들러인 OldController 를 내부에서 실행하고, 그 결과를 반환한다

DispatcherServlet.doDispatch()

 

 

---

뷰 리졸버

핸들러 어댑터가 반환한 ModelAndView를 기반으로 ViewResolver가 View를 반환하고, View가 뷰를 렌더링한다.

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

뷰 이름을 return했을 뿐인데 어떻게 view를 찾고 실행했을까?

=> 각 뷰 타입에 맞는 뷰 리졸버, 뷰 인터페이스 구현체가 있다.

...
1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다. (예: 엑셀 파일 생성 기능에 사용)
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다
...
(실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략)

 

 

뷰 리졸버 - InternalResourceViewResolver

스프링 부트는 InternalResourceViewResolver 라는 뷰 리졸버를 자동으로 등록하는데,

이때 application.properties 에 등록한 spring.mvc.view.prefix , spring.mvc.view.suffix 설정 정보를 사용해서 등록한다.

 

동작 방식

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

2. 논리 뷰 이름으로 viewResolver를 순서대로 호출한다.

     BeanNameViewResolver 는 뷰 이름의 스프링 빈으로 등록된 뷰를 찾아야 하는데 없어서 InternalResourceViewResolver 가 호출됨

3. InternalResourceViewResolver 는 InternalResourceView 를 반환한다.

4. InternalResourceView 는 JSP처럼 포워드 forward() 를 호출해서 처리할 수 있는 경우에 사용한다.

5. view.render() 가 호출되고 InternalResourceView 는 forward() 를 사용해서 JSP를 실행한다

 

참고
JSP의 경우 forward() 통해서 해당 JSP로 이동(실행)해야 렌더링이 된다.
JSP를 제외한 나머지 뷰 템플릿들은 forward() 과정 없이 바로 렌더링 된다. (Java로 response에 html 코드 생성)
Thymeleaf 뷰 템플릿을 사용하면 ThymeleafViewResolver 를 등록해야 한다. 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.

 

 

 

 

---

 

 

4. Spring MVC 사용하기

스프링은 애노테이션을 활용한 매우 유연하고, 실용적인 컨트롤러를 만들었는데

이것이 바로 @RequestMapping 애노테이션을 사용하는 컨트롤러이다

---

@RequestMapping 기반의 @Controller

@Controller

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

@RequestMapping 

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

▷ RequestMappingHandlerMapping, RequestMappingHandlerAdapter 

• 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터
• RequestMappingHandlerMapping 은 @RequestMapping 또는 @Controller 가
  클래스 레벨에 붙어 있는 경우에 핸들러로 인식 (보통 클래스에 @Controller, 메소드에 @RequestMapping)

RequestMappingHandlerMapping 의 isHandler 메소드

 

활용 - v1. 컨트롤러 통합과 URL 조합

• @RequestMapping 은 메서드 단위에도 적용되므로 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.
• URL에 중복이 있으므로 클래스 레벨에 @RequestMapping을 두면 메서드 레벨과 URL 조합이 된다.

예시 코드

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

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

    //springmvc/v2/members
    @RequestMapping
    public ModelAndView members() {
        List<Member> members = memberRepository.findAll();

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

활용 - v2. 실용적인 방식

• ModelAndView를 직접 생성해서 반환. 번거롭고, 중복 코드 → ViewName 직접 반환
  어댑터와 인터페이스 기반이기에 가능한 일!
• 요청 파라미터 파싱의 번거로움 → 메소드 파리미터로 받기 : @RequestParam
• HTTP Method 구분 → 용도에 맞게 제한 : @GetMapping, @PostMapping

예시 코드

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

    private final MemberRepository memberRepository = MemberRepository.getInstance();

    //@RequestMapping(value = "/new-form", method = RequestMethod.GET)
    @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";
    }

    //springmvc/v2/members
    @GetMapping
    public String members(Model model) {
        List<Member> members = memberRepository.findAll();

        model.addAttribute("members", members);
        return "members";
    }
}​

 

 

 

 

 

 

 

---

 

참고 자료 & 이미지 출처
스프링 MVC 1편(김영한 님)