스프링 MVC 구조 이해

김민우·2022년 7월 29일
0

MVC

목록 보기
5/16
post-custom-banner

스프링 MVC 전체 구조

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

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

스프링 MVC 구조

직접 만든 프레임워크 -> 스프링 MVC

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

하나씩 알아보자.

DispatcherServlet 구조

DispatcherServlet를 살펴보면 HttpSerlvet을 상속받는 것을 알 수 있고, 서블릿으로 동작한다.
(DispatcherServlet -> FrameworkServlet -> HttpServletBean -> HttpServlet)

스프링 부트는 DispatcherServlet을 서블릿으로 자동 등록하고 모든 경로(urlPattern="/")에 대해 매핑 후 내장 톰켓 서버를 띄운다.
(참고로, 더 자세한 경로가 우선 순위가 높아서 기존에 등록한 서블릿이 동작한다.)

.
.
.
.
요청 흐름
서블릿이 호출이 되면 HttpServlet이 제공하는 service()메소드가 호출된다.
(참고로, 스프링 MVC는 DispatcherServlet의 부모 클래스 FrameworkServlet에서 service()메소드를 오버라이딩 해두었다.)

FrameworkServlet.service() 를 시작으로 여러 메서드가 호출되면서 DispacherServlet.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);
}
  1. 핸들러 조회
    핸들러 매핑을 통해 요청 URL에 매핑된 핸들러(컨트롤러)를 조회
  1. 핸들러 어댑터 조회
    핸들러를 실행할 수 있는 핸들러 어댑터를 조회
  1. 핸들러 어댑터 실행
    조회해서 얻은 핸들러 어댑터를 실행한다.
  1. 핸들러 실행
    핸들러 어댑터가 실제 핸들러를 실행한다.
  1. ModelAndView 리턴
    핸들러 어댑터는 핸들러가 리턴하는 정보를 ModelAndView로 변환해서 리턴한다. (V5과정과 동일)
  1. viewResolver 호출
    뷰 리졸버를 찾아 실행한다.
    (JSP의 경우에 InternalResourceViewResolver가 자동 등록 및 사용된다.)
  1. View 리턴
    뷰 리졸버는 뷰의 논리 이름을 실제 이름으로 바꾸고, 렌더링 역할을 담당하는 View 객체를 리턴한다.
    (JSP의 경우 InternalResourceView 또는 JstlView를 리턴하는데, 내부에 forward() 로직이 있다.)
  1. 뷰 렌더링
    뷰를 통해서 뷰를 렌더링한다.

스프링 MVC의 가장 큰 장점은 DispatchServlet 코드의 변경 없이, 원하는 기능을 변경하거나 확장할 수 있다는 점이다. 지금까지 설명한 대부분을 인터페이스로 제공하여 확장 가능할 수 있게 해준다.

따라서, 이 인터페이스들만 구현해서 DispatcherServlet에 등록하면 우리만의 컨트롤러를 만들 수 있다.

스프링 MVC는 코드 분량도 매우 많고, 복잡해서 내부 구조를 다 파악하는 것은 쉽지 않다. 사실 해당 기능을 직접 확장하거나 나만의 컨트롤러를 만드는 일은 없으므로 걱정하지 않아도 된다. 왜냐하면 스프링 MVC는 전세계 수 많은 개발자들의 요구사항에 맞추어 기능을 계속 확장해왔고, 그래서 여러분이 웹 애플리케이션을 만들 때 필요로 하는 대부분의 기능이 이미 다 구현되어 있다.
그래도 이렇게 핵심 동작방식을 알아두어야 향후 문제가 발생했을 때 어떤 부분에서 문제가 발생했는지 쉽게 파악하고, 문제를 해결할 수 있다. 그리고 확장 포인트가 필요할 때, 어떤 부분을 확장해야 할지 감을 잡을 수 있다. 실제 다른 컴포넌트를 제공하거나 기능을 확장하는 부분들은 강의를 진행하면서 조금씩 설명하겠다. 지금은 전체적인 구조가 이렇게 되어 있구나 하고 이해하면 된다.

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

핸들러 매핑과 핸들러 어댑터가 어떤 것들이 있는지 그리고 그것들이 어떻게 사용되는지 알아보자.

먼저, 과거에 주로 사용했지만 지금은 전혀 사용되지 않는 Controller 인터페이스를 통해 핸들러 매핑과 어댑터를 이해해보자.

Controller 인터페이스

public interface Controller {

	ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse
    response) throws Exception;
}
  • 참고로 우리가 아는 @Controller 어노테이션과는 전혀 다르다.

