@Controller와 @RestController

컨트롤러를 지정하기 위한 어노테이션은 @Controller @RestController가 있다. 두 어노테이션의 차이 점은 HTTP Response Body가 생성되는 방식이다.

 

● @Controller

-  Controller로 View 반환하기

 전통적인 Sprinv MVC의 컨트롤러인 @Controller는 주로 View를 반환하기 위해 사용한다. 아래와 같은 과정을 통해 Spring MVC Container는 Client의 요청으로부터 View를 반환한다.

Controller View Data 반환

• Client는 URI 형식으로 웹 서비스에 요청을 보낸다.
• DispatcherServlet이 요청을 위임할 HandlerMapping을 찾는다.
• HandlerMapping을 통해 요청을 Controller로 위임한다.
• Controller는 요청 처리후 ViewName을 반환한다.
• DispatcherServlet은 ViewResolver를 통해 ViewName에 해당하는 View를 찾아 사용자에게 반환한다.

Controller가 반환한 뷰의 이름으로부터 View를 렌터딜하기 위해서는 ViewResolver가 사용되며, ViewResolver 설정에 맞게 View를 찾아 렌더링 한다.

-  Controller로 Data 반환하기

바로 Data를 반환해야 하는 경우도 있다. 컨트롤러에서는 데이터를 반환하기 위해 @ResponseBody 어노테이션을 활용해 주어야 한다. 이를 통해 Controller도 JSON 형태로 데이터를 반환 할 수 있다.

Controller JSON Data 반환

 

• Client는 URI 형식으로 웹 서비스에 요청을 보낸다.
• DispatcherServlet이 요청을 위임할 HandlerMapping을 찾는다.
• HandlerMapping을 통해 요청을 Controller로 위임한다.
• Controller는 요청을 처리한 후에 객체를 반환한다.
• 반환되는 객체는 Json으로 Serialize되어 사용자에게 반환된다.

컨트롤러를 통해 객체를 반환할 경우 일반적으로 ResponseEntity로 감싸서 반환한다. 그리고 객체를 반환하기 위해선 viewResolver 대신 HttpMessageConverter가 동작한다. HttpMessageConverter에는 여러 Converter가 등록되어 있고, 반환해야 하는 데이터에 따라 사용되는 Converter가 달라진다.

스프링은 클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해 적합한 HttpMessageConverter를 선택하여 처리한다. MessageConverter가 동작하는 시점은 HandlerAdapter와 Controller가 요청을 주고 받는 시점이다. 

@Controller
    @RequiredArgsConstructor
    public class UserController {

        private final UserService userService;

        @GetMapping(value = "/users")
        public @ResponseBody ResponseEntity<User> findUser(@RequestParam("userName") String userName) {
            return ResponseEntity.ok(userService.findUser(user));
        }

        @GetMapping(value = "/users/detailView")
        public String detailView(Model model, @RequestParam("userName") String userName) {
            User user = userService.findUser(userName);
            model.addAttribute("user", user);
            return "/users/detailView";
        }
    }

 findUser는 User 객체를 ResponseEntity로 감싸서 반환하고 있고, User를 JSON으로 반환하기 위해 @ResponseBody라는 어노테이션을 붙여주고 있다. detailView 함수에서는 View를 전달해주고 있기 때문에 String을 반환값으로 설정해주었다.

 

● @RestController

 - @Controller에 @ResponseBody가 추가된 것이다. 주 용도는 JSON 형태로 객체 데이터를 반환하는 것이다. 최근엔 데이터를 응답으로 제공하는 REST API를 개발 할 때 사용되며 객체를 ResponseEntity로 감싸서 반환한다.

RestController 동작 방식

 

• 클라이언트는 URI 형식으로 웹 서비스에 요청을 보낸다.
• DispatcherServlet이 요청을 위임할 HandlerMapping을 찾는다.
• HandlerMapping을 통해 요청을 Controller로 위임한다.
• Controller는 요청을 처리한 후에 객체를 반환한다.
• 반환되는 객체는 Json으로 Serialize되어 사용자에게 반환된다.

@RestController
    @RequestMapping("/user")
    @RequiredArgsConstructor
    public class UserController {

        private final UserService userService;

        @GetMapping(value = "/users")
        public User findUser(@RequestParam("userName") String userName){
            return userService.findUser(user);
        }

        @GetMapping(value = "/users")
        public ResponseEntity<User> findUserWithResponseEntity(@RequestParam("userName") String userName){
            return ResponseEntity.ok(userService.findUser(user));
        }
    }

 findUser는 User 객체를 그대로 반환하고 있다. 이 경우 문제는 클라이언트가 예상하는 HttpStatus를 설정해 줄수 없다는 것이다. 예를 들어 어떤 객체의 생성 요청이라면 201 CREATED를 기대 했지만 객체를 그대로 반환하면 HttpStatus를 설정해줄 수 없다. 그래서 객체를 상황에 맞는 ResponseEntity로 감싸서 반환해 주어야 한다.

https://mangkyu.tistory.com/49?category=761302 

[Spring] @Controller와 @RestController 차이