[Spring] @RequestBody, @RequestParam, @ModelAttribute의 차이

Client에서 받은 요청을 객체로 바인딩하기 위해 사용하는 방법에는 총 @RequestBody, @RequestParam, @ModelAttribute 총 3가지가 있다. 

🥑 @RequestParam

@RequestParam은 1개의 HTTP 요청 파라미터를 받기 위해서 사용한다.(HTTP 요청 파라미터를 @RequestParam이 쓰고있는 메서드의 변수로 Mapping해준다.) @RequestParam은 필수여부가 true이기 때문에 기본적으로  해당 파라미터가 전송되어야 한다. (전송되지 않으면 400 Error가 발생한다) 반드시 필요한 변수가 아니라면 required의 값을 false로 설정할 수 있으며 해당 Parameter를 사용하지 않고 요청을 보낼 경우 default로 defaultValue 옵션을 통해 값을 설정할 수 있다.

- value

- required

- defaultValue

 

🥑 @RequestBody

클라이언트가 전송하는 Json(application/json) 형태의 HTTP Body 내용을 Java 객체로 변환시켜주는 역할을 한다. 그렇기 때문에 Body가 존재하지 않는 HTTP GET 메서드에 @RequestBody를 사용할 경우 에러가 발생하게 된다. @RequestBody로 받은 데이터는 Spring에서 관리하는 MessageConverter들 중 하나인 MappingJackson2HttpMessageConverter를 통해 Java 객체로 변환된다.

Spring은 메시지를 변환하는 과정에서 객체의 기본 생성자를 통해 객체를 생성하고 내부적으로 Reflection을 사용해 값을 할당하므로 @RequestBody에는 값을 주입하기 위한 생성자나 Setter가 필요없다.

Json 데이터를 변환하기 위해서는 Jackson 라이브러리가 사용되는데, Jackson 라이브러리 내부적으로는 Getter나 Setter, @JsonInclude 등을 통해 필드에 있는 변수들의 이름을 찾고, Reflection을 이용해 값을 할당한다.

 

* Reflection

inspect or/and modify runtime attributes of classes, interfaces, fields, and methods.

자바에서 기본적으로 제공하는 API, 구체적인 클래스 타입을 알지 못해도 그 클래스의 정보(메서드, 변수 등등)에 접근이 가능하다.

 

🥑 @ModelAttribute

@ModelAttribute는 Client가 전송하는 multipart/form-data 형태의 HTTP Body 내용과 HTTP 파라미터의 값들을 생성자나 Setter를 통해 주입하기 위해 사용된다. @ModelAttribute에는 매핑시키는 파라미터의 타입이 객체의 타입과 일피하는지를 포함한 다양한 검증(Validation) 작업이 추가적으로 진행된다. 예를 들어 게시물의 번호를 저장하는 int형 index 변수에 1번이라는 String형을 넣으려고 한다면 BindException이 발생하게 된다. 즉, Json이나 XML과 같은 형태의 데이터를 MessageConverter를 통해 변환시키는 @RequestBody와 달리, @ModelAttribute는 multipart/form-data 형태의 HTTP Body와 HTTP 파라미터들을 생성자나 수정자로 주입시킨다는 차이가 있다.

 

> @ModelAttribut와 @RequestBody를 보다 극단적으로 설명하자면, @ModelAttribute는 바인딩하는 값들을 주입해주는 생성자나 Setter가 없다면 매핑이 되지 않는다. 하지만 @RequestBody는 요청받은 데이터를 변환시키는 것이기 때문에, 생성자나 Setter함수가 없어도 값이 매핑된다.

 

@ModelAttribut 어노테이션을 활용해서 특정 Parameter만 받아올 수도 있다. 

 

 

[출처]

https://mangkyu.tistory.com/72

[Spring] @RequestBody, @ModelAttribute, @RequestParam의 차이

https://www.baeldung.com/java-reflection

https://maivve.tistory.com/298