🌈 [Section3] 4. [ Spring MVC ] 예외 처리

📕 오늘 배운 내용!

• @ExceptionHandler
• @RestControllerAdvice
• 예외 Throw / Catch
• Custom Exception

---

✏️ @ExceptionHandler 예외 처리

애플리케이션에서 예외(Exception)가 발생했을 때, 내부적으로 Spring에서 예외를 처리하여 클라이언트의 응답으로 에러 메세지를 보내주는데,

이 때 클라이언트는 어디에서 예외가 발생했는지 쉽게 알 수 없음

➜ @ExceptionHandler 사용하여 에러 응답 메세지를 직접 작성하여 응답으로 보내줄 수 있음 !

• Controller 레벨에서만 사용
• 예외처리를 할 핸들러 메서드를 작성하고, 그 위에 @Exception 애너테이션을 붙여 에러 메세지를 구체적으로 전송 가능

( But, 위의 경우 에러 정보 뿐만 아니라 Response Body 전체 정보까지 전달됨 ! )

➜ 공통되는 에러는 ErrorResponse 클래스를 따로 만들어 DTO 클래스의 유효성 검증 실패 시, 실패한 필드(멤버 변수)에 대한 Error 정보만 담아서 그 클래스 내의 FieldError 클래스로 응답으로 전송 가능

➜ 이 경우, 에러가 여러개가 될 수 있기 때문에, 핸들러 메서드 내에서 FieldError 클래스는 List 객체를 이용하여 에러 정보를 담고 넘겨줄 수 있음

✔️ ErrorResponse 클래스
➜ 에러 검사할 항목 정리하는 클래스

 

✔️ @ExceptionHandler의 단점

1. 각 클래스마다 @Exception 애너테이션을 사용하여 에러 처리를 해야하므로
   각 Controller 클래스마다 코드의 중복이 발생

2. 하나의 Controller 클래스 내에 처리해야할 예외가 유효성 검증 실패에 대한 예외(MethodArgumentNotValidException)만 있는것이 아니기 때문에,
   하나의 Controller 클래스 내에 @ExceptionHandler를 추가한 에러 처리 핸들러 메서드가 늘어남

Ex. patchMember() 핸들러 메서드의 URI 변수인 “/{member-id}”에 0이 넘어올 경우,
ConstraintViolationException이 발생

➜ 그 Controller 클래스 안에는 유효성 검사 핸들러 메서드 + 이 예외를 처리할 핸들러 메서드 이렇게 두개가 생김

---

✏️ @RestControllerAdvice를 사용한 예외 처리 공통화

• Controller 클래스 내에서 예외 처리를 하는 대신 @RestControllerAdvice 애너테이션 사용하여 새로 클래스 만들면,
  그 클래스에서 예외 처리를 공통화하여 여러 Controller 클래스에서@ExceptionHandler/@InitBinder/@ModelAttribute가 붙은 메서드 공유하여 사용 가능

💡 @InitBinder / @ModelAttribute 애너테이션
➜ 주로 서버 사이드 렌더링(SSR, Server Side Rendering) 방식에서 사용되는 방식
Ex. JSP, Thymeleaf

• @RestControllerAdvice가 붙은 클래스에는 @ExceptionHandler 애너테이션이 붙었던 에러 처리 핸들러 메서드들을 넣으면 됨
• 각 컨트롤러마다 발견되는 에러를 @RestControllerAdvice가 처리

✔️ @RestControllerAdvice 애너테이션이 붙은 클래스
➜ 각 핸들러 메세지의 에러 응답 전달하는 클래스

• 이 클래스에는 @ResponseStatus 애너테이션이 붙을 수 있음
  ( ResponseEntity로 데이터 래핑하는 경우에는 사용 X / ErrorResponse로 래핑하는 경우에만 사용 )

✔️ @ResponseStatus 애너테이션
➜ HTTP Status를 대신 표현
Ex. @ResponseStatus(HttpStatus.BAD_REQUEST)

💡 @RestControllerAdvice vs @ControllerAdvice

- @RestControllerAdvice = @ControllerAdvice + @ResponseBody
⠀
➜ @RestControllerAdvice 애너테이션은 JSON 형식의 데이터를 Response Body로 전송하기 위해서 ResponseEntity로 데이터를 래핑할 필요가 없음

 

✔️ of() 메서드

