스프링 MVC 1편 - Ch05. 스프링 MVC - 구조 이해

목록

1. 포스팅 개요
2. 본론
     2-1. 스프링 MVC 전체 구조
     2-2. 핸들러 매핑과 핸들러 어댑터
     2-3. 뷰 리졸버
     2-4. 스프링 MVC - 시작하기
     2-5. 스프링 MVC - 컨트롤러 통합
     2-6. 스프링 MVC - 실용적인 방식
3. 요약

1. 포스팅 개요

인프런에서 영한님의 스프링 MVC 1편 Section 05 스프링 MVC - 구조 이해를 학습하며 정리한 포스팅이다.

직접 MVC를 만든 것과 스프링 MVC의 구조를 비교해볼 것이다.

2. 본론

2-1. 스프링 MVC 전체 구조

다음은 직접 만든 MVC와 스프링 MVC의 구조다.

• 직접 만든 MVC

• 스프링 MVC

보면 그냥 똑같다.

이름에서 차이는 있겠지만, 구조는 똑같다.
직접 만든 MVC의 요소와 매핑되는 스프링 MVC의 요소는 다음과 같다.

• FrontController -> DispatcherServlet
• handlerMappingMap -> HandlerMapping
• MyHandlerAdapter -> HandlerAdapter
• ModelView -> ModelAndView
• viewResolver -> ViewResolver
  • 참고로 스프링은 ViewResolver를 인터페이스로 만들어놨다.
  • 더 확장성이 있다.
• MyView -> View

DispatcherServlet 구조 살펴보기

org.springframework.web.servlet.DispatcherServlet에서 DispatcherServlet의 구조를 살필 수 있다.

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

DispatcherServlet 서블릿 등록

• DispatcherServlet 도 부모 클래스에서 HttpServlet 을 상속 받아서 사용하고, 서블릿으로 동작한다.
  • DispatcherServlet -> FrameworkServlet -> HttpServletBean -> HttpServlet
• 스프링 부트는 내장 톰켓을 실행할 때DispatcherServlet 을 서블릿으로 자동으로 등록하면서 톰켓을 띄운다. 그리고 자동등록할 때 모든 경로(urlPatterns="/")에 대해서 매핑한다.
  • 참고로 더 자세한 경로가 우선순위가 높다. 그래서 기존에 등록한 서블릿도 함께 동작한다.

클래스 이름에 우클릭을 하고, Diagram 에서 Show Diagram..을 클릭하면 다이어그램과 같이 클ㄹ래스 상속관계를 볼 수 있다.

DispatcehrServlet도 결국은 HttpServlet을 상속 받고 있다.

요청 흐름

• 서블릿이 호출되면 HttpServlet이 제공하는 service()가 호출된다.
• 스프링 MVC는 DispatcherServlet 의 부모인 FrameworkServlet 에서 service() 를 오버라이드 해두었다.

• FrameworkServlet.service() 를 시작으로 여러 메서드가 호출되면서 DispatcherServlet.doDispatch() 가 호출된다.

doDispatche() 의 코드는 다음과 같다.
FrontController 동작방식과 정말 유사하다.

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

}

• Spring MVC 구조

동작 순서는 다음과 같다.

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

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

핸들러 매핑과 핸들러 어댑터가 어떤 것들이 어떻게 사용되는지 알아보자
지금은 전혀 사용하지 않지만, 과거에 주로 사용했던 스프링이 제공하는 간단한 컨트롤러로 핸들러 매핑과 어댑터를 이해해본다.

Controller 인터페이스

과거 버전의 스프링 컨트롤러

org.springframework.web.servlet.mvc.Contoller 이다.

참고로 Controller 인터페이스는 @Controller 애너테이션과는 전혀 다르다.

간단하게 구현해본다.

servlet/web/springmvc/old에서 OldController를 작성한다.

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

참고로 구현하고 있는 Controller는 애너테이션이 아니라 인터페이스이다.

@Component 의 속성을 보면 "/springmvc/old-controller" 로 했는데, 스프링 빈의 이름을 url 패턴으로 맞춘 것이다.
빈의 이름으로 URL을 매핑할 것이다.

localhost:8080/springmvc/old-controller로 url을 입력하면 handleRequest() 메서드가 실행된다.

이처럼 OldController가 호출된 것이다.

컨트롤러의 호출되려면 다음 2가지가 필요하다.

