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

서론

@ModelAttribute를 사용했을 때 parameter에 값을 넣으면 잘 받아오지만 body에 값을 담아 전송하면 null값이 들어가는 경우가 있었습니다. 이럴 때 @RequestBody를 사용하면 바르게 값이 잘 담아지는데 왜 그런지, 그리고 @ModelAttribute와 @RequestBody의 차이는 무엇인지에 대해 궁금하여 한번 정리를 해볼까 합니다.

먼저 클라이언트에서 받은 요청을 객체로 바인딩하기 위한 방법에는 @RequestParam, @RequestBody, @ModelAttribute 총 세 가지가 있습니다.

공통적인 아래와 같은 DTO를 사용하여 한번 각각의 방법을 살펴보겠습니다.

import lombok.Data;

@Data
public class TestData {
    String name;
    int age;
}

 

1. @RequestParam

@RequestParam은 각각의 HTTP 요청 파라미터를 받아오기 위해 사용됩니다. 따라서 Body를 직접 조회하지 않습니다.

    @ResponseBody
    @PostMapping("test/request-param")
    public TestData requestParam(@RequestParam String name,
                                 @RequestParam int age) {
        TestData testData = new TestData();
        testData.setName(name);
        testData.setAge(age);
        return testData;
    }

위 코드를 기반으로 Postman을 이용해 Parameter에 값을 넣어 테스트를 진행해 보겠습니다.

@RequestParam 전송

@RequestParam 반환

예상했던 대로 name과 age라는 파라미터에 값을 담아서 전송했더니 올바르게 @ResponseBody를 거쳐 올바르게 JSON형식으로 값이 담겨서 왔습니다.

2. @RequestBody

@RequestBody는 클라이언트가 전송하는 JSON(application/json) 형태의 HTTP Body 내용을 Java Object로 변환시켜 주는 역할을 합니다. 가장 큰 특징은 바인딩이 아닌 변환을 시키는 것이기 때문에 변수들의 Setter 함수가 없어도 정상적으로 저장됩니다.

    @ResponseBody
    @PostMapping("/test/request-body")
    public TestData requestBody(@RequestBody TestData testData) {
        return testData;
    }

위와 같은 메서드가 있습니다. 마찬가지로 Postman을 이용하여 Body에 JSON형태로 값을 넣어 아래 이미지와 같이 전송해 보았습니다.

@RequestBody 전송

@RequestBody 반환

예상했던 대로 Body에 JSON 형식으로 name과 age를 담아서 전송했더니 올바르게 @ResponseBody를 거쳐 올바르게 JSON형식으로 값이 담겨서 왔습니다.

3. @ModelAttribute

그렇다면 서론에서 언급했다시피 가장 궁금했던 @ModelAttribute입니다. 테스트해 볼 방법은 두 가지입니다.

1. Parameter에 값을 넣어 전송해 본다.
2. Body에 값을 넣어 전송해 본다.

    @ResponseBody
    @PostMapping("/test/model-attribute/param")
    public TestData modelAttributeParam(@ModelAttribute TestData testData) {
        return testData;
    }
    
    @ResponseBody
    @PostMapping("/test/model-attribute/body")
    public TestData modelAttributeBody(@ModelAttribute TestData testData) {
        return testData;
    }

첫 번째로 아래와 같이 Paramater에 값을 넣어서 전송해 보았습니다.

@ModelAttribute Paramter 전송

@ModelAttribute Paramter 반환

parameter에 넣은 값들이 올바르게 JSON형식으로 Body에 반환되었습니다.

두 번째로는 아래와 같이 Body에 값을 넣어서 전송해 보았습니다.

@ModelAttribute body 전송

@ModelAttribute body 반환

예상과는 달리  name = null, age = 0 즉 값이 담기지 않았습니다. 어떻게 된 것일까요? @ModelAttribute에서는 Body를 이용해 전송하려면 Content-Type을 application/json이 아닌 multipart/form-data 형태로 전송해야만 합니다. 

따라서 한번 Content-Type을 multipart/form-data 형태로 바꾼 뒤 테스트를 진행해 보았습니다.

multipart/form-data 로 전송한 @ModelAttribute body

 이제야 예상했던 대로 name과 age에 값이 담겨서 반환되었습니다.

 

정리

바인딩 종류	특징
@ModelAttribute	- 변환이 아닌 바인딩을 시키기 때문에 변수들의 Setter 함수가 없으면 저장되지 않는다. - @ModelAttribute를 사용하여 HTTP Body에 내용을 담기 위해서는 multipart/form-data 형식으로 전송해야 한다. - HTTP 파라미터들은 Setter를 통해 일대일 객체에 바인딩하기 위해 사용된다. - @ModelAttribute에는 매핑시키는 파라미터의 타입이 객체의 타입과 일치하는지를 포함한 다양한 검증(Validation) 작업이 추가적으로 진행된다.
@RequestParam	- @RequestParam은 1개의 HTTP 요청 파라미터를 받기 위해서 사용된다.
@RequestBody	- @RequestBody로 받은 데이터는 Spring에서 관리하는 MessageConverter들 중 하나인 MappingJackson2 HttpMessageConverter를 통해 Java 객체로 변환된다. - Spring은 메시지를 변환하는 과정에서 객체의 기본 생성자를 통해 객체를 생성하고 내부적으로 Reflection을 사용해 값을 할당하므로 @RequestBody에는 값을 주입하기 위한 생성자나 Setter가 필요 없다.