API 예외 처리
ExceptionResolver 적용 전
ExceptionResolver 적용 후
HandlerExceptionResolver
스프링 MVC는 컨트롤러(핸들러) 밖에서 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다
따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 난다
컨트롤러 밖에서 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver를 사용하면 된다
줄여서 ExceptionResolver라 한다
API 예외 처리 - @ExceptionHandler
ApiExceptionV2Controller
package hello.exception.exhandler;
import hello.exception.exception.UserException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
@Slf4j
@RestController
public class ApiExceptionV2Controller {
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandle(IllegalArgumentException e) {
log.error("[exceptionHandle] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {
log.error("[exceptionHandle] ex", e);
ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandle(Exception e) {
log.error("[exceptionHandle] ex", e);
return new ErrorResult("EX", "내부 오류");
}
@GetMapping("/api2/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
if (id.equals("bad")) {
throw new IllegalArgumentException("잘못된 입력 값");
}
if (id.equals("user-ex")) {
throw new UserException("사용자 오류");
}
return new MemberDto(id, "hello " + id);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String memberId;
private String name;
}
}
ErrorResult
package hello.exception.exhandler;
import lombok.AllArgsConstructor;
import lombok.Data;
@Data
@AllArgsConstructor
public class ErrorResult {
private String code;
private String message;
}
@ExceptionHandler 예외 처리 방법
@ExceptionHandler애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다
지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다
우선순위
- 스프링의 우선순위는 항상 자세한 것이 우선권을 가진다
@ExceptionHandler(부모예외.class)
public String 부모예외처리()(부모예외 e) {}
@ExceptionHandler(자식예외.class)
public String 자식예외처리()(자식예외 e) {}
@ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다따라서 자식예외 가 발생하면 부모예외처리() , 자식예외처리() 둘다 호출 대상이 된다
그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리() 가 호출된다
물론 부모예외 가 호출되면 부모예외처리() 만 호출 대상이 되므로 부모예외처리() 가 호출된다
다양한 예외
@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
log.info("exception e", e);
}
- 다음과 같이 다양한 예외를 한번에 처리할 수 있다
예외 생략
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {}
@ExceptionHandler에 예외를 생략할 수 있다생략하면 메서드 파라미터의 예외가 지정된다
파리미터와 응답
@ExceptionHandler에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다자세한 파라미터와 응답은 다음 공식 메뉴얼을 참고하자
IllegalArgumentException 처리 실행흐름
컨트롤러를 호출한 결과 IllegalArgumentException 예외가 컨트롤러 밖으로 던져진다
예외가 발생했으로 ExceptionResolver 가 작동한다
가장 우선순위가 높은 ExceptionHandlerExceptionResolver 가 실행된다
ExceptionHandlerExceptionResolver 는 해당 컨트롤러에 IllegalArgumentException 을 처리할 수 있는
@ExceptionHandler가 있는지 확인한다illegalExHandle() 를 실행한다
@RestController이므로 illegalExHandle() 에도@ResponseBody가 적용된다.따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환된다
@ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTTP 상태 코드 400으로 응답한다
IllegalArgumentException 처리 결과
{
"code": "BAD",
"message": "잘못된 입력 값"
}
UserException 처리 실행흐름
@ExceptionHandler에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다여기서는 UserException 을 사용한다
ResponseEntity 를 사용해서 HTTP 메시지 바디에 직접 응답한다
물론 HTTP 컨버터가 사용된다
ResponseEntity 를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다
앞서 살펴본
@ResponseStatus는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다
Exception 처리 실행흐름
throw new RuntimeException("잘못된 사용자") 이 코드가 실행되면서, 컨트롤러 밖으로 RuntimeException이 던져진다
RuntimeException은 Exception의 자식 클래스이다. 따라서 이 메서드가 호출된다
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)로 HTTP 상태 코드를 500으로 응답한다
HTML 오류 화면
@ExceptionHandler(ViewException.class)
public ModelAndView ex(ViewException e) {
log.info("exception e", e);
return new ModelAndView("error");
}
- 다음과 같이 ModelAndView를 사용해서 오류 화면(HTML)을 응답하는데 사용할 수도 있다
API 예외 처리 - @ControllerAdvice
@ExceptionHandler를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다@ControllerAdvice또는@RestControllerAdvice를 사용하면 둘을 분리할 수 있다
ExControllerAdvice
package hello.exception.exhandler.advice;
import hello.exception.exception.UserException;
import hello.exception.exhandler.ErrorResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@Slf4j
@RestControllerAdvice
public class ExControllerAdvice {
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandle(IllegalArgumentException e) {
log.error("[exceptionHandle] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {
log.error("[exceptionHandle] ex", e);
ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandle(Exception e) {
log.error("[exceptionHandle] ex", e);
return new ErrorResult("EX", "내부 오류");
}
}
ApiExceptionV2Controller
package hello.exception.exhandler;
import hello.exception.exception.UserException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;
@Slf4j
@RestController
public class ApiExceptionV2Controller {
@GetMapping("/api2/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
if (id.equals("bad")) {
throw new IllegalArgumentException("잘못된 입력 값");
}
if (id.equals("user-ex")) {
throw new UserException("사용자 오류");
}
return new MemberDto(id, "hello " + id);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String memberId;
private String name;
}
}
@ControllerAdvice
@ControllerAdvice는 대상으로 지정한 여러 컨트롤러에@ExceptionHandler,@InitBinder기능을 부여해주는 역할을 한다
@ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다(글로벌 적용)@RestControllerAdvice는@ControllerAdvice와 같고,@ResponseBody가 추가되어 있다@Controller,@RestController의 차이와 같다
대상 컨트롤러 지정 방법
// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}
// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}
// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class,
AbstractController.class})
public class ExampleAdvice3 {}
스프링 공식 문서 예제에서 보는 것 처럼 특정 애노테이션이 있는 컨트롤러를 지정할 수 있고, 특정 패키지를 직접 지정할 수도 있다
패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다
그리고 특정 클래스를 지정할 수도 있다
대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다
스프링 공식 문서 참고
참고자료