Spring - @Controller와 @RestController 그리고 상태코드

 

 

 

[ SpringMVC에 대하여 ]

Spring - Spring MVC를 알아야 시작이 가능하다.

 

 

 

 

[ Hello World 출력하기 ]

Spring - [IntelliJ] Hello World 출력하기

 

---

 

 

Hello, World를 출력했다.
그런데 @Controller가 아닌 @RestController를 사용하였다.

왜 @RestController를 사용한걸까?

 

 

 

 

@Controller

• @Controller는 주로 view를 반환한다.
• ViewResolver를 통해 view를 반환한다.
• AnnotationMethodHandlerAdapter 핸들러 어댑터가 사용한다.
• 메소드 단위로 설정할 수 있기 때문에 효율이 좋다.
• @Controller는 200 OK(성공을 알리는 상태 코드)를 기본적으로 보낸다.

 

 

@RestController

• @Controller에 @ResponseBody가 추가되었다.
• Controller를 통해 Json 형태로 반환해야하는 경우 사용한다.
• HttpMessageConverter를 통해 Json 형태로 반환한다.
• 반환되는 객체는 Json으로 Serialize(직렬화)되어 반환된다.
• @RestController는 200 OK(성공을 알리는 상태 코드)를 기본적으로 보낸다.

 

 

 

결론적으로 @Controller는 View를 반환할 때 사용하고, @RestController는 Hello, World 같은 어떤 Json 형태의 데이터를 반환할 때 사용한다는 걸 알았다.

 

그렇다면 왜 @RestController는 Json 반환이 되는걸까?

 

 

 

 

직렬화

• 컴퓨터 과학의 데이터 스토리지 문맥에서 데이터 구조나 오브젝트 상태를 동일하거나 다른 컴퓨터 환경에 저장하고 나중에 재구성할 수 있는 포맷으로 변환하는 과정이다.
• 자바 시스템 내부에서 사용되는 객체 또는 데이터를 외부의 자바 시스템에서도 사용할 수 있도록 바이트(byte) 형태로 데이터 변환하는 기술과 바이트로 변환된 데이터를 다시 객체로 변환하는 기술(역직렬화)을 아울러서 이야기한다.

 

 

 

직렬화를 쉽게 이해해보자면, 시스템 내부에서 처리하기 편리한 어떤 데이터 형태로 존재하다가 우리에게 보여줄 때 우리가 이해할 수 있는 모습으로 형태를 변화시키는 것을 뜻하는 것 같다.

 

 

 

 

 

Q. @Controller는 Json 형태로 반환을 못하나?

 

A. 그건 아니다. 할 수 있다. @ResponseBody를 붙여주면 Json 형태로 반환이 가능하다. 본래 @Controller는 ViewResolver가 작동하여 view를 반환할 수 있도록 해준다. 하지만 @ResponseBody를 붙이면 @RestController처럼 HttpMessageConverter가 개입하게 되어 객체를 직렬화하여 전달하게 된다. 또한 MessageConverter에는 데이터의 종류(단순 문자열인지, 객체인지...)에 따라 서로 다른MessageConverter가 작동하게 된다.

// @ResponseBody를 붙인 코드
@Controller
public class HelloController {

    @GetMapping("")
    @ResponseBody
    public String helloWorld() {
        return "Hello, World";
    }

}

 

<결과>

👍

 

 

 

---

 

 

 

 

Http 상태 코드

• 특정 HTTP 요청이 성공적으로 완료되었는지 알려준다.
• 가장 기본적인 성공응답은 200 OK가 있다.

 

- 더 다양한 상태 코드

HTTP 상태 코드 - HTTP | MDN

 

 

 

 

Q. @RestController의 기본적으로 반환되는 성공 상태 코드는 200 OK다. 그런데 다른 상태 코드로 바꾸려면 어떻게 해야하나?

A. ResponseEntity를 사용하여 상태 코드를 직접 설정할 수 있다. 

 

1) ResponseEntity.ok()를 사용한 코드 (200 OK)

// 예제 출처 - mangkyu.tistory (망나니 개발자님)

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

 

 

2) ResponseEntity.status(HttpStatus.CREATED)를 사용한 코드 (201 Created)

