@RequestBody @ModelAttribute @RequestParam @PathVariable 차이점

 

spring framwork를 사용해 MVC 모델을 사용하게되면 서버(controller)에서 클라이언트로 부터 넘어오는 요청(request)을 받아 처리를 해야한다. 이때 사용할 수 있는 어노테이션은 크게 4가지가 존재한다.

 

@RequestBody @ModelAttribute @RequestParam @PathVariable 이들에 대해 알아보겠다.

 

1. @RequestBody ?

- 이름에서 알 수 있듯이 요청 body안에 들어있는 값들을 읽어온다. 즉 post요청일때에 클라이언트 측에서 Json(application/json) 형태의 HTTP Body를 Java 객체로 변환 한 값을 넘겨받는다. HashMap<String, Object>로 파라메타를 설정하면 숫자와 문자 배열등 다양한 오브젝트를 구별해서 받을 수 있다. get에서는 사용불가(body에 값을 넣지 않기때문에)

 

@PostMapping("list")
    public ResponseEntity<Map<String, Object>> getGetUseCaseList(@RequestBody  HashMap<String, Object> paramMap) {
        Map<String, Object> result = new HashMap<>();
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

 

2. @ModelAttribute ?

- 이것역시 이름에서 알 수 있듯이 모델의 속성을 매핑해주는 어노테이션이다. 즉 클라이언트 측에서 multipart/form-data 형태의 HTTP Body와 HTTP 파라미터의 값들을 생성자나 Setter를 통해 미리 정의해논 모델에 속성값을 주입해 준다.(속성을 정의하지 않은 HashMap등과 같은 자료형으로는 값을 받을 수 없다)

 

@GetMapping("list")
    public ResponseEntity<Map<String, Object>> getGetUseCaseList(@ModelAttribute  UsecaseSearchParam paramMap) {
        Map<String, Object> result = new HashMap<>();
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

 

3. @RequestParam ?

-  HTTP 요청 파라미터를 받기 위해서 사용한다. 다수의 요청 파라메타를 받을 수 있지만 모두 value값의 자료형이 구분되지 않기 때문에(모두 String으로 받아진다) 형변환의 과정이 필요하다. 따라서 대부분 하나의 파라메타를 받기위해 사용한다. @RequestParam은 필수 여부가 true이기 때문에 반드시 해당 파라미터가 전송되어야 하며, 파라미터가 전송되지 않으면 400 에러가 발생한다. 반드시 필요한 값이 아니라면 required를 false로 설정해주면 되고, defaultValue 옵션을 사용하면 기본값 역시 지정할 수 있다.

 

요청 url(localhost:8080/detail?boardSeq=12)

@GetMapping("detail")
    public ResponseEntity<Map<String, Object>> getGetUseCaseList(RequestParam(value = "boardSeq", required = false) final String boardSeq) {
        Map<String, Object> result = new HashMap<>();
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

 

4. @PathVariable

- HTTP 요청 시 각 구분자에 들어오는 값을 처리해야 할 때 사용 @RequestParam과 차이점은 key와 value값이 매핑되어 url로 넘어오는 것이 아닌 '/' 구분자를 통해 넘어온다. required, defaultValue 옵션 설정 불가능

 

요청 url(localhost:8080/detail/12)

@GetMapping("detail/{boardSeq}")
    public ResponseEntity<Map<String, Object>> getGetUseCaseList(@PathVariable(value = "boardSeq") final String boardSeq) {
        Map<String, Object> result = new HashMap<>();
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

 

[ RequestBody, ModelAttribute, RequestParam, PathVariable 간단 정리 ]

 

• RequestBody
  • Json 형태로 받은 HTTP Body 데이터를 MessageConverter를 통해 변환시킴
  • 기본 생성자로 객체를 만들고, Getter나 Setter 등의 메소드로 필드를 찾아 Reflection으로 값을 설정함
• ModelAttribute
  • multipart/form-data 형태로 받은 HTTP Body와 파라미터들을 객체에 바인딩시킴
  • 기본적으로 생성자로 값이 설정되고, 생성자로 설정되지 않은 필드는 Setter로 설정됨

• RequetParam
  • 1개의 HTTP 파라미터를 얻기 위해 사용되며 기본값을 지정할 수 있음
  • 필수 여부가 true이기 때문에 반드시 필요한 경우가 아니라면 required=false 설정이 필요함
  • 파라미터가 key, value형태로 넘어옴 EX) localhost:8080/detail?boardSeq=12

• PathVariable
  • 1개의 HTTP 파라미터를 얻기 위해 사용되며 기본값을 지정할 수 없음
  • 파라미터가 key, value형태가 아닌 구분자를 통한 url로 넘어옴 EX) localhost:8080/detail/12