[내일배움캠프_Spring Boot 심화주차] API 예외처리

API 예외처리

예외처리가 중요한 이유
1. 웹 애플리케이션의 에러를 클라이언트와 서버가 모두 잘 알지 못하면, 서비스 환경에서 발생하는 에러에 대해 제대로 대응할 수 없음
2. 에러 처리도 관심사 분리(AOP)를 통해 더 효율적으로 처리 가능

웹 애플리케이션의 에러

HTTP 메시지 예시

Response 메시지

• start-line (상태줄): API 요청 결과 (상태 코드, 상태 텍스트)

HTTP/1.1 404 Not Found

• HTTP 상태 코드 종류
  • 2xx Success: 200번대의 상태코드는 성공 의미
  • 4xx Client Error: 400번대의 상태코드는 클라이언트 에러, 즉 잘못된 요청 의미
  • 5xx Server Error: 500번대의 상태코드는 서버 에러, 즉 정확한 요청에 서버쪽 사유로 에러가 난 상황

Spring에서는 HttpStatus라는 편리한 enum 제공하고 있음

HttpStatus Enum

Spring 예외처리 방법

• 폴더 추가 API에 폴더 중복 발생하는 경우 상태코드 400과 에러 메시지 반환
• 응답도 더 신경써서 return 해주기 위해, Spring에서 제공하는 ResponseEntity 클래스 사용

ResponseEntity는 HTTP response object를 위한 Wrapper로, 아래와 같은 것들을 담아서 response로 내려주면 간편하게 처리 가능
- HTTP status code
- HTTP headers
- HTTP body

• Spring에서는 내부적으로 AOP 기능이 동작하고 있는 에러 처리 방법 애너테이션을 제공해줌 → ExceptionHandler 애너테이션 제공
• ExceptionHandler 애너테이션은 Controller에서 발생한 예외를 잡아챔
• 또한, 모든 메서드에 try-catch문으로 예외처리할 필요 없음

1. Controller 코드 수정

• RestApiException 클래스 생성

package com.sparta.myselectshop.exception;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public class RestApiException {
    private String errorMessage;
    private int statusCode;
}

• FolderController에 ExceptionHandler 애너테이션 추가

@RestController
@RequestMapping("/api")
@RequiredArgsConstructor
public class FolderController {

    private final FolderService folderService;

    @PostMapping("/folders")
    public void addFolders(@RequestBody FolderRequestDto folderRequestDto, @AuthenticationPrincipal UserDetailsImpl userDetails) {
        List<String> folderNames = folderRequestDto.getFolderNames();

        folderService.addFolders(folderNames, userDetails.getUser());
    }

    @GetMapping("/folders")
    public List<FolderResponseDto> getFolders(@AuthenticationPrincipal UserDetailsImpl userDetails) {
        return folderService.getFolders(userDetails.getUser());
    }

    @ExceptionHandler({IllegalArgumentException.class}) // Controller에서 IllegalArgumentException이 발생했을 때 수행
    public ResponseEntity<RestApiException> handleException(IllegalArgumentException ex) {
        RestApiException restApiException = new RestApiException(ex.getMessage(), HttpStatus.BAD_REQUEST.value());
        return new ResponseEntity<>(
                // HTTP body
                restApiException,
                // HTTP status code
                HttpStatus.BAD_REQUEST
        );
    }
}

예외처리 적용 예시

---

Spring의 Global 예외처리

Spring에서 전체 Controller에 ExceptionHandler를 각각 만들어서 처리하는게 아니라 한 번에 처리해주는 방법을 제공하고 있음

// exception > GlobalExceptionHandler.java

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({IllegalArgumentException.class})
    public ResponseEntity<RestApiException> handleException(IllegalArgumentException ex) {
        RestApiException restApiException = new RestApiException(ex.getMessage(), HttpStatus.BAD_REQUEST.value());
        return new ResponseEntity<>(
                // HTTP body
                restApiException,
                // HTTP status code
                HttpStatus.BAD_REQUEST
        );
    }
}

• @RestControllerAdvice 애너테이션이 공통적으로 처리해주기 위한 스프링에서 제공하는 애너테이션임
• 해당 애너테이션을 달면, 모든 Controller에서 발생하는 모든 예외 처리들을 전부 잡아옴

@ControllerAdvice

• @ControllerAdvice는 클래스 레벨 단위의 애너테이션임

---

