API 호출에 대한 공통 응답 객체를 만들어보자
일단 여기서는 JSend를 참고하고 좀 더 간소화해서 만들었다
1. 성공 시 JSON
{
"status": "success",
"body": {
"exampleKey": "exampleValue"
}
}
2. 실패 시 JSON
{
"status": "error",
"errorMessage": "API 실패 메세지"
}
1. 정의된 API Response에 맞는 응답객체 만들기
2. ExceptionHandler를 통해 에러 발생시 실패 응답 생성
3. ResponseBodyAdvice를 사용해 성공 / 실패 시 응답 객체 생성
ErrorResponse 객체를 따로 둔 이유는 위의 예제에서는 그냥 이 글을 쓰기 위해서 errorMessage 하나만을 뒀지만,
더 필요한 부분을 추가할 수도 있다. (ex. 에러코드, 시간정보)
더해서 ErrorResponse뿐만 아니라 ApiResponse에도 각자 상황에 맞게 추가하면 된다.
ExceptionHandler에서 각 Exception마다 ResponseStatus를 잘 세팅 해둔다면
이 글처럼 ResponseBodyAdvice에서 body를 타입검사하는게 아니라
response에서 HttpStatus를 확인하여 성공/실패 응답 객체를 만들 수 있다.
근데 이 부분은 좀 그런게, HttpStatus를 잘 정의해두고 사용하는 프로젝트를 만나기가 쉽지않았다.
관련 코드를 확인하려면 밑의 github를 참고
https://github.com/skwzz/MyCubicle/tree/main/common-response