Backend/Spring Boot
원본 글 보기

[Spring Boot] @PostMapping과 @RequestBody

SpringBoot와 @PostMapping, @RequestBody

해당 내용에 앞서, get과 post 방식의 차이를 먼저 짚고 넘어가자.

GetMapping은 @GetMapping(value = "/getMappingTest")

URL에 변수(데이터)를 포함시켜 요청, 데이터를 Header(헤더)에 포함하여 전송, URL에 데이터가 노출되어 보안에 취약함 등의 특징들이 있다.

PostMapping은 URL에 변수(데이터)를 노출하지 않고 요청, 데이터를 Body(바디)에 포함, URL에 데이터가 노출되지 않아 GET 방식보다 보안이 높다. 해당 포스팅에서 다룬다. #GetMapping과PostMapping

BaseResponseStatus.java



@Getter
public enum BaseResponseStatus {
SUCCESS(true,1000,"요청 성공."),
FAIL(false,2000,"실패.");
private final boolean isSuccess;
private final int code;
private final String message;
private BaseResponseStatus(boolean isSuccess, int code, String message) {
this.isSuccess = isSuccess;
this.code = code;
this.message = message;
}
}


#enum타입 의 클래스 BaseResponseStatus.

enum 타입의 클래스는 클래스처럼 보이게 하는 상수이며

서로 관련있는 상수들끼리 모아 상수들을 정의한다.

enum 클래스 형을 기반으로 한 클래스형을 선언하는 것이다.

enum 열거형으로 지정된 상수들은 모두 대문자로 선언해야하고 상수와 특정 값을 연결시킬경우 마지막에 세미콜론(;)을 붙여줘야한다.

SUCCESS(true,1000,"요청 성공.") 과 FAIL(false,2000,"실패.") 상수를 생성.

final boolean 타입의 isSuccess, final int 타입의 code, final 문자열 타입 message 상수를 생성.

(#final 은 엔티티를 한 번만 할당한다. 두 번 이상 할당하려 할 때 컴파일 오류가 발생하여 확인할 수 있다.)

BaseResponse.java



@Getter
@AllArgsConstructor
@JsonPropertyOrder({"isSuccess", "code", "message", "result"})
public class BaseResponse<T> {
    @JsonProperty("isSuccess")
private final boolean isSuccess;
private final String message;
private final int code;
    @JsonInclude(JsonInclude.Include.NON_NULL)
private T result;
public BaseResponse(T result) {
this.isSuccess = SUCCESS.isSuccess();
this.message = SUCCESS.getMessage();
this.code = SUCCESS.getCode();
this.result = result;
}
public BaseResponse(BaseResponseStatus status) {
this.isSuccess = status.isSuccess();
this.message = status.getMessage();
this.code = status.getCode();
}
}

JsonPropertyOrder 어노테이션은 Json 순서를 정렬한다.

1) BaseResponse 클래스 생성.

BaseResponse<T> 타입의 클래스를 생성한다.

String에 대한 클래스, Integer에 대한 클래스 등 타입에 따라 전부 만드는 건 비효율적이라 이러한 문제를 해결하기 위해 #제네릭 이라는 것을 사용한다. 리스트를 생각해보자.

List<> list = new ArrayList<>();

<>안에 어떤 타입을 선언해주어 해당 List가 사용할 객체의 타입을 지정해준다는 뜻이다. 다룰 객체의 타입을 미리 명시하여 객체의 형변환을 사용할 필요없게 하고, 내가 사용하고 싶은 데이터 타입만 사용할 수 있게 해준다.

정확히는 private T result <- 여기에 올 타입을 유동적으로 설정하는 것.

2) T 타입의 result를 전달 받는 BaseResponse #생성자

BaseResponseStatus 열거형 클래스의 SUCCESS 상수의 'true,1000,요청 성공'을 BaseResponse에 세팅한다.

3) BaseResponseStatus 타입의 status를 전달받는 BaseResponse 생성자.

BaseResponseStatus 클래스의 SUCCESS 변수의 status 여기 isSuccess에 세팅한다.

ProductController.java



import org.springframework.web.bind.annotation.*;
import static .config.BaseResponseStatus.FAIL;

@RestController
@RequestMapping("/product")
public class ProductController {
    @ResponseBody
    @PostMapping("/create")
public BaseResponse<String> createProduct(@RequestBody String str) {
if(str.equals("abc")){
return new BaseResponse<>("성공");
} else {
return new BaseResponse<>(FAIL);
}
}
}

ProductController 클래스.

@RequestBody를 이용하여 HTTP Body에 담긴 데이터를 매핑하여 가지고 온다.

* GET에서는 @RequestParam을 사용하지만, POST에서는 @RequestBody를 사용한다.

BaseResponse<String> 타입의 createProduct 라는 이름의 메소드 생성.

RequestBody로 String 타입의 str 을 전달 받는다. 전달받은 str이 abc일 경우, 응답 메시지로 BaseResponse<> 타입의 "성공"을 반환. 그게 아니면 BaseResponse<> 타입의 FAIL을 반환 받는다.

Advanced REST client 프로그램으로 요청 보내보기.

결과:

각각의 생성자를 호출해서 결과가 나왔다.