• HandlerMapping(핸들러 매핑)
  • 핸들러 매핑에서 이 컨트롤러를 찾을 수 있어야 한다.
  • 예) 스프링 빈의 이름으로 핸들러를 찾을 수 있는 핸들러 매핑이 필요하다.
  • @Component의 속성의 값으로 url 패턴으로 스프링 빈의 이름을 지정했는데, 그 컨트롤러를 찾을 수 있어야 한다는 것이다.
• HandlerAdapter(핸들러 어댑터)
  • 핸들러 매핑을 통해서 찾은 핸들러를 실행할 수 있는 핸들러 어댑터가 필요하다.
  • 예) Controller 인터페이스를 실행할 수 있는 핸들러 어댑터를 찾고 실행해야 한다

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

스프링 부트가 자동 등록하는 핸들러 매핑과 핸들러 어댑터

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

• HandlerMapping
  • 0순위 : RequestMappingHandlerMapping : 애노테이션 기반의 컨트롤러인 @RequestMapping 에서 사용
  • 1순위 : BeanNameUrlHandlerMapping : 스프링 빈의 이름으로 핸들러를 찾는다.
    • OldController가 이걸로 처리된 것이다.
• HandlerAdapter\
  • 0순위 : RequestMappingHandlerAdapter : 애노테이션 기반의 컨트롤러인 @RequestMapping에서 사용
  • 1순위 : HttpRequestHandlerAdapter : HttpRequestHandler 처리
  • 2순위 SimpleControllerHandlerAdapter ; Controller 인터페이스(애노테이션X, 과거에 사용한 것) 처리
    • OldController가 어것으로 처리되었다.

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

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

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

2. 핸들러 어댑터 조회

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

3. 핸들러 어댑터 실행

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

HttpRequestHandler

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

package org.springframework.web;  

import jakarta.servlet.ServletException;  
import jakarta.servlet.http.HttpServletRequest;  
import jakarta.servlet.http.HttpServletResponse;  
import java.io.IOException;  

@FunctionalInterface  
public interface HttpRequestHandler {  
    void handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;  
}

이 인터페이스의 구현체를 작성해보자.

servlet.web.springmvc.old에서 MyHttpRequestHandler라는 이름의 클래스를 작성한다.

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

서버 실행 후, localhost:8080/springmvc/request-handler 로 url을 입력해보자.

호출되었음을 알 수 있다.

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

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

2. 핸들러 어댑터 조회

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

3. 핸들러 어댑터 실행

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

가장 우선순위가 높은 핸들러 매핑과 핸들러 어댑터는 RequestMappingHandlerMapping, RequestMappingHandlerAdapter 이다.
@RequestMapping 의 앞글자를 따서 만든 이름인데, 현재 스프링에서 주로 사용하는 애노테이션 기반의 컨트롤러를 지원하는 매핑과 어댑터이다.

2-3. 뷰 리졸버

이번에는 뷰 리졸버에 대해서 자세히 알아본다.

방금 만들었던 OldController에서 View를 조회할 수 있도록 코드를 변경한다.

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

서버를 실행하고, url 을 입력하면 위와 같이 오류페이지가 나오지만, 코드가 호출되었음을 알 수 있다.

view를 못 찾기 때문에 오류페이지가 나왔는데, 찾을 수 있도록 해주면 된다.

현재 스프링 부트를 쓰고 있기 때문에, src/resources의 application.yml(혹은 properties)에서 다음과 같이 해주면 된다.

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

그리고 다시 서버를 실행 시키고, url을 다시 입력해보면 form이 나온다.

참고로 값을 넣고 전송하면 save로 매핑되는데, 현재 save와는 매핑되어있지 않기 때문에 오류페이지가 나온다.

스프링 부트는 InternalResourceViewResolver 라는 뷰 리졸버를 자동으로 등록한다.
이때 application.properties(혹은 yml) 에 등록한 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 를 등록해야 한다.
  • 최근에는 라이브러리만 추가하면 스프링 부트가 이런 작업도 모두 자동화해준다.

2-4. 스프링 MVC - 시작하기

@RequestMapping

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

@RequestMapping

• RequestMappingHandlerMapping
• RequestMappingHandlerAdapter

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

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

servlet/web/springmvc/v1에서 SpringMemberFormControllerV1 클래스를 작성한다.

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

서버를 실행하고, url에 localhost:8080/springmvc/v1/members/new-form를 입력하면 다음과 같이 나온다.

잘 호출된 것이다.

