@RequestBody @ResponseBody 어노테이션 이해하고 사용하기

HTTP

클라이언트와 서버의 통신(HTTP)

@RequestBody, @ResponseBody Annotation을 이해하기에 앞서, 클라이언트와 서버 간 통신에 대해서 먼저 간단하게만 살펴보겠습니다.

 

 

HTTP(HyperText Transfer Protocol) 통신이란,

브라우저와 서버가 통신하기 위한 여러 프로토콜 가운데 한 종류로 웹 브라우저와 웹 서버 사이에 HTML(하이퍼텍스트) 문서를 주고받는 데 사용되는 통신 프로토콜입니다.

HTTP의 통신 방식은 기본적으로 '요청과 응답(request, response)'으로 이루어져 있는데요. 클라이언트가 요청(HttpRequest)을 서버에 보내면 서버는 클라이언트에게 응답(HttpResponse)하는 구조입니다.

 

// start line
POST /payment-sync HTTP/1.1

// headers
Accept: application/json
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 83
Content-Type: application/json
Host: intropython.com
User-Agent: HTTPie/0.9.3

// body (JSON 형식)
{
    "id": "test0101",
    "email": "test0101@gmail.com",
    "address": "google"
}

(HttpRequest 예시)

 

HttpRequest, HttpResponse 구조

여기서는 위 예시와 같은 HttpRequest와 HttpResponse의 구조에 대해서도 함께 살펴보면 좋은데요.

HttpRequest는 start line, headers, body 세 부분으로 나누어져 있으며, HttpResponse 역시 비슷하게 status line, headers, body 세 부분으로 나누어져 있습니다.

 

여기서 주목해 봐야 하는 부분이 바로 body인데요.

앞서 살펴봤던 클라이언트와 서버 간의 HTTP 통신에서 요청과 응답을 보낼 때, 필요한 데이터를 담아서 보내는 공간이 바로 body입니다.

이때 요청하는 요청 본문을 requestBody, 응답하는 응답 본문을 responseBody라고 하는데요.

 

본문에 담기는 데이터 형식은 여러 가지가 있지만 가장 대표적으로 사용되는 것이 JSON이며, xml 형식도 사용됩니다.

 

 

 

---

 

 

 

@RequestBody, @ResponseBody

@RequestBody, @ResponseBody Annotation

Spring에서는 @RequestBody, @ResponseBody 어노테이션을 명시함으로써 MessageConverter를 통한 데이터 변환 과정을 거치게 되는데요. 

 

예를 들어서 클라이언트에서 서버에 JSON 형식의 requestBody로 요청 데이터를 전송했을 때, Java에서는 해당 JSON 형식의 데이터를 받기 위해서 JSON -> Java Object로의 변환이 필요합니다.

마찬가지로 요청된 데이터를 처리 후, 서버에서 클라이언트로 다시 응답 데이터 responseBody를 보낼 때도 Java Object에서 JSON 또는 XML 같은 형식으로의 변환이 필요합니다. 이러한 과정을 해당 어노테이션들이 처리해주는 것입니다.

 

(RequestMappingHandlerAdapter에는 요청 또는 응답의 데이터 형식에 따른 여러 개의 메시지 변환기 HttpMessageConverter가 등록되어 있습니다.)

 

 

 

// JSON 형식의 requestBody
{
    "id": "test0101",
    "email": "test0101@gmail.com"
}

// requestBody 요청을 매핑시킬 Java Object
public class Member {
    private String id;
    private String email;
}

@RequestBody

@RequestBody 어노테이션은 HttpRequest의 본문 requestBody의 내용을 자바 객체로 매핑하는 역할을 합니다.

해당하는 어노테이션이 붙어있는 메서드로 클라이언트의 요청이 들어왔을 때, DispatcherServlet에서는 먼저 해당 HttpRequest의 미디어 타입을 확인하고, 타입에 맞는 MessageConverter를 통해 요청 본문인 requestBody를 통째로 변환해서 메서드로 전달해주게 됩니다.

 

이때 주의할 점으로는 일반적인 GET 메서드의 요청 경우에는 HttpRequest의 requestBody로 요청 데이터가 전달되는 것이 아니라, URI 또는 URL의 파라미터로 전달되기 때문에 @RequestBody 어노테이션을 통해 해당 요청 내용을 받을 수가 없는데요. 

GET 메서드의 경우 @PathVariable, @RequestParam 등의 어노테이션을 통해서 요청을 전달받아야 합니다.

 

(GET 메서드에도 body 값을 실어서 요청을 보낼 수 있지만, 설계적인 문제나 클라이언트에서 지원하지 않을 경우가 있을 수 있음)

 

 

 

// responseBody로 매핑시킬 결과 Java Object
public class ResponseTransfer {
    private String text;
}

// Java Object가 매핑된 responseBody
{"text" : "Response OK"}

@ResponseBody

@ResponseBody 어노테이션은 자바 객체를 HttpResponse의 본문 responseBody의 내용으로 매핑하는 역할을 합니다.

해당 어노테이션 마찬가지로 return Type에 맞는 MessageConverter를 통해 return 하는 객체를 해당 타입으로 변환해서 클라이언트로 전달하게 되는데요.

 

위 예시 코드를 보면 @ResponseBody가 생략되었는데, 그 이유는 Controller에 붙은 @RestController 때문입니다.

아래 @RestController 어노테이션을 살펴보면 @Controller와 @ResponseBody가 둘 다 붙어있는 것을 볼 수 있는데요.

 

이처럼 @RestController 어노테이션을 명시했다면 따로 @ResponseBody 어노테이션을 명시하지 않아도 자동으로 HttpResponse의 본문 responseBody에 자바 객체가 매핑되어 전달됩니다.

 

@RestController

 

 

 

 

< 함께 보면 좋은 자료 >

(Web) HTTP 통신의 개념과 예제

 

 

< 참고 자료 >

[Spring] @RequestBody / @ResponseBody 어노테이션 이란?

 

@RequestBody,@ResponseBody