이를 간단히 구현해보자.

@Component("/springmvc/old-controller")
public class OldController implements Controller {

	@Override
   	public ModelAndView handleRequest(HttpServlet request, HttpServletResponse response) throws Exception {
    	
        System.out.println("OldController.handlerRequest");
        return null;
        
    }
}
  • @Component
    이 컨트롤러는 /springmvc/old-controller라는 이름의 스프링 빈으로 등록되었다.
  • 빈 이름으로 URL을 매핑할 것이다.

이 컨트롤러가 어떻게 호출될 수 있었을까? 이 컨트롤러가 호출되기 위해선 다음 2가지가 필요하다.

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

  • 스프링 부트가 자동 등록하는 핸들러 매핑

    • 0순위 : RequestMappingHandlerMapping
      애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
    • 1순위 : BeanNameUrlHandlerMapping
      스프링 빈의 이름으로 핸들러를 찾는다.
  1. HandlerAdapter(핸들러 어댑터)
  • 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
    (Controller인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다.)
  • 스프링 부트가 자동 등록하는 핸들러 어댑터
    • 0순위 : RequestMappingHandlerAdapter
      애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
    • 1순위 : HttpRequestHandlerAdapter
      HttpRequestHandler 처리
    • 2순위 : SimpleControllerHandlerAdapter
      Controller 인터페이스(애노테이션X, 과거에 사용)

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

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

이제 핸들러 매핑에서 OldController를 찾고 그 핸들러를 실행할 수 있는 어댑터가 실행되는 과정을 보자.

  1. @RequestMapping이 없으므로 0순위 생략.
  2. 빈 이름으로 핸들러를 찾는다. => OldController 리턴
  3. HandlerAdapter의 supports()를 순서대로 호출한다.
  4. SimpleControllerHandlerAdapter가 Controller인터페이스를 지원하므로 대상이 된다.
  5. DispatcherServlet이 조회한 SimpleControllerHandlerAdapter를 실행하면서 핸들러 정보도 함께 넘겨준다.
  6. SimpleControllerHandlerAdapter는 핸들러인 OldController를 내부에서 실행하고, 그 결과를 리턴한다.

OldController 를 실행하면서 사용된 객체는 다음과 같다.

  • HandlerMapping = BeanNameUrlHandlerMapping
  • HandlerAdapter = SimpleControllerHandlerAdapter

HttpRequestHandler

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

HttpRequestHandler

public interface HttpRequestHandler {
	void handleRequest(HttpServletRequest request, HttpServletResponse response)
               throws ServletException, 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을 순서대로 실행해서 핸들러를 찾는다.
  2. 빈 이름으로 핸들러를 찾는다. => OldController 리턴
  3. HandlerAdapter의 supports()를 순서대로 호출한다.
  4. HttpRequestHandlerAdapter 가 HttpRequestHandler인터페이스를 지원하므로 대상이 된다.
  5. DispatcherServlet이 조회한 HttpRequestHandlerAdapter를 실행하면서 핸들러 정보도 함께 넘겨준다.
  6. HttpRequestHandlerAdapter는 핸들러인 MyHttpRequestHandler를 내부에서 실행하고, 그 결과를 반환한다.

MyHttpRequestHandler를 실행하면서 사용된 객체는 다음과 같다.

  • HandlerMapping = BeanNameUrlHandlerMapping
  • HandlerAdapter = HttpRequestHandlerAdapter

@RequestMapping
조금 뒤에서 설명하겠지만, 가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping ,
RequestMappingHandlerAdapter 이다.
@RequestMapping 의 앞글자를 따서 만든 이름인데, 이것이 바로 지금 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다. 실무에서는 99.9% 이 방식의 컨트롤러를 사용한다.

뷰 리졸버

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

실행해보면 컨트롤러를 정상 호출되지만, Whitelabel Error Page 오류가 발생한다.
이를 해결하기 위해선 application.properties에 다음 코드를 추가해야 한다.

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

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

참고로 권장하지는 않지만 설정 없이 다음과 같이 전체 경로를 주어도 동작하기는 한다. 

return new ModelAndView("/WEB-INF/views/new-form.jsp");

.
.
.
.

뷰 리졸버 동작 방식
스프링 부트가 자동 등록하는 뷰 리졸버는 다음과 같다.
(실제로는 더 많지만, 중요한 부분 위주로 설명하기 위해 일부 생략)

1 = BeanNameViewResolver : 빈 이름으로 뷰를 찾아서 반환한다. (예: 엑셀 파일 생성 기능에 사용)
2 = InternalResourceViewResolver : JSP를 처리할 수 있는 뷰를 반환한다.
  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 뷰 템플릿을 사용하면 ThymeleafViewResolver 를 등록해야 한다. 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.

스프링 MVC

스프링이 제공하는 컨트롤러는 애노테이션 기반으로 동작해서, 매우 유연하고 실용적이다. 과거에는 자바 언어에 애노테이션이 없기도 했고, 스프링도 처음부터 이런 유연한 컨트롤러를 제공한 것은 아니다.

@RequestMapping

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

핸들러 매핑 : RequestMappingHandlerMapping
핸들러 어댑터 : RequestMappingHandlerAdapter

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

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

지금까지 만들었던 프레임워크에서 사용했던 컨트롤러를 @RequestMapping 기반의 스프링 MVC 컨트롤러 변경해보자.

SpringMemberFormControllerV1 - 회원 등록 폼

@Controller
public class SpringMemberFormControllerV1 {

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

SpringMemberSaveControllerV1 - 회원 저장

