@RequestBody, @RequestParam, @PathVariable, @ModelAttribute의 차이

스프링 프레임워크에서 HTTP 요청 데이터를 컨트롤러 메서드로 매핑하는 방법은 다양하다. 각각의 애노테이션은 다른 유형의 데이터를 처리하기 위해 사용된다. 다음은 @RequestBody, @RequestParam, @PathVariable, @ModelAttribute의 차이와 사용 방법과 내부적 작동 방식에 대해서 다뤄보았다.

@RequestBody

설명

• @RequestBody는 HTTP 요청 본문을 객체에 매핑하는 데 사용된다.
• 주로 JSON, XML 등의 포맷으로 전송된 데이터를 객체로 변환할 때 사용된다.
• JSON 데이터 경우 HttpMessageConverter 인터페이스의 구현체 MappingJackson2HttpMessageConverter 클래스를 통해 요청 본문을 읽고, 해당 객체로 변환한다. MappingJackson2HttpMessageConverter 클래스안에선 ObjectMapper를 활용한다.

이미치 출처 : https://tecoble.techcourse.co.kr/post/2021-05-11-requestbody-modelattribute/

사용 예

커스텀 컨트롤러

import org.springframework.web.bind.annotation.*;

@RestController
public class MyController {

    @PostMapping("/users")
    public String createUser(@RequestBody User user) {
        // 요청 본문(JSON)을 User 객체로 매핑
        return "User is created with name: " + user.getName();
    }
}

User 클래스

public class User {
    private String name;
    private String email;

    // getters and setters
}

요청 예시 (JSON)

{
    "name": "John Doe",
    "email": "john.doe@example.com"
}

---

@RequestParam

설명

• @RequestParam은 HTTP 요청 파라미터를 메서드의 파라미터에 매핑하는 데 사용된다.
• 주로 쿼리 스트링 파라미터나 폼 데이터의 단일 값을 받을 때 사용된다.
• HandlerMethodArgumentResolver 인터페이스의 구현체인 RequestParamMethodArgumentResolver 클래스로 요청 파라미터 값을 추출하고 WebDataBinder를 통해 추출된 파라미터 값을 메서드 파라미터에 바인딩한다.

사용 예

커스텀 컨트롤러

import org.springframework.web.bind.annotation.*;

@RestController
public class MyController {

    @GetMapping("/greeting")
    public String greeting(@RequestParam(name = "name", defaultValue = "World") String name) {
        // 요청 파라미터를 메서드 파라미터로 매핑
        return "Hello, " + name;
    }
}

요청 예시

GET /greeting?name=John

---

@PathVariable

설명

• @PathVariable은 URL 경로의 일부를 메서드의 파라미터로 매핑하는 데 사용된다.
• 주로 RESTful 웹 서비스에서 자원의 식별자를 경로 변수로 받을 때 사용된다.
• HandlerMethodArgumentResolver 인터페이스의 구현체인 PathVariableMethodArgumentResolver 클래스를 활용하여 @ PathVariable 애노테이션이 붙은 경로 변수를 추출하고, WebDataBinder를 사용하여 값을 변환하여 메서드 파라미터에 바인딩한다.

사용 예

커스텀 컨트롤러

import org.springframework.web.bind.annotation.*;

@RestController
public class MyController {

    @GetMapping("/users/{userId}")
    public String getUser(@PathVariable String userId) {
        // URL 경로 변수(userId)를 메서드 파라미터로 매핑
        return "User ID: " + userId;
    }
}

요청 예시

GET /users/123

---

@ModelAttribute

설명

• @ModelAttribute는 요청 파라미터를 객체에 매핑하는 데 사용된다.
• 주로 폼 데이터를 객체로 변환하거나, 모델에 데이터를 추가할 때 사용된다.
• 객체의 필드와 요청 파라미터 이름을 매핑하여 객체를 생성한다.
• HandlerMethodArgumentResolver 인터페이스의 구현체인 ModelAttributeMethodProcessor 클래스를 사용해,  @ModelAttribute가 적용된 객체를 생성하고 요청 파라미터를 추출한다. WebDataBinder 를 사용하여 추출된 파라미터를 생성된 객체의 필드에 바인딩한다.

사용 예

커스텀 컨트롤러

import org.springframework.web.bind.annotation.*;
import org.springframework.ui.Model;

@Controller
public class MyController {
	
    // 이 메서드는 MyController 내의 모든 요청 전에 실행되며 모델에 데이터를 추가한다.
    @ModelAttribute
    public void addAttributes(Model model) {
        model.addAttribute("globalAttribute", "This is a global attribute");
    }

    @PostMapping("/form")
    public String submitForm(@ModelAttribute User user) {
        // 요청 파라미터를 User 객체로 매핑
        return "Submitted user with name: " + user.getName();
    }
}

@ModelAttribute 어노테이션은 컨트롤러 메서드에 적용되어, @ModelAttribute 메서드를 사용하여 모델에 추가된 데이터는 해당 컨트롤러 내의 모든 요청에 대해 모델에 자동으로 포함됩니다 . 이 방법은 주로 모델 데이터를 초기화하거나, 뷰에 공통 데이터를 전달할 때 유용하다.

예시를 보면 @ModelAttribute 어노테이션 이 붙은 메서드는 MyController의 모든 요청에 대해 모델에 globalAttribute를 추가한다.

User 클래스

public class User {
    private String name;
    private String email;

    // getters and setters
}

요청 예시 (폼 데이터)

POST /form
Content-Type: application/x-www-form-urlencoded

name=John&email=john.doe@example.com

주요 차이점 요약

어노테이션	설명	주요 사용 사례
@RequestBody	HTTP 요청 본문을 객체로 변환	JSON, XML 등으로 전송된 데이터 처리
@RequestParam	HTTP 요청 파라미터를 메서드의 파라미터로 매핑	쿼리 스트링, 폼 데이터의 단일 파라미터 처리
@ModelAttribute	HTTP 요청 파라미터를 객체로 변환 및 모델에 데이터 추가	폼 데이터 객체 변환, 모델 데이터 추가, 복수 파라미터의  Query String 처리도 가능
@PathVariable	URL 경로의 일부를 메서드의 파라미터로 매핑	경로 변수로 자원 식별자 전달

결론

@RequestBody, @RequestParam, @ModelAttribute, @PathVariable는 각각 HTTP 요청 데이터를 처리하는 다양한 방법을 제공한다. @RequestBody는 요청 본문을 객체로 변환하는 데 사용되며, @RequestParam은 단일 요청 파라미터를 처리하는 데 사용된다. @ModelAttribute는 요청 파라미터를 객체로 변환하고, 모델에 데이터를 추가하는 데 사용된다. @PathVariable은 URL 경로의 일부를 메서드 파라미터로 매핑하는 데 사용된다.