• @Controller
  • 스프링이 자동으로 스프링 빈으로 등록한다. (내부에 @Component 애노테이션이 있어서 컴포넌트 스캔의 대상이 됨)
  • 스프링 MVC에서 애노테이션 기반 컨트롤러로 인식한다.
• @RequestMapping
  • 요청 정보를 매핑한다. 해당 URL이 호출되면 이 메서드가 호출된다. 애노테이션을 기반 으로 동작하기 때문에, 메서드의 이름은 임의로 지으면 된다.
• ModelAndView
  • 모델과 뷰 정보를 담아서 반환하면 된다.

RequestMappingHandlerMapping은 스프링 빈 중에서 @RequestMapping 또는 @Controller 가 클래스 레벨에 붙어 있는 경우에 매핑 정보로 인식한다.
따라서 다음 코드도 동일하게 동작한다.

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

@Component // 컴포넌트 스캔을 통해 스프링 빈으로 등록 
@RequestMapping
public class SpringMemberFormControllerV1 {  

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

참고로 스프링 부트가 3.0 이상 버전이라면, 위의 코드는 동작하지 않는다.

스프링 부트 3.0(스프링 프레임워크 6.0)부터는 클래스 레벨에@RequestMapping 이 있어도 스프링 컨트롤러로 인식하지 않는다.
오직 @Controller 가 있어야 스프링 컨트롤러로 인식한다.

참고로 @RestController 는 해당 애너테이션 내부에 @Controller 를 포함하고 있으므로 인식된다.
따라서 @Controller 가 없는 위의 코드는 스프링 컨트롤러로 인식되지 않는다. (RequestMappingHandlerMapping 에서 @RequestMapping 는 이제 인식하지 않고, Controller 만 인식한다.)

참고로 스프링 부트가 3.0 이전 버전이라면, 빈 등록을 할 때 다음과 같이하면 된다.
ServletApplication.class(서버 실행 클래스)에서 등록한다.

//스프링 빈 직접 등록 
@Bean 
SpringMemberFormControllerV1 springMemberFormControllerV1() { 
    return new SpringMemberFormControllerV1(); 
}

나머지 코드도 추가해보자.

회원 저장을 하는 Controller이다.
같은 패키지에 SpringMemberSaveControllerV1 클래스를 다음과 같이 작성한다.

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 spring.servlet.domain.member.Member;  
import spring.servlet.domain.member.MemberRepository;  

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

}

회원 목록을 호출하는 Controller이다.
같은 패키지에 SpringMemberListControllerV1 클래스를 다음과 같이 작성한다.

import org.springframework.stereotype.Controller;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.servlet.ModelAndView;  
import spring.servlet.domain.member.Member;  
import spring.servlet.domain.member.MemberRepository;  

import java.util.List;  

@Controller  
public class SpringMemberListControllerV1 {  

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

    }  

}

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

서버를 실행하고 확인해보면 잘 나오는 것을 볼 수 있다.

참고로 localhost:8080의 페이지에서 SpringControllerV1 쪽이다.

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

@RequestMapping 을 잘 보면 클래스 단위가 아니라 메서드 단위에 적용된 것을 확인할 수 있다.
따라서 컨트롤러 클래스를 유연하게 하나로 통합할 수 있다.

servlet/web/springmvc/v2 패키지에서 SpringMemberControllerV2 클래스를 작섷해보자.

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 spring.servlet.domain.member.Member;  
import spring.servlet.domain.member.MemberRepository;  

import java.util.List;  

@Controller  
public class SpringMemberControllerV2 {  

    private MemberRepository memberRepository = MemberRepository.getInstance();  

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


    @RequestMapping("/springmvc/v2/members/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("/springmvc/v2/members")  
    public ModelAndView members() {  
        List<Member> members = memberRepository.findAll();  

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

        return mv;  

    }  
}

서버를 실행하고, localhost:8080에서 SpringMVC의 V2 쪽을 살펴보자.

잘 나오는 것을 확인할 수 있다.

컨트롤러 클래스를 통합하는 것을 넘어서 조합도 가능하다.
다음 코드는 /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 {...}

클래스 레벨에서 @RequestMapping("/springmvc/v2/members") 이렇게 선언함으로써 메서드 레벨에선 다음과 같이 간단하게 작성가능해졌다.

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

서버를 실행하면 앞전과 같이 기능이 제대로 동작하는 것을 확인할 수 있다.

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

MVC 프레임워크 만들기에서 v3은 ModelView를 개발자가 직접 생성해서 반환했기 때문에, 불편했다. 물론 v4를 만들면서 실용적으로 개선하기도 했다.

스프링 MVC는 개발자가 편리하게 개발할 수 있도록 수 많은 편의 기능을 제공한다.
실무에서는 다음 방식을 주로 사용한다.

servlet/web/springmvc/v3 패키지에서 SpringMemberControllerV3 클래스를 다음과 같이 작성한다.

import org.springframework.stereotype.Controller;  
import org.springframework.ui.Model;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RequestParam;  
import spring.servlet.domain.member.Member;  
import spring.servlet.domain.member.MemberRepository;  

import java.util.List;  

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

