예외 반환에 대한 구체적인 컨벤션 논의

[Choi-JJunho]

서론

현재 에러 발생 시 반환하는 code 값에 대해 다른 방식으로 처리하는것이 어떨까 고민중입니다.
클라이언트의 보다 세부적인 에러 핸들링을 위해 에러상태를 반환해달라는 요구사항이 왔습니다.

# 참고: 현재 구조
{
    "code": 100000,
    "message": "요청 데이터가 유효하지 않습니다.",
    "violations": [
        "비밀번호는 비워둘 수 없습니다.",
        "사업자 등록 번호 형식이 올바르지 않습니다.",
        "이미지는 사업자등록증, 영업신고증, 통장사본을 포함하여 최소 3개 최대 5개까지 가능합니다."
    ]
}

아래는 예외 구체화 시 활용할 수 있는 상황입니다.

ex) 사장님이 가게 추가에 실패했다 왜?
-> 카테고리가 없으면 카테고리로 돌아감
-> 사진이 없으면 사진으로 돌아감

클라이언트에서 활용하는 의사코드는 아래와 같습니다.

if(response.data.code === "INVALID_PHONE_NUMBER"){
  clear전화번호();
  메시지띄우기(response.data.message);
}
else if(response.data.message === "INVALID_STUDENT_NUMBER"){
  clear학번();
  메시지띄우기(response.data.message);
}

물론 지금 code의 선언이 어느정도 되어있으나 정수 -> 문자열, 구체적인 상황 으로 이루어져있어 에러핸들링에 있어 신경써야할 부분이 많아질 뿐더러 문서화의 공수가 2배로 들 것 같다는 걱정입니다.

ex) 
1xx -> 유저의 에러상황으로 정의, 
2xx -> 상점의 에러상황으로 정의, 
만약 유저 에러상황이 101개가 되면? 2xx는 상점건데...

본론

어떤 방식으로 구체적인 예외를 구분하는것이 좋을까요?

// 예시
{
  "message":"잘못된 이메일 형식입니다",
  "code":"INVALID_EMAIL_FORM"
}

1. 문자열로 (정수 없이 문자열 바로)
2. 정수 - 문자열 매핑 형식으로 (기존 방식)
3. 기타 다른 방법

참고

공유받은 각 클라이언트별 에러 핸들링 현황입니다

프론트엔드 에러 핸들링 현황

<공통>
도메인 : user, shop, dept, timetable, bus, notice, room, dining

• 401 status code

<특정 도메인 처리>

GET /user/check/nickname

• 409 status code
• 412 status code

< 코인 오너 >

<특정 도메인 처리>

POST /user/refresh

• 401 status code
• error message

POST /user/login

• error message

POST /owners/verification/emai

• error message

POST /owners/password/reset/send

• violations
• error message

POST /owners/password/reset/send

• 401 status code
• 404 status code
• 413 status code
• 415 status code
• 422 status code

안드로이드 에러 핸들링 현황