API 예외 처리 - ResponseStatusExceptionResolver

API 예외 처리 - ResponseStatusExceptionResolver

ResponseStatusExceptionResolver는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.

다음 두 가지 경우를 처리한다.

1) @ResponseStatus가 달려있는 예외

2) ResponseStatusException 예외


@ResponseStatus가 달려있는 예외

예외에 다음과 같이 `@ResponseStatus` 애노테이션을 적용하면 HTTP 상태 코드를 변경해준다.

package hello.exception.exception;


import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad")
public class BadRequestException extends RuntimeException {
}

 

`BadRequestException` 예외가 컨트롤러 밖으로 넘어가면 `ResponseStatusExceptionResolver` 예외가 해

당 애노테이션을 확인해서 오류 코드를 `HttpStatus.BAD_REQUEST` (400)으로 변경하고, 메시지도 담는다.

ApiExceptionController - 추가

    @GetMapping("/api/response-status-ex1")
    public String responseStatusEx1(){
        throw  new BadRequestException();
    }

 

 

메시지 기능

`reason` 을 `MessageSource` 에서 찾는 기능도 제공한다. `reason = "error.bad"`

messages.properties

error.bad=잘못된 요청 오류입니다. 메시지 사용

 

postman
http://localhost:8080/api/response-status-ex1 

 
ResponseStatusException 예외

`@ResponseStatus` 는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (애노테이션을 직접 넣어야 하는데,

내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.)

예시

// 우리가 사용하는 라이브러리에서 발생하는 NullPointerException은 수정할 수 없으므로
// @ResponseStatus를 여기에 붙일 수 없음
public void someMethod() {
    throw new NullPointerException("Null value found");
}

추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 이때는`ResponseStatusException` 예외를 사용하면 된다.

ApiExceptionController - 추가

 

    @GetMapping("/api/response-status-ex2")
    public String responseStatusEx2(){
        throw new ResponseStatusException(HttpStatus.NOT_FOUND,"error.bad", new IllegalArgumentException());
    }

 

postman
http://localhost:8080/api/response-status-ex2