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

[Pracrobo]

스프링 MVC - 구조 이해

스프링 MVC 전체 구조

직접 만든 MVC 프레임워크와 스프링 MVC를 비교해보자

SpringMVC 구조

• 구조 자체는 똑같음

• 이름의 차이가 있다

• "직접 만든 프레임워크 -> 스프링 MVC 비교"

  • FrontController >> DispatcherServlet
  • handlerMappingMap >> HandlerMapping
  • MyHandlerAdapter >> HandlerAdapter
  • ModelView >> ModelAndView
  • viewResolver >> ViewResovler
  • MyView >> View

• 확장성있게 개발함

DispatcherServlet 서블릿 등록

• DispatcherServlet : Ctrl + V
• Spring MVC도 프론트 컨트롤러 패턴으로 구현되어있다.
• Spring MVC의 프론트 컨트롤러가 바로 디스패쳐 서블릿(DispatcherServlet)이다.
• 그리고 이 디스패쳐 서블릿이 바로 Spring MVC의 핵심이다.

DispatcherServlet 서블릿 등록

• DispatcherServlet > FrameworkServlet > HttpServletBean > HttpServlet
• DispatcherServlet도 그냥 서블릿이다.부모 클래스에서 HttpServlet을 상속 받아서 사용하고 서블릿으로 동작한다.
• doDisPatch
  • NotFounder :
  • HandlerAdapter 찾기, 실행
  • ModelAndView 반환됨
  • render 호출
  • ViewResolver를 통해서 View 객체를 찾아옴
  • View 랜더링

지금부터 DispatcherServlet의 핵심인 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.getHandle());
    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);
    }
    

동작순서

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

인터페이스 살펴보기

• Spring MVC의 강점은 DispatcherServlet코드의 변경없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다. 지금까지 설명한 대부분을 확장가능할 수 있게 인터페이스로 제공한다.
• 이 인터페이스들만 구현해서 DispathcerServlet에 등록하면 나만의 컨트롤러를 만들 수도 있다.

주요 인터페이스 목록

핸들러 매핑: 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;
 }

스프링도 처음에는 이런 딱딱한 형식의 컨트롤러를 제공했다.

• 참고 : Controller 인터페이스는 @Controller애노테이션과는 전혀 다르다

간단히 구현해보면,

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

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

실행

• http://localhost:8081/springmvc/old-controller
• 콘솔에 OldController.handleRequest이 출력되면 성공이다.

결과

HandlerMapping(핸들러 매핑)

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

HandlerAdapter(핸들러 어댑터)

• 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
• 예) Controller인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.

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

스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터
(실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략

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

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

2. 핸들러 어댑터 조회

   1. HandlerAdapter의 supports()를 순서대로 호출한다.
   2. SimpleControllerHandlerAdapter가 Controoler인터페이스를 지원하므로 대상이 된다.

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

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

• OldController를 실행하면서 사용된 객체는 다음과 같다.
• HandlerMapping = BeanNameUrlHandlerMapping
• HandlerAdapter = SimpleControllerHandlerAdapter

HttpRequestHandler

• 핸들러 매핑과, 어댑터를 더 잘 이해하기 위해 Controller인터페이스가 아닌 다른 핸들러를 알아보자.
• HttpRequestHandler핸들러(컨트롤러)는 서블릿과 가장 유사한 형태의 핸들러이다.

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

실행

• http://localhost:8080/springmvc/request-handler
• 웹 브라우저에 빈 화면이 나오고, 콘솔에 MyHttpRequestHandler.handleRequest가 출력되면 성공이다.

결과

순서

1. 핸들러 매핑으로 핸들러 조회
1) HandlerMapping을 순서대로 실행해서, 핸들러를 찾는다
2) 이 경우 빈 이름으로 핸들러를 찾아야 하기 때문에 이름 그대로 빈 이름으로 핸들러를 찾아주는 BeanNameUrlHandlerMapping가 싱행에 성공하고 핸들러인 MyHttpRequestHandler 를 반환한다.

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

3. 핸들러 어댑터 실행

1. 디스패처 서블릿이 조회한 HttpRequestHandlerAdapter를 실행하면서 핸들러 정보도 함께 넘겨준다.
2. HttpRequestHandlerAdapter는 핸들러인 MyHttpRequestHandler를 내부에서 실행하고 반환한다.

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

• MyHttpRequestHandler 를 실행하면서 핸사용된 객체는 다음과 같다.
• HandlerMapping = BeanNameUrlHandlerMapping
• HandlerAdapter = HttpRequestHandlerAdapter

