[Spring] @Controller와 @RestController의 차이

 

🚀 개요

Spring에는 Controller를 지정해 주기 위해 두 가지 Annotaion이 준비 되어 있는 것이에요.
첫번째는 `@Controller`가 있고, 두번째는 `@RestController`가 있는 것이에요.

두 친구의 주요 차이점은 `HTTP Response Body`가 생성되는 방식에 있답니다.

 

 

🚀 @Controller - Spring MVC Controller

    🔽  Controller - View

전통적인 Spring MVC Controoler인 `@Controller`는 주로 View 변환하기 위해 사용하는 것이에요. 아래 그림과 같은 과정을 통해 Spring MVC Controller는 Client의 요청에서 View를 반환하는 것이에요.

 

● Client(Front End)는 URI 형식으로 Server (Back End)에 Request(요청)을 날린다.
● Mapping 되는 Handler와 해당 Type을 찾는 `DispatcherServlet`이 해당 요청을 가로챈다(Intercept).
● Controller가 요청을 처리한 뒤 Response(응답)을 `DispatcherServlet`에게 반환하고, `DispatcherServlet`은 View를 이용자에게 반환한다.

 

`@Controller`가 `View`를 반환하기 위해선 `ViewResolver`가 이용되고, `ViewResolver`설정에 맞게 `View`를 찾아 Rendering하게 되는 것이에요.

 

 

 

 

    🔽  Controller - Data

Spring MVC의 Controller에서도 `Data 반환`해야 하는 경우가 발생하는 것이에요.
Spring MVC의 Controller에서는 Data를 반환하기 위해 @ResponseBody Annotaion을 이용해주어야 하는 것이에요. Controller에서도 JSON 형태로 Data를 전달 해 줄 수 있게 되는 것이랍니다.

 

 

● Client(Front End)는 URI 형식으로 Server (Back End)에 요청을 보낸다.
● Mapping되는 Handler와 해당 Type을 찾는 `DispatcherServlet`이 해당 요청을 가로챈다(Intercept).
● `@ResponseBody`를 이용하여 Client에게 JSON 형태로 Data를 전달해 준다.

 

`@RestController`가 Data를 반환하기 위해서는 `viewResolver` 대신 `HttpMessageConverter`가 동작하는 것이에요. HttpMessageConverter에는 여러 Converter(변환기)가 등록되어 있는데, 반환해야 하는 Data에 따라 사용되는 Converter가 달라지는 것이에요. 만약 단순 문자열이라면 `StringHttpMessageConverter`가 동작하게 되고, 객체인 경우에는 `MappingJackson2HttpMessageConverter`가 동작하며, Data 종류에 따라 서로 다른 MessageConverter가 동작하게 되는 것이에요.

Spring은 Client의 `HTTP Accept Header`와 Server Controller 반환 Type 정보 두 가지를 조합하여 접합한 HttpMessageConverter를 선택하여 이를 처리하게 되는 것이에요.

 

 

예제 코드

반응형

 

위와 같은 예제에서 info라는 Data를 반환하고자 하고 있고, User를 JSON으로 변환하기 위해 @ResponseBody라는 Annotation을 붙여주고 있는 것이에요. infoView Method에서는 View를 전단해주고 있기 때문에 String을 반환값으로 설정해 준 것이랍니다. (Data를 반환하는 RestController와 View를 반환하는 Controller를 분리해서 이용하는 것이 좋다.)

 

 

 

 

🚀 @Controller - Spring RestFul Controller

`@RestController`는 Spring MVC Controller에 `@ResponseBody`가 추가된 것이랍니다. 당연히 RestController의 주 용도는 `JSON 형태의 객체로 Data 반환 및 전달`하는 것이에요.

최근 Data를 응답으로 제공하는 RestFul API를 개발할 때 주로 이용하는 것이랍니다.

 

● Client(Front End)는 URI 형식으로 Server (Back End)에 요청을 보낸다.
● Mapping되는 Handler와 해당 Type을 찾는 `DispatcherServlet`이 해당 요청을 가로챈다(Intercept).
● `RestController`는 해당 요청을 처리하고, Data를 반환한다.

 

 

예제 코드

info1의 Method는 User Data를 그대로 반환하고 있는 것이에요. 하지만, 이렇게 처리하는 것 보다는 info2와 같이 결과 Data와 HTTP Status Code를 함께 제어 하여 반환하는 것이 좋은 것이에요. 또한, 만약 userService에서 반환하는 형태가 `Optional`이라면 info3처럼 깔끔하게 처리할 수 있는 것이에요.