📌예외처리

지금까지 사용한 예외처리 방식

// MemberController
@GetMapping("/members/{memberId}")
public ResponseEntity<GetMemberResponse> getMember(
        @PathVariable Long memberId
) {
    return ResponseEntity.status(HttpStatus.OK).body(memberService.findOne(memberId));
}

• 조회가 잘 되면 ok를 날린다.

// MemberService
@Transactional(readOnly = true)
public GetMemberResponse findOne(Long memberId) {
    Member member = memberRepository.findById(memberId).orElseThrow(
            () -> new IllegalStateException("없는 멤버입니다.")
    );
    return new GetMemberResponse(
            member.getId(),
            member.getNickname()
    );
}

• 조회할 id가 없다면 IllegalStateException("없는 멤버입니다.") 를 날려준다.

여기서 일부러 에러를 발생시키면

• 500에러가 발생한다. 멤버를 잘못 호출한 것은 서버의 잘못이 아닌 클라이언트의 잘못이기 때문에 500이 아닌 400에러 코드가 떠야 한다.

• 자바의 try-catch문으로 예외처리를 할 수 있지만 스프링에서는 에러를 3가지 방법으로 핸들링할 수 있다.

스프링 예외 처리 전략 3가지
1. @ExceptionHandler
2. @RestControllerAdvice
3. Spring 기본 예외 처리

이렇게 3가지가 있고 동시에 존재할 경우 1 > 2 > 3 순서대로 우선 순위를 가진다.

1. @ExceptionHandler - 컨트롤러별 예외 처리

• 예외 처리 메서드를 작성한 컨트롤러에서만 발생하는 예외를 처리한다.

@Service
@RequiredArgsConstructor
public class MemberService {

  @Transactional
      public GetAllMemberResponseDto findOne(Long id) {
          Member member = memberRepository.findById(id).orElseThrow(
                  () -> new IllegalStateException("없는 멤버입니다.")
          );
          return GetAllMemberResponseDto.from(member);
      }

@RestController
@RequiredArgsConstructor
public class MemberController {
    
    private final MemberService memberService;
        
    @GetMapping("/members/{memberId}")
    public ResponseEntity<GetMemberResponse> getMember(
            @PathVariable Long memberId
    ) {
        return ResponseEntity.status(HttpStatus.OK).body(memberService.findOne(memberId));
    }
        
