6주차 - 예외 처리

경희대학교 컴퓨터공학부 하계 리턴 백엔드(스프링부트) 스터디 6주차 - 트랙장 최현영

예외 처리
1. 자바에서는 대개 Try~ Catch, Throw, Throws 로 예외를 처리한다.
2. 예외[Exception]
  1. 입력 값의 처리가 불가능하거나, 참조된값이 잘못된 경우 등으로 애플리케이션이 정상적으로 동작하지 못하는 상황을 의미한다.
    1. 예외는 개발자가 직접 조작을 할 수 있는 오류로, 미리 Try~Catch문을 활용하여 조작이 가능하다.
3. 에러[Error]
  1. 개발자가 처리할 수 없다.
  2. StackOverFlow, OutOfMemory 등과 같은 에러는 하드웨어 리소스와 관련한 문제가 대표적인 에러의 예이다.
    1. 하드웨어 자원을 늘이던가, 최적화 기법으로 자원의 낭비를 방지하는 쪽으로 비지니스 로직을 구현해야 한다.
예외 클래스

https://velog.io/@codepark_kr/자바-이론-예외-처리
- 모든 예외 클래스는 Throwalbe 클래스를 상속받는다. 그중에 Exception 클래스는 RuntimeException을 비롯한 정말 다양한 자식 예외 클래스를 지니고 있다.
Checked / Unchecked Exception
1. Checked Exception
  1. 컴파일 단계에서 확인이 가능하고 예외 처리가 가능한 Exception
  2. 대개, Input/Output Stream[키보드 입력 및 모니터 출력]과 관련하여 알고리즘과 같은 입출력을 하려고 할때, 인텔리제이 또는 이클립스에서 IOException을 throws하라고 예외처리하라고 빨간줄 쳐진걸 본 경험이 있을텐데, IOException이 Checked Exception이기 때문이다.
2. Unchecked Exception
  1. 웹 애플리케이션이 실행되고 있는 도중에 발생할 수 있는 Exception이다.
  2. 실행 중에 발생할 수 있는 예외이기 때문에, 비지니스 로직을 짤 때 try부터 감싸고 본다. [클린코드 발췌]
  3. RuntimeException, NullPointerException, illegalArgumentException이 대표적인 Unchecked Exception이다.
예외처리를 해보자
1. 예외처리를 하는 방법은 대개, try{ ~ } catch(Exception e){ ~~} 구문을 사용한다.
2. 스프링 부트에서 예외처리를 한다고 했을 때, 클라이언트의 요청이 예외를 발생시키면, 예외 처리된 내용이 다시 클라이언트의 응답으로 가야한다.
  1. 왜냐면, 뭐가 문제인지 알아야하기 때문에><
3. 예외가 발생했을 때, 클라이언트에 오류 메시지를 전달하려면 각 레이어[서비스 레이어, 리파지토리 레이어 등]에서 발생한 예외를 엔드포인트[프레젠테이션(컨트롤러) 레이어]에 전달해야한다.
  1. @RestControllerAdvice와 @ExceptionHandler를 통해 모든 컨트롤러 레이어의 예외를 처리할 수 있다.

핸들러 클래스

5주차에서 우리는 Validation 실습을 진행할 때, 콘솔 로그에서 MethodArgumentNotValidException이 발생한 것을 살펴볼 수 있다.
- BindingExceptoin을 부모 클래스로 가지고 있는데,
- BindingException은 BindingResult 클래스를 참조 필드로 가지고 있다. 따라서, BindingResult를 활용하여 Dto에서 어떤 필드가 유효하지 않는지 가져올 수 있다.
- 기존에는 클라이언트에게 어떤 필드에서 유효하지 않았는지 보여주지 않았으나, ExceptionHandler를 통해 응답으로 줄 수 있다.

MethodArgumentNotValidException 예외 핸들러 실습

그전에, 우선, 예외를 응답으로 반환하기 위해 ExceptionResponseDto를 생성하자.

package com.rebe.returnstudy.DTO;

import com.rebe.returnstudy.Exception.ErrCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

import java.util.HashMap;

@Getter
@Setter
@NoArgsConstructor
public class ExceptionResponseDto {

    private int status;

    private Object message;
	
		//RuntimeException을 위한 생성자
    public ExceptionResponseDto(ErrCode errCode) {
        this.message = errCode.getMessage();
        this.status = errCode.getStatus();
    }
		
		//MethodArgumentNotValidException를 위한 생성자
    public ExceptionResponseDto(int status, HashMap<String, String> message){
        this.status = status;
        this.message = message;
    }
}

