fix: requestBody 파싱 실패 예외처리 추가

Author: kjhh2605

src/main/java/com/devpath/global/apiPayload/code/status/GeneralErrorCode.java

@@ -20,6 +20,7 @@ public enum GeneralErrorCode implements BaseErrorCode {
     _UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "COMMON_401", "인증이 필요합니다."),
     _FORBIDDEN(HttpStatus.FORBIDDEN, "COMMON_403", "금지된 요청입니다."),
     _NO_RESULTS_FOUND(HttpStatus.NOT_FOUND, "COMMON_404", "검색 결과가 없습니다."),
+    _INVALID_INPUT(HttpStatus.BAD_REQUEST,"COMMON_405","입력값이 올바르지 않습니다."),
     _INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "COMMON_500", "서버 에러. 관리자에게 문의 바랍니다."),;
 
     private final HttpStatus httpStatus;

src/main/java/com/devpath/global/apiPayload/exception/ExceptionAdvice.java

@@ -11,22 +11,28 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatusCode;
 import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 import org.springframework.web.context.request.ServletWebRequest;
 import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
 
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Optional;
 
 @Slf4j
-@RestControllerAdvice(annotations = {RestController.class})
+@RestControllerAdvice(annotations = { RestController.class })
 public class ExceptionAdvice extends ResponseEntityExceptionHandler {
 
+    /**
+     * @Valid 어노테이션을 통한 검증 실패 시 발생합니다.
+     *        주로 @RequestParam, @PathVariable 검증 실패 시 발생합니다.
+     */
     @ExceptionHandler
     public ResponseEntity<Object> validation(ConstraintViolationException e, WebRequest request) {
         String errorMessage = e.getConstraintViolations().stream()
@@ -37,36 +43,61 @@ public ResponseEntity<Object> validation(ConstraintViolationException e, WebRequ
         return handleExceptionInternalConstraint(e, GeneralErrorCode.valueOf(errorMessage), HttpHeaders.EMPTY, request);
     }
 
+    /**
+     * @Valid 어노테이션을 통한 검증 실패 시 발생합니다.
+     *        주로 @RequestBody 검증 실패 시 발생합니다.
+     */
     @Override
-    public ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException e, HttpHeaders headers, HttpStatusCode status, WebRequest request) {
+    public ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException e, HttpHeaders headers,
+            HttpStatusCode status, WebRequest request) {
         Map<String, String> errors = new LinkedHashMap<>();
 
         e.getBindingResult().getFieldErrors()
                 .forEach(fieldError -> {
                     String fieldName = fieldError.getField();
                     String errorMessage = Optional.ofNullable(fieldError.getDefaultMessage()).orElse("");
-                    errors.merge(fieldName, errorMessage, (existingErrorMessage, newErrorMessage) -> existingErrorMessage + ", " + newErrorMessage);
+                    errors.merge(fieldName, errorMessage,
+                            (existingErrorMessage, newErrorMessage) -> existingErrorMessage + ", " + newErrorMessage);
                 });
 
-        return handleExceptionInternalArgs(e, HttpHeaders.EMPTY, GeneralErrorCode.valueOf("_BAD_REQUEST"), request, errors);
+        return handleExceptionInternalArgs(e, HttpHeaders.EMPTY, GeneralErrorCode.valueOf("_BAD_REQUEST"), request,
+                errors);
     }
 
+    /**
+     * JSON Request Body 파싱 실패 시 발생합니다.
+     * 주로 잘못된 형식의 JSON이나 Enum 타입 불일치 시 발생합니다.
+     */
+    @Override
+    public ResponseEntity<Object> handleHttpMessageNotReadable(HttpMessageNotReadableException e, HttpHeaders headers,
+                                                               HttpStatusCode status, WebRequest request) {
+        return handleExceptionInternalConstraint(e, GeneralErrorCode._INVALID_INPUT, headers, request);
+    }
+
+    /**
+     * 처리되지 않은 모든 예외를 처리합니다.
+     * 500 Internal Server Error를 반환합니다.
+     */
     @ExceptionHandler
     public ResponseEntity<Object> exception(Exception e, WebRequest request) {
-        log.error("500 Error",e);
-        return handleExceptionInternalFalse(e, GeneralErrorCode._INTERNAL_SERVER_ERROR.getHttpStatus(), request, e.getMessage());
+        log.error("500 Error", e);
+        return handleExceptionInternalFalse(e, GeneralErrorCode._INTERNAL_SERVER_ERROR.getHttpStatus(), request,
+                e.getMessage());
     }
 
-    // 비즈니스 로직 커스텀 예외처리
+    /**
+     * 비즈니스 로직 실행 중 발생하는 커스텀 예외를 처리합니다.
+     */
     @ExceptionHandler(value = GeneralException.class)
     public ResponseEntity onThrowException(GeneralException generalException, HttpServletRequest request) {
         return handleExceptionInternal(generalException,
                 generalException.getCode(),
                 HttpHeaders.EMPTY,
                 request);
     }
+
     private ResponseEntity<Object> handleExceptionInternal(Exception e, BaseErrorCode reason,
-                                                           HttpHeaders headers, HttpServletRequest request) {
+            HttpHeaders headers, HttpServletRequest request) {
 
         ApiResponse<Object> body = ApiResponse.onFailure(reason, reason.getMessage());
 
@@ -76,43 +107,40 @@ private ResponseEntity<Object> handleExceptionInternal(Exception e, BaseErrorCod
                 body,
                 headers,
                 reason.getHttpStatus(),
-                webRequest
-        );
+                webRequest);
     }
 
     private ResponseEntity<Object> handleExceptionInternalFalse(Exception e,
-                                                                HttpStatus status, WebRequest request, String errorPoint) {
-        ApiResponse<Object> body = ApiResponse.onFailure(GeneralErrorCode._INTERNAL_SERVER_ERROR,errorPoint);
+            HttpStatus status, WebRequest request, String errorPoint) {
+        ApiResponse<Object> body = ApiResponse.onFailure(GeneralErrorCode._INTERNAL_SERVER_ERROR, errorPoint);
         return super.handleExceptionInternal(
                 e,
                 body,
                 HttpHeaders.EMPTY,
                 status,
-                request
-        );
+                request);
     }
 
-    private ResponseEntity<Object> handleExceptionInternalArgs(Exception e, HttpHeaders headers, GeneralErrorCode errorCommonStatus,
-                                                               WebRequest request, Map<String, String> errorArgs) {
+    private ResponseEntity<Object> handleExceptionInternalArgs(Exception e, HttpHeaders headers,
+            GeneralErrorCode errorCommonStatus,
+            WebRequest request, Map<String, String> errorArgs) {
         ApiResponse<Object> body = ApiResponse.onFailure(errorCommonStatus, errorArgs);
         return super.handleExceptionInternal(
                 e,
                 body,
                 headers,
                 errorCommonStatus.getHttpStatus(),
-                request
-        );
+                request);
     }
 
     private ResponseEntity<Object> handleExceptionInternalConstraint(Exception e, GeneralErrorCode errorCommonStatus,
-                                                                     HttpHeaders headers, WebRequest request) {
+            HttpHeaders headers, WebRequest request) {
         ApiResponse<Object> body = ApiResponse.onFailure(errorCommonStatus, null);
         return super.handleExceptionInternal(
                 e,
                 body,
                 headers,
                 errorCommonStatus.getHttpStatus(),
-                request
-        );
+                request);
     }
 }