어노테이션 @Controller와 @RestController의 작동 방식 차이는 무엇인가

[zuminzi]

문제

이번 강의를 통해 스프링 MVC 패턴에서 @Controller 어노테이션은 컨트롤러 클래스를 컴포넌트 스캔 대상으로 만들고, RequestHandlerMapping의 대상으로 인식하도록 하는 역할을 한다고 학습했다.

RESTful 웹 서비스 엔드포인트를 정의하는 데에 주로 사용하는 @RestController와 일반적인 스프링 MVC컨트롤러를 정의하는 @Controller의 작동 방식의 차이에 대해서 더 탐구하고자 한다.

어노테이션 @Controller와 @RestController의 작동 방식 차이는 무엇인가?

관련 섹션

• section 5

[zuminzi]

답변

1. @Controller

• 응답 형식:

  • 주로 HTML 또는 뷰 템플릿을 렌더링하는 데 사용된다.

• 동작 과정:

  
  • 클라이언트로부터 URI 웹 서비스 요청이 오면, DispatcherServlet이 인터셉트하여 요청을 처리할 대상을 찾고, 요청을 처리해줄 수 있는 HandlerAdapter로 Controller(Handler)를 실행한다. Controller가 요청을 처리한 후에 반환한 ViewName으로 ViewResolver를 통해 해당하는 View를 찾아 사용자에게 응답한다.

2. @RestController

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
   @AliasFor(annotation = Controller.class)
    String value() default "";
}

• 특징:

  • @RestController 는 @Controller와 @ResponseBody가 합쳐진 어노테이션이다.
    • @ResponseBody 의 역할:
      • 메서드가 반환하는 데이터를 1)직렬화하여, 2)HTTP 응답의 본문(body)에 포함시킨다.

• 응답 형식:

  • JSON, XML과 같은 데이터 형식으로 반환하는 데 사용된다.

• 동작 과정:

  
  • 클라이언트로부터 URI 웹 서비스 요청이 오면, DispatcherServlet이 인터셉트하여 요청을 처리할 대상을 찾고, 요청을 처리해줄 수 있는 HandlerAdapter로 Controller(Handler)를 실행하는 것까지는 @Controller 반환 동작 과정과 동일하다.
  • 그러나, Controller가 요청을 처리한 후에 객체를 반환하면, 이 객체를 적절한 형식(JSON 혹은 XML)으로 직렬화하여 사용자에게 응답한다.
    • 이 과정에서 ViewResolver 대신에 HttpMessageConverter가 동작한다.
    • 다양한 유형의 데이터를 HTTP 응답으로 변환하기 위한 기능을 제공하는 HttpMessageConverter에는 여러 Converter가 등록되어 있다.
    • Spring은 클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보를 조합하여 반환해야 하는 데이터에 따라 적합한 HttpMessageConverter를 선택한다.
      • e.g. StringHttpMessageConverter(문자열), MappingJackson2HttpMessageConverter(객체)

3. 결론

• @RestController 의 동작 방식은 @Controller에 @ResponseBody 를 붙인 동작 방식과 완벽하게 동일하다.
  • 따라서, 컨트롤러 클래스를 컴포넌트 스캔 대상으로 만들고, RequestHandlerMapping의 대상으로 인식하도록 하는 @Controller 의 기능 역시 포함되어 있다.
• @RestController 는 HttpMessageConverter가 반환된 객체를 직렬화하여 HTTP 응답 바디에 담기 때문에 RESTful 웹 서비스를 더욱 쉽게 개발할 수 있도록 도와준다.

References

• [Spring] @Controller와 @RestController 차이
• [Spring Boot] @Controller와 @RestController의 차이, REST 방식 사용법(Ajax)