@RequestMapping

• 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping, RequestMappingHandlerAdapter이다.
• RequestMappingHandlerMapping은 애노테이션에 있는 메타 URL 정보를 가지고 이 핸들러를 찾아준다.
• @RequestMapping의 앞글자를 따서 만든 이름인데 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다. 실무에서는 거의 이 컨트롤러를 사용한다.

ViewResolver, 뷰리졸버

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

View를 사용할 수 있도록 다음 코드를 추가했다.
return new ModelAndView("new-form");

실행

• http://localhost:8081/springmvc/old-controller
• 웹브라우저에 Whitelabel Error Page가 나오고 콘솔에 OldController.handleRequest가 출력된다.

결과

• ViewResolver를 만들어줘야 한다.

application.properties에 다음 코드를 추가

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

• 타임리프 의존성도 제거

• 스프링 부트는 InternalResourceViewResolver 라는 뷰 리졸버를 자동으로 등록하는데, 이때 application.properties에 등록한 spring.mvc.view.prefix, spring.mvc.view.suffix 설정 정보를 사용해서 등록한다.

• 참고로 권장하지는 않지만 설정 없이 다음과 같이 전체 경로를 주어도 동작하기는 한다
  return new ModelAndView("/WEB-INF/views/new-form.jsp");

실행

• http://localhost:8081/springmvc/old-controller
• 에러해결중...(06/22)

ViewResolver동작방식

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를 실행한다.

"참고"

• InternalResourceViewResolver는 만약 JSTL 라이브러리가 있으면 InternalResourceView를 상속받은 JstlView를 반환한다. JstlView는 JSTL 태그 사용시 약간의 부가기능이 추가된다.

• 다른 뷰는 실제 뷰를 랜더링하지만, JSP의 경우 forward()를 통해서 해당 JSP로 이동(실행)해야 랜더링이 된다. JSP를 제외한 나머지 뷰템플릿들은 forward()과정 없이 바로 랜더링 된다.

• Thymeleaf 뷰 템플릿을 사용하면 ThymelafViewResolver를 등록해야 한다. 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.

SpringMVC 시작하기

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

@RequestMapping

스프링은 애노테이션을 활용한 매우 유연하고 실용적인 컨트롤러를 만들었는데 이것이 바로 @RequestMapping애노테이션을 사용하는 컨트롤러이다.
여담이지만 과거에는 스프링 프레임워크가 MVC부분이 약해서 스프링을 사용하더라도 MVC 웹기술은 스트럿츠와 같은 프레임워크를 사용했었다. 그런데 @RequestMapping 기반의 애노테이션 컨트롤러가 등장하면서 MVC부분도 스프링을 거의 쓰게 되었다.

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

@RequestMapping

• RequestMappingHandlerMapping
• RequestMappingHandlerAdapter

앞서 보았듯이 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMAppingHandlerMapping,RequestMappingHandlerAdapter 이다.

• @RequestMapping 의 앞글자만 따서 만든 이름인데 이것이 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 핸들러 매핑과 어댑터이다.

@Controller

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

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

ModelAndView : 모델과 뷰 정보를 담아서 반환하면 된다.

RequestMappingHandlerMapping은 스프링 빈 중에서 @RequestMapping 또는 @Controller가 클래스 레벨ㄹ에 붙어 있는 경우에 매핑정보로 인식한다.

package hello.servlet.web.springmvc.v1;

import org.springframework.stereotype.Component;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Component // 빈으로 등러가기
@RequestMapping //handler Mapping을 찾아준다.
public class SpringMemberFormControllerV1 {

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

또는

@ServletComponentScan
@SpringBootApplication
public class ServletApplication {
    public static void main(String[] args) {SpringApplication.run(ServletApplication.class, args);
    }
    @Bean
    SpringMemberFormControllerV1 springMemberFormControllerV1() {
        return new SpringMemberFormControllerV1();
    
	}
}

package hello.servlet.web.springmvc.v1;

import hello.servlet.domain.Member;
import hello.servlet.domain.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 {

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

package hello.servlet.web.springmvc.v1;

import hello.servlet.domain.Member;
import hello.servlet.domain.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 {

    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;

    }
}

실행

• 등록 : http://localhost:8081/springmvc/v1/members/new-form
• 목록 : http://localhost8081/springmvc/v1/members

SpringMvC - 컨트롤러 통합

[6om1n]

아직 중간까지 밖에 안되어있네용 !! 마지막까지 파이팅입니다 ~~~ 😄