    private MemberRepository memberRepository = MemberRepository.getInstance();  

    @RequestMapping("/new-form")  
    public String newForm() {  
        return "new-form";  
    }  


    @RequestMapping("/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";  
    }  


    @RequestMapping  
    public String members(Model model) {  
        List<Member> members = memberRepository.findAll();  

        model.addAttribute("members", members);  

        return "members";  
    }  
}

서버를 실행하고, localhost:8080에서 SpringMVC 의 V3을 확인해보자.

Model 파라미터

• save() , members() 를 보면 Model을 파라미터로 받는 것을 확인할 수 있다.
• 스프링 MVC도 이런 편의 기능을 제 공한다.

ViewName 직접 반환

• 뷰의 논리 이름을 반환할 수 있다

@RequestParam 사용

• 스프링은 HTTP 요청 파라미터를 @RequestParam 으로 받을 수 있다.
• @RequestParam("username") 은 request.getParameter("username") 와 거의 같은 코드라 생각하면 된다.
• 물론 GET 쿼리 파라미터, POST Form 방식을 모두 지원한다

그런데 지금까지 HTTP 메서드를 구분하지 않았다.
즉, GET, POST 매핑을 구분하지 않은 것이다.

현재까지의 매핑은 GET이든, POST이든 어떤 것으로 와도 상관이 없었다.
하지만 이런 방식은 그다지 좋은 개발은 아니다.
따라서 GET과 POST를 분리해야한다.

list같은 경우는 GET, save 같은 경우는 POST로 받도록 한다.

newForm 같은 경우, GET이든 POST이든 어떤 매핑이 들어와도 상관이 없었다.

그런데, 다음과 같이 HTTP 메서드를 GET으로 지정하면 GET 매핑만 받을 수 있다.

@RequestMapping(value = "/new-form", method = RequestMethod.GET)  
public String newForm() {  
    return "new-form";  
}

save는 POST로 변경한다.

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

list는 GET으로 지정하면 된다.

@RequestMapping(method = RequestMethod.GET)  
public String members(Model model) {  
    List<Member> members = memberRepository.findAll();  

    model.addAttribute("members", members);  

    return "members";  
}

그런데 HTTP 매핑 메서드를 더욱 더 간결하게 할 수 있다.

POST 같은 경우 @RequestMapping(value = "/save", method = RequestMethod.POST) 를 @PostMapping("/save")으로,
GET 같은 경우 @RequestMapping(value = "/new-form", method = RequestMethod.GET), @RequestMapping(method = RequestMethod.GET) 를 @GetMapping("/new-form"), @GetMapping으로 할 수 있다.

완성된 코드는 다음과 같다.

import org.springframework.stereotype.Controller;  
import org.springframework.ui.Model;  
import org.springframework.web.bind.annotation.*;  
import spring.servlet.domain.member.Member;  
import spring.servlet.domain.member.MemberRepository;  

import java.util.List;  

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

@GetMapping, @PostMapping 의 소스에는 @RequestMapping이 있음을 확인할 수 있다.

3. 요약

이전에 Servlet을 이용해서 만들었던 FrontController 의 기능을 이미 스프링에서는 DispatcherServlet 이라는 서블릿이 만들어져있었다.

그리고 이제까지 했던 것을 Spring을 이용해서 개선해보았다.

Model, RequestMapping, PostMapping, GetMapping 등등을 알아보면서 스프링이 제공하는 기능들을 사용하면서 훨씬 간편하게 Controller 클래스를 작성해봤다.

또한 스프링이 핸들러 어댑터와 핸들러 매핑을 찾는 과정 또한 알아보았다.

다음 내용은 스프링 MVC의 기본 기능들에 대해 알아본다.