    // 🚨 예외 처리 메서드
    @ExceptionHandler(IllegalStateException.class)
    public ResponseEntity<String> handlerIllegalStateException(IllegalStateException e) {
        return ResponseEntity
                .status(HttpStatus.BAD_REQUEST)
                .body("요청 오류: " + e.getMessage());
    }
}

• 요청 오류: : 서비스에서 던진 IllegalStateException 에러 메시지인 "없는 멤버입니다."가 반환된다.

• 예외 처리 메서드의 ResponseEntity에 설정한 대로 (.status(HttpStatus.BAD_REQUEST) 400 Bad Request로 에러 코드가 응답된다.

하지만 이렇게 개별적으로 컨트롤러마다 @ExceptionHandler를 설정하는 방법은 잘 사용하지 않는다. 이유는 컨트롤러마다 예외처리를 작성하면 중복이 심해진다.

중복이 심해진다는 말은 멤버 컨트롤러에서 @ExceptionHandler가 있고 일정 컨트롤러에도 @ExceptionHandler이 있으면 나중에 컨트롤러가 생기면 생길수록 중복이 심해진다는 의미이다.

따라서 프로젝트에 전체적으로 적용할 수 잇는 전역 예외 처리기를 만들어 처리하면 된다.

그것이 @RestControllerAdvice 방식이다. (이 방식이 가장 많이 사용된다.)

2. @RestControllerAdvice - 전역 예외 처리(중요!)

• 모든 컨트롤러의 예외를 한 곳에서 처리한다.

@RestControllerAdvice
public class GlobalExceptionHandler {
    
    // 🎯 커스텀 비즈니스 예외 처리
    @ExceptionHandler(IllegalStateException.class)
    public ResponseEntity<String> handleIllegalStateException(IllegalStateException e) {
        return ResponseEntity
                .status(HttpStatus.BAD_REQUEST)
                .body("요청 오류: " + e.getMessage());
    }
}

• 프로젝트 member패키지안에 config패키지를 만들어 GlobalExceptionHandler 클래스를 만들었다.
• 이처럼 @RestControllerAdvice 어노테이션을 활용한다면, 위 코드처럼 전역적으로 IllegalStateException 에러가 발생한 상황에 대해 모든 API 응답에 공통된 에러 응답을 던진다.

3. 커스텀 에러

• 지금까지 우리는 에러를 던질 때, IllegalStateException에러를 사용했다.
• IllegalStateException 같은 자바 기본 예외는 너무 범용적이여서 "게시글이 존재하지 않는 상황"을 예외로 표현하면 나중에 코드를 볼 때 이게 왜 발생했는지 한 눈에 파악하기 어렵다.

그렇기 때문에 상황에 딱 맞는 예외를 직접 만들어서 사용한다.

1. 먼저 RuntimeException을 상속받아서 우리만의 예외 클래스를 만든다.

package com.example.scheduledevelop.exception;

import org.springframework.http.HttpStatus;

public class ScheduleNotFoundException extends RuntimeException {


    public ScheduleNotFoundException(String message) {
        super(message);
    }
}

RuntimeException을 상속해야 한다.

@Transactional(readOnly = true)
    public FindByOneResponseDto findOne(Long id) {
        Schedule schedule = scheduleRepository.findById(id).orElseThrow(
                () -> new ScheduleNotFoundException("없는 일정입니다.")
        );
        return FindByOneResponseDto.from(schedule);
    }

• 서비스 클래스에서 에러를 던지는 부분을 기본 에러가 아닌 내가 만든 커스텀 에러를 던져준다.
• 이제 GlobalExceptionHandler로 커스텀 에러를 핸드링 할 수 있다.

위에 같이 하면 문제가 생긴다.

• 이름이 Global인데 Global하지 않다는 것이다.

• 앞으로 ScheduleNotFoundException뿐만 아니라 앞으로 수백 수천가지 이상의 커스텀 에러가 생길 텐데, 그 때마다 GlobalExceptionHandler에 하나하나 따로따로 만들어 줘야 한다.

• 위의 코드보면 HttpsStatus.Not_Found로 고정되어있기도하다.

• 이를 위해 공통된 부모 에러 타입을 하나 더추가하면 된다.

공통 부모 커스텀 에러 타입 만들기

package com.example.scheduledevelop.exception;

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

@Getter
public class ServiceException extends RuntimeException {

    // 예외 발생 시 반환할 HTTP 응답 상태 코드
    private final HttpStatus status;

    public ServiceException(HttpStatus status, String message) {
        super(message);
        this.status = status;
    }
}

• 공통 상위 커스텀 에러 클래스
• ServiceExcetion이라는 공통 부모를 두어 상태 코드(HttpStatus)를 관리하게 해서 새롱룬 예외가 추가되어도 GlobalExceptionHandler를 수정할 필요가 없다.

package com.example.scheduledevelop.exception;

import org.springframework.http.HttpStatus;

public class ScheduleNotFoundException extends ServiceException {

    public ScheduleNotFoundException(String message) {
        super(HttpStatus.NOT_FOUND, message);
    }
}

• ServiceException을 상속해야 한다.
• 이 코드는 구체적인 에러로 일정 id를 못찾았을 경우 발생하는 에러이다.
• 부모에게 404(NOT_FOUND) 상태를 고정적으로 전달한다.
  
  

@Transactional(readOnly = true)
    public FindByOneResponseDto findOne(Long id) {
        Schedule schedule = scheduleRepository.findById(id).orElseThrow(
                () -> new ScheduleNotFoundException("없는 일정입니다.")
        );
        return FindByOneResponseDto.from(schedule);
    }

• 에러를 던지는 코드 부분에서 새로 만든 커스텀 에러를 던진다.

@RestControllerAdvice
public class GlobalExceptionHandler {
 @ExceptionHandler(ServiceException.class)
    public ResponseEntity<String> handleServiceException(ServiceException e) {
        return ResponseEntity
                .status(e.getStatus())
                .body(e.getMessage());
    }

• GlobalExceptionHandle로 커스텀 에러들을 단 하나의 메서드로 모두 핸들링할 수 있다.

// extends ServerException 중요!
public class DuplicateEmailException extends ServiceException {
    public DuplicateEmailException(String message) {
        super(HttpStatus.BAD_REQUEST, message);
    }
}

• DuplicateEmailException(이메일 중복 에러)이라는 에러를 만들고 에러 코드를 400으로 리턴하게 하고 DuplicateEmailException을 비즈니스 로직에서 사용하기만 하면 된다.