• 네이밍 컨벤션(Naming Convention)
• 객체 생성시 어떤 값들의(of~) 객체를 생성한다는 의미
• 생성자에 private 접근 제어자가 붙었을 경우, 각 역할 구분을 위해
  생성자와 같은 역할을 하는 객체를 생성할 때 사용
  ⠀
• Ex. ErrorResponse of(BindingResult bindingResult)
  ➜ An ErrorResponse instance is made of BindingResult object

---

✏️ 예외 던지기(throw) 및 예외 처리

✔️ 체크 예외 (Checked Exception)

• 발생한 예외를 잡아서(catch) 체크한 후에 해당 예외를 복구 하든가 아니면 회피 하든가 등의 어떤 구체적인 처리를 해야 하는 예외
  
  

✔️ 언체크 예외 (Unchecked Exception)

• 예외를 잡아서(catch) 해당 예외에 대한 어떤 처리를 할 필요가 없는 예외
• RuntimeException이 이에 해당 ( 이를 상속받은 하위 클래스도 모두 )
  
  

❗ Java나 Spring에서 수많은 RuntimeException을 지원해주지만, 개발자가 직접 예외(Exception)를 만들어야 할 경우도 있음 !

➜ 예외를 던진다고 함

 

✔ 의도적으로 예외를 던질 수(throw) 있는 상황

• 백엔드 서버와 외부 시스템과의 연동에서 발생하는 에러 처리
  ➜ 백엔드 서버 쪽에서 예외를 의도적으로 던져서 클라이언트 쪽에 에러가 발생한 정보를 알려줄 수 있음
  
  
• 시스템 내부에서 조회하려는 리소스(자원, Resource)가 없는 경우
  ➜ 서비스 계층에서 해당 회원 정보가 없다는 예외를 의도적으로 전송해서 클라이언트 쪽에 알려줄 수 있음

 

✔ 예외 던지기 & 처리 과정

1. 클라이언트가 Controller의 해당 핸들러 메서드로 요청 보냄

2. 예외가 발생한다면, Service 클래스에서 RuntimeException을 던짐

Service 클래스 내의 해당 핸들러 메서드에는
throw키워드 사용하여 RuntimeException 객체에 적절한 예외 메시지를 포함
⠀
Ex. throw new RuntimeException("Not found member");
throw new BusinessLogicException(ExceptionCode.MEMBER_NOT_FOUND);

3. @RestControllerAdvice 애너테이션이 붙은 클래스의 해당 예외의 응답을 구현하고 있는 메서드에서 그 throw한 예외를 catch하여 같이 날라온 예외 메세지를 출력해줌

---

✏️ 사용자 정의 예외(Custom Exception)

• 상위 클래스인 RuntimeException을 반환하는 것이 아닌 그의 하위 클래스들인 더욱 구체적인 예외를 표현하기 위해 사용

 

✔ 적용 방법

1. class가 아닌 enum으로 서비스 계층에서 던질 Custom Exception에 사용할 ExceptionCode를 정의
   ➜ 비즈니스 로직에서 발생하는 다양한 유형의 예외를 enum에 추가해서 사용할 수 있음
   
   
2. 예외들을 정리한 ExceptionCode를 멤버 변수로 받고 RuntimeException을 상속받는 BusinessLogicException 클래스를 정의
   
   

( 이 때, 생성자에서 exceptionCode.getMessage()의 경우에는 상위 클래스의 생성자를 가져오는 것이기 때문에 supuer() 키워드 사용 )

❗ @RestControllerAdvice 애너테이션을 가지고 있는 클래스에는 ResponseEntity와 우리가 정의한 ErrorResponse 사용 가능

✔️ ResponseEntity
➜ 리턴값으로 HttpStatus를 동적으로 지정 가능
⠀
✔️ ErrorResponse
➜ 고정된 HttpStatus를 지정하기 때문에 @ResponseStatus 애너테이션으로 HttpStatus를 지정해줘야함

---

😜 실습

• projects 내의 be-template-exception-handle 파일
• git 내의 be-homework-exception 파일

---

🌈 느낀점

저번 학습까지는 따라가기 괜찮았는데 오늘은 갑자기 코드 양도 많아지면서 이해가 어려운 부분이 꽤 있었다 !!
그래도 페어 학습 하면서 페어님이 많이 알려주셔서 이해가 많이 되었다! 🙌
근데 하루하루 실습해보는 코드의 양이 많다보니 복습을 자주 해줘야 잊지 않을 것 같다 ㅠ

 

( 본 게시물은 2022/10/27에 작성한 글을 옮긴 글입니다. 원문은 요기에 있음! )

728x90