[Spring] @RequestBody 사용하기

[@RequestBody 어노테이션 사용하기]

@RequestBody 어노테이션은 Spring Framework에서 사용되는 어노테이션으로 HTTP 요청의 본문 = Body부분을  > Java 객체로 변환하는 데 사용된다. 주로 RESTful 웹 서비스를 개발할 때, 클라이언트가 JSON이나 XML 혹은 다른 포맷으로 전송한 데이터를 서버 측에서 객체로 변환해 처리할 때 사용한다.

 

[주요 특징과 역할]

1. 데이터 바인딩 :
   @RequestBody는 클라이언트가 전송한 요청의 본문을 Java 객체로 변환한다.
2. 자동 변환 :
   Spring은 내부적으로 HttpMessageConverter를 사용하여 요청 본문을 Java 객체로 변환한다.
   일반적으로 JSON 데이터를 처리하기 위해 MappingJackson2HttpMessageConverter가 사용된다.
   XML같은 경우 Jaxb2RootElementHttpMessageConverter가 사용된다.
3. 유효성 검사 :
   @Valid 어노테이션과 함께 사용하며 요청 데이터에 대한 유효성 검사를 수행할 수 있다.
   유효성 검사가 실패하면 Spring은 자동으로 적절한 오류 메시지를 반환한다. 
4. ex

    public CommonResult create(@RequestBody @Valid DeptCreateReqDto deptCreateReqDto,
                               BindingResult bindingResult) throws ApiBindException {

        if (bindingResult.hasErrors()) {
            throw new ApiBindException(bindingResult);
        }
        deptService.create(deptCreateReqDto);
        return CommonResult.ok();
    }

 

해당 코드는 create 메서드를 통해 클라이언트로부터 전달된 데이터를 받아 처리한다. 

유효성 검사(@Valid) 수행한 후 문제가 없다면 서비스 로직을 호출해 데이터를 생성하는 동작을 수행한다. 

만약 유효성 검사에서 문제가 발생하면 예외를 던진다. 

 

[동작 과정]

1. 클라이언트 요청 :
   클라이언트는 POST 요청을 보내고 이 요청의 본문 = Body에 JSON 형식으로 데이터를 포함시킨다. 
2. @RequestBody로 데이터 바인딩 :
   @RequestBody 어노테이션 덕분에 요청 본문에 포함된 JSON 데이터가 자동으로 DeptCreateReqDto 타입의 객체로 변환된다. 
   @Valid 어노테이션은 이 DeptCreateReqDto 객체에 대한 유효성 검사를 수행하도록 Spring에 지시한다. 
3. 유효성 검사 :
   BindingResult 객체는 @Vaild 어노테이션에 의해 수행된 유효성 검사 결과를 담고 있다.
   만약 데이터가 유효성 검사를 통과하지 못하면 bindingResult.hasErrors() 가 true를 반환하게 된다. 
4. 유효성 검사 실패 처리 :
   bindingResult.hasErrors() 가 true를 반환 > ApiBindException 예외가 발생한다. > bindingResult를 인자로 받아 어떤 필드에서 오류가 발생했는지 등의 상세 정보를 포함하여 예외를 던지게 된다. 
   .
   .
   .
   .
   
   

[장점]

• 편리성 : @RequestBody를 사용하면 HTTP 요청 본문을 쉽게 Java 객체로 변환할 수 있다.
• 유연성 : 다양한 데이터 포맷을 처리할 수 있다.
• 유효성 검사 : @Valid 어노테이션과 결합하여 입력 데이터의 유효성을 자동으로 검사할 수 있다.