그리고, 어떤 커스텀 예외가 발생했는지 HttpStatusCode와 Message를 담아주기 위한 에러코드를 생성하기 위해 ErrCode 열거형을생성해 주자.

새 패키지 하나 만들어 주고, 열거식과 더불어, 각각의 상수 필드를 가지도록 Message와 status를 final로 선언해 주자.

package com.rebe.returnstudy.Exception;

import lombok.*;
import org.springframework.http.HttpStatus;

@Getter
@AllArgsConstructor
public enum ErrCode {
    NOT_FOUND_MEMBER( "유저정보를 찾을 수 없습니다.", HttpStatus.NOT_FOUND.value()),
    NOT_FOUND_POST( "게시글 정보를 찾을 수 없습니다.", HttpStatus.NOT_FOUND.value());

    private final String message;
    private final int status;
}

다음으로 @RestControllerAdvice와 @ExceptionHandler를 통해 전체 컨트롤러 클래스[엔드포인트]의 예외를 한곳에서 관리하도록 해주는 클래스를 작성하자

package com.rebe.returnstudy.Exception;

import com.rebe.returnstudy.DTO.ExceptionResponseDto;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;

@RestControllerAdvice
@Slf4j
public class RestControllerAdvisor {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public ResponseEntity<ExceptionResponseDto> handleMethodArgumentNotValidException(MethodArgumentNotValidException methodArgumentNotValidException){
        BindingResult bindingResult = methodArgumentNotValidException.getBindingResult();
        log.warn(methodArgumentNotValidException.getMessage());
        HashMap<String, String> response = new HashMap<>();
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            String responseMessage = fieldError.getDefaultMessage() +
                    ", 입력된 값: [" +
                    fieldError.getRejectedValue() +
                    "]";
            response.put(fieldError.getField(), responseMessage);
        }
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new ExceptionResponseDto(HttpStatus.BAD_REQUEST.value(), response));

    }
}

@RestControllerAdvice는 예외를 핸들링해주는 어노테이션으로, 컨트롤러 클래스에서 발생하는 예외를 한 곳에서 관리하고 처리할 수있게 해주는 기능을 수행한다.
@ExceptionHandler는 @RestController 어노테이션이 적용된 빈에서 예외를 잡아 처리하는 메서드를 정의할 때 사용한다.
- 어떤 예외를 처리할지는 value 속성으로 지정해 줄 수 있다.
- 위에서 정의한 handleMethodArgumentNotValidException 메서드는 value=MethodArgumentNotValidException.class 로 지정해 주었으므로, 해당 예외가 발생했을 때, 호출되는 메서드인 것이다.
- 그리고 요청을 보내면, 어떤 필드가 유효성 검사에서 실패했는지 응답으로 반환된다.

CustomException 실습

우리는 애플리케이션이 구동 중에 RuntimeException이 발생할 것을 사전에 고려하고, RuntimeException을 상속받는 CustomException을 우선적으로 생성한 뒤, 임의로 예외를 발동시켜[throw 하겠다는 뜻] 클라이언트에게 잘못된 요청이라고 응답으로 반환할 것이다.

package com.rebe.returnstudy.Exception;

import lombok.Getter;
import org.springframework.http.HttpStatus;

@Getter
public class CustomException extends RuntimeException{
    private final ErrCode errCode;

    private final HttpStatus httpStatus;

    public CustomException(final ErrCode errCode, final HttpStatus status) {
        super(errCode.getMessage());
        this.errCode = errCode;
        this.httpStatus = status;
    }

    
}

ErrCode에서 정의된 열거식들을 사용하기 위해, ErrCode와 HttpStatuscode를 상수 필드[final]로 가지도록 하자.
그리고 RestControllerAdvisor에 CustomeException를 핸들링하도록 추가해주자.

//RestControllerAdvisor
...
@ExceptionHandler(value = CustomException.class)
    public ResponseEntity<ExceptionResponseDto> handleCustomeException(CustomException customException){
        log.warn(customException.getMessage());
        return ResponseEntity.status(customException.getHttpStatus())
                .body(new ExceptionResponseDto(customException.getErrCode()));

    }

비지니스 로직 실습
1. MemberService.class
- Optional 객체 덕분에 존재하지 않는다면 throw 시켜 줌으로써, 예외처리 핸들러에게 처리하도록 위임하고, 정상적으로 Custom Exception Response가 실행된다.
b. PostSerivce.class
- MemberService와 마찬가지이다.
정리
1. 클라이언트[프론트엔드]와의 예외 통신은 정해진 규약으로 수행되어야한다. 서로간의 예외 Code를 정의하여 프론트엔드의 예외처리에 차질이 없도록 해주어야 한다.
  1. 아래 참고
2. 예시)