[Spring Boot]BaseResponse 적용하기

들어가며

이 글은 Spring Boot를 공부하며 정리한 글입니다.

BaseResponse

저희는 현재까지는 DTO를 이용해서 사용자에게 데이터를 입력받거나 반환하게 됩니다. 하지만, 해당 방법을 사용하는 경우 사용자 입장에서는 성공한 경우에는 데이터를 받게 되지만, 실패하는 경우 에러를 핸들링하여 다른 데이터를 보내주어야 될 수도 있습니다.

이를 위해서 기본응답 모델을 작성하여 사용자에게 요청 성공여부, 메시지, 데이터 등을 담아서 반환할 수 있게 해주면 응답 데이터를 통일할 수 있고, 사용자 입장에서 명확한 의미도 전달받을 수 있을것입니다.

Status

enum class ResultStatus(val msg : String) {
    SUCCESS("요청이 성공했습니다!"),
    ERROR("에러가 발생했습니다!")
}

이 열거형 클래스는 사용자에게 요청이 성공, 실패 여부와 그에 따른 메시지를 전달하는 클래스입니다. 이를 이용해서 기본응답 모델을 만들어 보겠습니다.

BaseResponse

data class BaseResponse<T>(
    var status : String = ResultStatus.SUCCESS.name,
    var data : T? = null,
    var resultMsg : String = ResultStatus.SUCCESS.msg,
)

이 기본응답 모델역시 DTO로써, 사용자에게 외부에서 데이터를 전달받아 사용자에게 전달해줍니다. 이를 통해서 성공 또는 실패에 경우 모든 반환 데이터를 통합할 수 있습니다.