@RequestBody, @ModelAttribute, @RequestParam

클라이언트에서 받은 요청을 객체로 바인딩 하기 위해 사용하는 방법에 알아보자

● @RequestParam

- 1개의 HTTP 요청 파라미터를 받기 위해 사용한다. 필수 여부가 true로 설정되어 있기에 반드시 해당 파라미터가 반드시 해당 파라미터가 전송되어야 하며, 파라미터가 전송되니 않으면 400 에러가 발생한다. 반드시 필요한 값이 아니라면 required를 false로 설정해 주면 된다.(defaultValue 옵션을 사용하면 기본값을 지정할 수 있다.)

 

● @RequestBody

- 클라이언트가 전송하는 JSON(application/json) 형태의 HTTP Body를 Java 객체로 변환 시켜주는 역할을 한다. 그렇게 때문에 Body가 존재하지 않는 HTTP Get 메소드에 @RequestBody를 활용하려고 하면 에러가 발생한다. @RequestBody로 받는 데이터는 스프링에서 관리하는 MessageConverter들 중 하나인 MappingJackson2HttpMessageConverter를 통해  Java 객체로 변환되는데, 이는 ObjectMapper 라는 클래스를 사용한다. 물론 데이터 형식이 Json이 아닐 수도 있다.

ObjectMapper 동작 과정

ObjectMapper는 JSON 메시지를 자바 객체로 변환하는 과정에서 객체의 기본 생성자를 통해 객체를 생성하고, 내부적으로 Reflection을 사용한다. 그래서 반드시 Setter가 필요한 것은 아니다. Getter나 Setter 혹은 JsonInclude 등 필드에 있는 변수들의 이름을 찾기 위한 메소드들이 필요하다. 그러므로 기본생성자 + Getter로 클래스를 구현 하면 Setter가 없어도 값이 바인딩된다.

 

● @ModelAttribute

- 클라이언트가 전송하는 폼(form)형태의 HTTP Body와 요청 파라미터들은 생성자나 Setter로 바인딩 하기 위해 사용된다. 매핑 시키른 파라미터의 타입이 객체으 타입과 일치하는지 등을 포함한 다양한 검증(Validation) 작업이 추가적으로 진행 되는 데, Long형 index에 "1번"을 String형을 넣을려고 한다면, BindException이 발생하게 된다.

특정 Parameter 값 만 가져올 수도 있다. 만약 다음과 같은 형태로 전송된 데이터에서 @ModelAttribute("writer") String writer을 사용하면 writer 변수에서 얻어진다.

ModelAttribute 동작 과정

Reflection을 사용해 필드를 인자로 받는 생성자가 있는지 검사한다. 만약 있다면 해당 생성자를 이용해 값을 세팅하고 없다면 Setter로 값을 세팅한다. 예를 들어 모든 필드를 인자로 받는 생성자가 있다면 해당 생성자로 값을 주입한다. 만약 없다면 일부 필드를 인자로 받는 생성자를 찾아 사용하고, 없으면 기본 생성자를 사용해 객체를 생성한다. 그리고 생성자로 주입하지 못한 남은 변수들은 Setter를 이용해 값을 할당한다. 예를 들어 다음의 경우에도 요청만 정상적으로 왔다면 모든 값이 바인딩되는 것이다. 아래의 경우라면 먼저 Board(1, "글쓴이")를 이용해 Board 객체가 생성되고, 그 다음에 Setter를 통해 contents에 값이 주입된다.

@Getter
@Setter
@ToString
public class Board {

    private int index;
    private String writer;
    private String contents;

    public Board(int index) {
        this.index = index;
    }

    public Board(int index, String writer) {
        this.index = index;
        this.writer = writer;
    }
}

● RequestBody, ModelAttribute, RequestParam 활용 예시

 - Model 객체

@Getter
@Setter
@ToString
public class Board {

    private int index;
    private String writer;
    private String contents;

}

  - Spring에서 활용 예시

@RestController
    @RequestMapping("/board")
    public class BoardController {

        @PostMapping("/requestBody")
        public ResponseEntity<Board> requestBody(@RequestBody Board board) {
            // @RequestBody는 MessageConverter를 통해 Json 형태의 HTTP Body를 Java 객체로 변환시킨다.
            return ResponseEntity.ok(board);
        }

        @PostMapping("/modelAttribute")
        public ResponseEntity<Board> modelAttribute(@ModelAttribute Board board) {
            // @ModelAttribute는 폼(form) 형태의 HTTP Body와 요청 파라미터들을 객체에 바인딩시킨다.
            return ResponseEntity.ok(board);
        }

        @GetMapping("/list")
        public ResponseEntity<List<Board>> requestParam(
                @RequestParam(value = "searchKeyWord1", required = false, defaultValue = "MangKyu") String searchKeyWord) {

            // searchKeyWord는 required가 false이기 때문에 없을 수도 있으므로, 없다면 기본값이 할당된다.
            return ResponseEntity.ok(boardService.getBoardList(searchKeyWord1));
        }
    }

ModelAttribute는 multipart/form-data 형태의 HTTP Body와 파라미터들을 생성자나 Setter로 바인딩 시킨다고 했다. 그렇기에 만약 요청이 다음과 같은 경우라도 객체의 모든 데이터는 정상적으로 바인딩된다.

Request URL: http://localhost:8080/board/modelAttribute?contents=Contents

Request Body:
  - type: application/x-www-form-urlencoded
  - data: {
      "index": 1,
      "writer": "toyeka"
    }
    
    
Response Body:
  - data: {
      "index": 1,
      "writer": "toyeka",
      "contents: "Contents"
    }

 

● 간단 정리

 - RequestParam

• 1개의 HTTP 파라미터를 얻기 위해 사용되며 기본값을 지정 할수 있다.
• 필수 여부가 true이기 때문에 반드시 필요한 경우가 아니라면 required=false 설정이 필요하다.

 - RequestBody

• JSON(application/json) 형태의 HTTP Body 데이터를 MessageConverter를 통해 Java 객체로 변환시킨다.
• 기본 생성자로 객체를 만들고, Getter나 Setter 등의 메소드로 필드를 찾아 Reflection으로  값을 설정한다.

 - ModelAttribute

• 폼 형태(form)의 HTTP Body와 요청 파라미터들을 객체에 바인딩한다.
• 기본적으로 생성자로 값이 설정되고, 생성자로 설정되지 않는 필드는 Setter로 설정된다.

https://mangkyu.tistory.com/72?category=761302 

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