📄 [문서] GlobalExceptionHandler 설명

[nayoung04]

❌ 문제 상황

No response

📝 핵심 내용과 방향성

@RestControllerAdvice

• 글로벌 예외 처리 : 애플리케이션 전역에서 발생하는 예외 처리
• 예외를 감지하고 처리할 때, JSON 또는 XML과 같은 데이터 형식으로 클라이언트에 응답을 반환합니다.
• 적용 범위 제한 : 특정 클래스나 패키지에만 적용하려면 @RestControllerAdvice에 옵션을 설정할 수 있음
  basePackageClasses = 클래스이름.class: 지정된 클래스의 패키지 및 하위 패키지에만 적용.
  basePackages = "패키지경로": 특정 패키지 경로에만 적용.

@RestControllerAdvice(basePackageClasses = SomeController.class)
public class GlobalRestExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body("서버 에러: " + ex.getMessage());
    }
}

• 일관된 응답 형식 유지 : 클라이언트에 반환되는 응답을 통일된 형식(JSON/XML)으로 유지할 수 있음

@ControllerAdvice와 @RestControllerAdvice의 차이점

1. @ControllerAdvice

• 주로 MVC 컨트롤러(@controller)에서 사용 : HTML, JSP, Thymeleaf와 같은 뷰 템플릿을 사용하는 전통적인 MVC 애플리케이션에서 사용됩니다.

• 뷰 반환 : 예외 처리 메서드가 **뷰 이름(String)**이나 ModelAndView를 반환해 페이지 렌더링을 처리합니다.

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(IllegalArgumentException.class)
    public String handleIllegalArgumentException(IllegalArgumentException ex, Model model) {
        model.addAttribute("errorMessage", ex.getMessage());
        return "error-page"; // error-page.html 로 이동
    }
}

2. @RestControllerAdvice

• REST API 환경에 사용 : 클라이언트와의 통신이 JSON, XML 등의 데이터 형식으로 이루어지는 환경에서 적합합니다.

• JSON/XML 반환 : 예외 처리 메서드가 ResponseEntity 또는 객체를 반환해 RESTful 응답을 제공합니다.

@RestControllerAdvice
public class GlobalRestExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<Map<String, Object>> handleRuntimeException(RuntimeException ex) {
        Map<String, Object> response = new HashMap<>();
        response.put("error", ex.getMessage());
        response.put("status", HttpStatus.BAD_REQUEST.value());
        return ResponseEntity.badRequest().body(response);
    }
}

📚 트러블슈팅 및 기대효과

No response

🔗 관련 자료

No response

🙋‍ 담당자

• 백엔드: 이름
• 프로트엔드: 이름
• 디자인: 이름

[Chuseok22]

잘 읽었습니다~