 @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 - 회원 목록

@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;
	}
}
  • @Controller
    • 스프링이 자동으로 스프링 빈으로 등록한다. (내부에 @Component 애노테이션이 있어서 컴포넌트 스캔의 대상이 됨)
    • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.
  • @RequestMapping
    • 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다. 애노테이션을 기반으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.
  • ModelAndView : 모델과 뷰 정보를 담아서 반환하면 된다.
  • mv.addObject("member", member)
    스프링이 제공하는 ModelAndView 를 통해 Model 데이터를 추가할 때는 addObject() 를 사용하면 된다. 이 데이터는 이후 뷰를 렌더링 할 때 사용된다.

잘 보면 @RequestMapping가 클래스 단위가 아니라 메소드 단위에 적용된 것을 볼 수 있다. 또한, 여기에 중복이 포함되있다. 따라서, 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.

SpringMemberControllerV2

/**
 * 클래스 단위->메서드 단위
 * @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;
	} 
}

참고로 컨트롤러 클래스를 통합하는 것을 넘어서 조합도 가능하다.
다음 코드는 /springmvc/v2/members 라는 부분에 중복이 있다.

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

물론 이렇게 사용해도 되지만, 컨트롤러를 통합한 예제 코드를 보면 중복을 어떻게 제거했는지 확인할 수 있다.
클래스 레벨에 다음과 같이 @RequestMapping 을 두면 메소드 레벨과 조합이 된다.

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

.
.
.
.
.

이전 V3에서 V4로 넘어가는 과정을 생각해보자. ModelView를 리턴하는 대신 논리 이름만 리턴하여 컨테이너 개발자 입장에서 매우 편리했다.
스프링 MVC는 개발자가 편리하게 개발할 수 있도록 수 많은 편의 기능을 제공한다.
실무에서는 지금부터 설명하는 방식을 주로 사용한다.

SpringMemberControllerV3

/**
 * 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으로 받을 수 있다.
    @RequestParam("username") 은 request.getParameter("username") 와 거의 같은 코드라 생각하면 된다.
    (물론 GET 쿼리 파라미터, POST Form 방식을 모두 지원한다.)

근데 이 방식은 요청 메소드가 GET, POST 구분 없이 URL만 매칭을 하는 것 처럼 보인다. 그러나, 이는 좋은 설계라 할 수 없다. GET, POST는 엄연히 역할이 구분되있기 때문에 이를 구분하여 설계하는 것이 좋다. 다음을 보자.

@RequestMapping => @GetMapping, @PostMapping

  • @RequestMapping 은 URL만 매칭하는 것이 아니라, HTTP Method도 함께 구분할 수 있다.
  • 예를 들어서 URL이 /new-form 이고, HTTP Method가 GET인 경우를 모두 만족하는 매핑을 하려면 다음과 같이 처리하면 된다.
@RequestMapping(value = "/new-form", method = RequestMethod.GET)
  • 이렇게 파라미터로 메소드를 명시해도 되지만 이조차 귀찮다.
    @GetMapping , @PostMapping 으로 더 편리하게 사용 가능하다!
    (참고로 Get, Post, Put, Delete, Patch 모두 애노테이션이 준비되어 있다.)
  • 이 어노테이션을 확인해보면 @RequestMapping이 포함되있는 것을 알 수 있다.
profile
김민우
이전 포스트

MVC 프레임워크 만들기

다음 포스트

스프링 MVC - 기본 기능

post-custom-banner

0개의 댓글