@GetMapping(value = "/users")
public ResponseEntity<User> findUserWithCreatedResponse(@RequestParam String userName){
    return ResponseEntity.status(HttpStatus.CREATED).body(userService.findUser(userName));
}

 

코드 설명 :

1. @GetMapping ▻ users 경로로 들어온 요청을 해결하고 응답을 반환한다.
2. ResponseEntity<User> ▻ User(User 안에 있을 어떤 정보들, 이름+나이+주소와 같은...) 객체를 반환하는데, 상태 코드와 함께 반환하다는 뜻. (ResponseEntity로 감싸서 반환)
3. @RequestParam  ▻ 파라미터 이름으로 바인딩(구체적인 값을 할당하는 과정, 이름 = 미나 + 나이 = 10세 + 주소 = 서울특별시와 같은...) 그런데 userName이 옆에 붙었다. 이 의미는 구체적인 값으로 userName이 들어오면(쿼리 파라미터) userName 변수에 저장하겠다는 것이다. (미나라는 값이 url로부터 받아오면 그 값을 userName에 저장하고 데이터베이스에 그 사용자에 대한 다른 정보를 추가적으로 넣을 수 있게 만든다는 의미인 것 같다.)
4. ResponseEntity.status  ▻ 응답상태 코드를 설정하도록 한다.
5. HttpStatus.CREATED  ▻ 201 Created를 의미한다. 요청이 성공적으로 처리되었으며, 자원이 생성되었음을 나타내는 성공 상태 응답 코드이다. 
6. findUser(userName)  ▻ userName을 찾아서 User 객체를 반환하라는 것이다.

 

결론 : users로 들어온 요청을 해결한 후 성공적이면 201 CREATED를 반환하며 반활할 때 User 내용도 같이 담아서 반환해라. 

 

 

 

 

 

 

Q. 그렇다면 @Controller는 상태 코드를 어떻게 변환할 수 있는가?

 

A. @RestController와 같이 ResponseEntity.status를 이용하는 방법도 있지만, HttpServletResponse 객체를 이용하여 상태 코드를 설정할 수 있다. 아래 코드를 보면  HttpServletResponse response와 response.setStatus(HttpStatus.CREATED.value()); 코드를 통해 201 CREATED로 상태를 설정하는 걸 볼 수 있다.

    @GetMapping("/users")
    public String findUser(@RequestParam String userName, HttpServletResponse response) {        
        response.setStatus(HttpStatus.CREATED.value());
    }

 

 

 

---

 

 

이번에는 @Controller와 @RestController에 대해 알아봤습니다.

생각보다 정리하는데 오래걸려서 조금 당황스러웠네요...

 

다 처음보는 내용들이라 하나의 개념을 이해하려면 다른 개념들도 이해해야했고
상태 코드에 대한 부분도 몰랐다가 얼떨결에 간단히 배우고 넘어가게 되는 시간이었습니다.

 

아래에 출처를 남겨두겠습니다.
블로그엔 제가 최대한 이해한 내용까지만 적는거라
출처에 들어가시면 더 많은 내용이 있어 공부하시는데 도움되실겁니다.

 

🪽

틀린 내용이 있다면 댓글로 알려주세요

 

 

---

 

 

- @Controller와 @RestController의 원리와 차이 그리고 상태코드

[Spring] @Controller와 @RestController 차이

 

 

 

- 다양한 Controller에 대해서

[Spring] Controller의 종류와 다양한 전략

 

 

 

- 직렬화에 대해서

직렬화 - 위키백과, 우리 모두의 백과사전

 

 

 

 

- @RequestParam에 대해서

🌱 @RequestParam 개념 정리

 

 

 

- HttpservletResponse에 대해서

서블릿(Servlet) - HttpservletResponse 기본 사용법, HTTP 응답 데이터 단순 텍스트 & HTML & API JSON

 

 

 

- 다양한 상태 코드

HTTP 상태 코드 - HTTP | MDN

 

 

 

- 스프링사전

ResponseBody (Spring Framework 6.1.14 API)

 

 

 

 

- @ResponseStatus에 대하여

Spring에서 특정 HTTP 응답 상태 반환하기