Error 메시지 관리하기

Spring의 Properties 파일을 이용해서 Error 메시지 관리할 수 있음

• key=value 형식으로 원하는 메시지를 넣어놓고 사용하면됨

1. resources > messages.properties 추가

below.min.my.price=최저 희망가는 최소 {0}원 이상으로 설정해 주세요.
not.found.product=해당 상품이 존재하지 않습니다.

 

2. ProductService 내에 적용

• messages.properties에 있는 값은 messageSource 클래스 사용해서 적용 가능

private final MessageSource messageSource; // Bean 주입받아 사용

@Service
@RequiredArgsConstructor
public class ProductService {

    ...
    private final MessageSource messageSource;

    public static final int MIN_MY_PRICE = 100;

	...

    @Transactional // Dirty Checking 수행
    public ProductResponseDto updateProduct(Long id, ProductMypriceRequestDto requestDto) {
        int myprice = requestDto.getMyprice(); // myprice 가격 가져오기(조건: myprice가 100원 이상이어야함)

        if(myprice < MIN_MY_PRICE) {
            throw new IllegalArgumentException(
                    messageSource.getMessage(
                           "below.min.my.price", // key 부분
                            new Integer[]{MIN_MY_PRICE}, // value인 메시지 내에서 사용할 매개변수를 사용할 경우, 전달할 값
                            "Wrong Price", // defaultMessage로 code 부분을 찾을 수 없는 경우 사용됨
                            Locale.getDefault() // 언어 설정
                    )
            );
        }

        ...

        return new ProductResponseDto(product);
    }

   	...
}

• IllegalArgumentException이나 NullPointException과 같이 미리 만들어져 있는 RuntimeException 말고도 Custom 가능함
  - Exception 클래스 상속받아 Custom

package com.sparta.myselectshop.exception;

public class ProductNotFoundException extends RuntimeException{

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

@Transactional // Dirty Checking 수행
public ProductResponseDto updateProduct(Long id, ProductMypriceRequestDto requestDto) {
    int myprice = requestDto.getMyprice(); // myprice 가격 가져오기(조건: myprice가 100원 이상이어야함)

    if(myprice < MIN_MY_PRICE) {
        throw new IllegalArgumentException(
                messageSource.getMessage(
                       "below.min.my.price", // key 부분
                        new Integer[]{MIN_MY_PRICE}, // value인 메시지 내에서 사용할 매개변수를 사용할 경우, 전달할 값
                        "Wrong Price", // defaultMessage로 code 부분을 찾을 수 없는 경우 사용됨
                        Locale.getDefault() // 언어 설정(번역)
                )
        );
    }

    // 해당 상품이 존재하는지 확인
    Product product = productRepository.findById(id).orElseThrow(() ->
            new ProductNotFoundException(messageSource.getMessage(
                    "not.found.product",
                    null,
                    "Not Found Product",
                    Locale.getDefault()
            )));

    product.update(requestDto); // 업데이트 메서드 수행

    return new ProductResponseDto(product);
}

 

3. GlobalExceptionHandler에 추가

package com.sparta.myselectshop.exception;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({IllegalArgumentException.class})
    public ResponseEntity<RestApiException> illegalArgumentExceptionHandler(IllegalArgumentException ex) {
        RestApiException restApiException = new RestApiException(ex.getMessage(), HttpStatus.BAD_REQUEST.value());
        return new ResponseEntity<>(
                // HTTP body
                restApiException,
                // HTTP status code
                HttpStatus.BAD_REQUEST
        );
    }

    @ExceptionHandler({NullPointerException.class})
    public ResponseEntity<RestApiException> nullPointerExceptionHandler(NullPointerException ex) {
        RestApiException restApiException = new RestApiException(ex.getMessage(), HttpStatus.NOT_FOUND.value());
        return new ResponseEntity<>(
                // HTTP body
                restApiException,
                // HTTP status code
                HttpStatus.NOT_FOUND
        );
    }

    @ExceptionHandler({ProductNotFoundException.class})
    public ResponseEntity<RestApiException> notFoundProductExceptionHandler(ProductNotFoundException ex) {
        RestApiException restApiException = new RestApiException(ex.getMessage(), HttpStatus.NOT_FOUND.value());
        return new ResponseEntity<>(
                // HTTP body
                restApiException,
                // HTTP status code
                HttpStatus.NOT_FOUND
        );
    }
}

에러 처리 결과