Spring API서버에서 에러 발생시 어떤 정보를 줘야하나요?

Question

API서버에서 에러 발생시 어떤 정보를 줘야하나요?clientRepository.findById(clientId) .orElseThrow(() -> new ClientNotFoundException()); // 에러 발생// 발생시 반환해줄 정보들... public class ClientNotFoundException extends RuntimeException { private final String message = "사용자를 찾을 수 없습니다."; private final HttpStatus status = HttpStatus.NOT_FOUND; }message: "어떠한 오류가 있습니다." status: 400이런식으로 메시지와 status로 충분하나요?? 아니면 400번대 오류라면 클라이언트가 오류를 복구할 수 있도록 관련된 정보를 반환해 주는 것이 좋나요?(해당 상황에서는 오류가 발생한 clientId)어떤 정보를 반환해줘야 할지 감이 안잡힙니다...내용 추가했습니다.구체적이지 않은 질문을 올리게 돼서 다시 한 번 죄송합니다...권한과 관련된 부분은 컨트롤러에 들어오기 전에 필터에서 검사를 한다고 생각을 해서 이 부분은 질문을 단순화 하기 위해 일단 제외를 했습니다.또한 스프링에 @RestControllerAdvice를 활용해서 런타임 익셉션을 쭉 던지고 ClientNotFoundException 을 처리하려 했습니다.이런식으로 말이죠.@Slf4j @RestControllerAdvice public class ClientExceptionHandler { @ExceptionHandler public ResponseEntity clientNotFoundExceptionHandler(ClientNotFoundResponse e) { ClientNotFoundResponse body = ClientNotFoundResponse.builder() .code("CLIENT_BATCH_FAIL") .message(e.getMessage()) .status(e.getStatus().toString()) .build(); log.info("ClientNotFoundException 핸들러"); return new ResponseEntity<>(body, HttpStatus.NOT_FOUND); } }@Data @Builder public class ClientNotFoundResponse { private String code; private String message; }

나니야 · Answer

정답없습니다. 있다면 거짓이겠죠오답은 있겠네요. 정말 서버측 오류라고 오해할만한 500번대 정도는 그건 좀 아니지 않나...합니다.정의하기 나름이고 얼마나 친절하게 status code를 뱉어줄까도 정하기 나름입니다.1xx(정보) : 요청을 받았으며 프로세스를 계속 진행합니다.2xx(성공) : 요청을 성공적으로 받았으며 인식했고 수용하였습니다.3xx(리다이렉션) : 요청 완료를 위해 추가 작업 조치가 필요합니다.4xx(클라이언트 오류) : 요청의 문법이 잘못되었거나 요청을 처리할 수 없습니다.5xx(서버 오류) : 서버가 명백히 유효한 요청에 대한 충족을 실패했습니다.위의 코드만보더라 해석하기 나름입니다.1xx로 할수도있는거죠. 사용자를 찾을수없어도 다른 anoymous로 자동 로그인되게끔한다는 비즈니스로직이 있을수도있는 상황이니까 질문이 정교하지 못하니 답도 할 수 없습니다.추가로몇년전에도, 요새도 restapi, restful 하면서 직급여하와 연차, 회사의 대/소를 막론하고 하자고 하는데 답답하더라구요.하등쓸모없습니다. 왜냐하면 실무에서 쓰는 꼴을 못 봤기 때문이죠. ( 정확히 제대로 쓰는, 혹은 근접하게 쓰는! )쓴다고 거들먹거리는데 막상 뜯어보면 GET, POST, UPDATE, DELETE 등등 이런거 좀 구분해놓고 &#34;야~~ restapi다!!&#34; 이러고 앉았습니다.그렇다고 제대로 쓰는것도 굉장히 비효율적이며 그래야할 이유도 없거든요.그러니까 너무 푹 빠지지 마시고 status code만 던져줄수만있으면 됩니다.

Throwaway · Answer

아뇨 클라이언트낫파운드 익셉션 외에도 유저의 scope나 rate limit 등 고려해야할 부분이 있긴합니다. 그래야 적절한 리스폰스 코드를 클라이언트에 보내죠.토이 프로젝트라면 에러 path에 다른 익셉션 클래스를 만들어서 리턴해주시면 됩니다..예로 저 리포지토리에 쿼리하기 전에 UserScopeRepository 와 UserRateRepository 를 콜한다고 칩시다. UserScopeRepository에서 scope들을 받고 그게 클라이언트리포지토리를 쿼리할 권한이 없으면 곧바로 UserScopeException 을 http status code 403을 리턴하고 그 다음에 UserRateRepository에 쿼리 후 rate limited 되있다면 429와 함께 남은 시간을 리턴할수도 있겠죠고객들이 사용하는 api 이거나 회사에서 마이크로서비스 아키텍쳐를 사용할때 제대로 된 문서와 함께 제대로된 리스폰스를 보내주는게 좋겠죠

집킨 · Answer

Http status 와는 별개로 프론트쪽과 약속된 규격의 자체 에러 코드를 내려주는 방법도 있습니다

Spring API서버에서 에러 발생시 어떤 정보를 줘야하나요?

3개의 답변

Q&A 목록