YW2-237 feat: 공통 Response 및 ControllerAdvice 정의

[ktj1997]

🎯 작업 내역

• 공통 Response를 정의했습니다.
• 공통 Exception을 처리할 수 있는 RestControllerAdvice를 정의했습니다.
• 임의로 구성한 것이니, 누락된 것이 있거나 과해보이는 것이 있으면 의견 부탁드립니다.

📜 Jira 티켓

https://yapp22-web2.atlassian.net/browse/YW2-237

📁 영향범위 (모듈)

• dangle-api

📒 SQL (DDL 변경사항 있는 경우만)

---
Resolves: # See also: #

[rilac1]

LGTM 👍
코멘트 확인 부탁드려요~!

[rilac1]

에러코드 범위 확인했습니다~!

[rilac1]

오호 Prod 환경에서는 스택트레이스를 노출하지 않는군요,,

[rilac1]

이 부분 SealedInterface 적용해보는건 어떨까요?

sealed interface ApiResponse<T> {
    val result: ResponseType

    data class Success<T>(
        val data: T?
    ) : ApiResponse<T> {
        override val result = ResponseType.SUCCESS
    }

    data class Error<T>(
        val error: ErrorResponse? = null,
        val debug: String? = null
    ) : ApiResponse<T> {
        override val result = ResponseType.ERROR
    }
}

[ktj1997]

sealed interface를 잘 사용해볼 버릇을 안해봐서 정확한 사용처? 에 대해서 아직 와닿지않는 것 같습니다 ㅎㅎ..
사실 사용해본 것도 enum과 같이 when절 -> else 미정의시 컴파일 타임에 에러 잡기위한 용도 정도밖에 없었어서요

혹시 sealed 키워드 (클래스, 인터페이스 포함) 를 사용하시는 기준이 있을까요?
그와 더불어서, 제안해주신 코드 대로 진행한다면 성공때와 실패때의 응답이 달라질 것 같은데 혹시맞을까요?
클라이언트 측에서는 어차피 하나의 모델로 대응가능할 것 같긴합니다만

[rilac1]

ErrorResponse의 data 부는 어떤 값들이 들어가게 될까요?

특별한 값이 아니라면, DangleExeption만으로도 표현이 가능할 것 같아서요!
(message는 사용자에게 직접 노출되는 에러메시지)

data class Error<T>(
    val code: String,
    val message: String,
    val debug: String? = null,
) : ApiResponse<T> {
    override val result = ResponseType.ERROR
}

ApiResponse.Error(
    error = dangleException.errorCode.value,
    message = dangleException.errorCode.message,
    debug = dangleException.debug,
)

[rilac1]

추가질문) 저희 클라이언트에서 아래 ResponseType 값을 바라보고 있나요?
성공 여부를 HttpStatus 200으로 분기하는지, ResponseType으로 분기하는지 궁금해서요!

enum class ResponseType{
    SUCCESS, ERROR
}

[ktj1997]

지금은 그냥 200으로 분기하고 있는걸로 알고있습니다.
CustomResponse가 아닌 ReposeEntity로 넘기고 있어서요 ㅎㅎ..