API 예외 처리
- 오류 페이지는 단순히 고객에게 오류 화면을 보여주면 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고 JSON으로 데이터를 보내야한다.
🔍 서블릿 오류 페이지 방식 (과거)
📌 API 예외 컨트롤러
package hello.exception.api;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
public class ApiExceptionController {
@GetMapping("/api/members/{id}")
public MemberDto getMember(@PathVariable String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
return new MemberDto(id, "hello " + id);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String memberId;
private String name;
}
}
- 단순히 회원 조회하는 기능을 만들었다.
- 예외 테스트를 위해 URL에 전달된 id 값이 ex면 예외가 발생하도록 코드를 작성했다.
💡 Postman으로 테스트
- 포스트맨으로 테스트할 때 HTTP Header에 Accept가 application/json으로 설정해야 한다.
📌 WebServerCustomizer
package hello.exception.servlet;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.RequestDispatcher;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;
@Slf4j
@Controller
public class ErrorPageController {
@RequestMapping("/error-page/500")
public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
log.info("errorPage 500");
printErrorInfo(request);
return "error-page/500";
}
@RequestMapping(value = "/error-page/500", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Map<String, Object>> errorPage500Api(
HttpServletRequest request,
HttpServletResponse response) {
log.info("API errorPage 500");
Map<String, Object> result = new HashMap<>();
Exception ex = (Exception) request.getAttribute(ERROR_EXCEPTION);
result.put("status", request.getAttribute(ERROR_STATUS_CODE));
result.put("message", ex.getMessage());
Integer statusCode = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
return new ResponseEntity<>(result, HttpStatus.valueOf(statusCode));
}
}
- WAS에 예외가 전달되거나, response.sendError()가 호출되면 위에 등록한 예외 페이지 경로가 호출된다.
- @RequestMapping(value = "/error-page/500", produces = MediaType.APPLICATION_JSON_VALUE)
- HTTP Header의 Accept의 값이 application/json일 때 해당 메서드가 호출된다는 것을 의미한다.
- 응답 데이터를 Map으로 만들고 statu, message 키에 값을 할당했다.
- Map보단 객체로 만들어주는 것이 더 나을 수도 있다.
- Jackson 라이브러리는 Map을 JSON구조로 변환할 수 있다.
- ResponseEntity를 사용해서 응답하기 때문에 메시지 컨버터가 동작하면서 클라이언트에 JSON으로 반환한다.
스프링 부트 기본 오류 처리
- 스프링 부트가 제공하는 BasicErrorController를 통해 API 오류 처리도 자동으로 해준다.
📌 BasicErrorController 코드 (일부분)
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request,
HttpServletResponse response) {}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}
- /error 경로의 에러를 처리하는 메서드가 2가지다.
- errorHtml()
- 클라이언트 요청의 Accept 헤더 값이 text/html인 경우 errorHtml() 메서드를 호출해서 view를 제공한다.
- error()
- Accept 헤더 값이 text/html 아닌 경우 eror() 메서드가 호출되고 ResponseEntity로 HTTP Body에 JSON 데이터를 반환한다.
- errorHtml()
🔍 오류 HTML 페이지 vs API 오류
- BasicErrorController를 확장하면 JSON 메시지를 변경할 수 있다. 그런데 API 오류는 @ExceptionHandler 애노테이션을 사용하는 것이 더 낫다.
- 스프링 부트가 제공하는 BasicErrorController는 오류 HTML 페이지를 제공하는 경우에는 매우 편리하다.
- 하지만 API 오류는 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. API 오류는 매우 세밀하고 복잡하기 때문에 @ExceptionHandler 애노테이션을 사용하는게 좋다.
API 예외 처리 - HandlerExceptionResolver
- HandlerExcpetionResolver를 통해 발생하는 예외에 따라서 400, 404 등등 다른 상태 코드로 처리할 수 있다.
- 오류 메시지, 형식 등을 API 마다 다르게 처리할 수도 있다.
- HandlerExceptionResolver를 줄여서 ExceptionResolver라고 부르기도 한다.
🔍 ExceptionResolver 동작 방식
💡 ExceptionResolver 적용 전
💡 ExceptionResolver 적용 후
- '5. 예외 해결 시도'에서 ExceptionResolver가 ModelAndView를 반환해서 정상 작동으로 바꿔놓는다.
- ExceptionResolver를 적용해도 postHandler() 메서드는 호출되지 않는다.
💡 HandlerExceptionResolver 인터페이스
📌 HandlerExceptionResolver 인터페이스
public interface HandlerExceptionResolver {
ModelAndView resolveException(
HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex);
}
- Object handler : 핸들러(컨트롤러) 정보
- Exception ex : 핸들러(컨트롤러)에서 발생한 예외
- ExceptionResolver가 ModelAndView를 반환하는 이유는 마치 try-catch 하듯이, Exception을 처리해서 정상 흐름처럼 변경하는 것이 목적이기 때문이다.
✔ ExceptionResolver가 ModelAndView를 반환한 이후 반환 값에 따른 DispatcherServlet의 동작 방식
- 비어있는 ModelAndView를 반환
- 뷰를 렌더링하지 않고, 정상 흐름으로 서블릿이 리턴된다.
- ModelAndView를 지정하여 반환
- ModelAndView에 들어있는 View, Model 등의 정보를 지정해서 반환하면 뷰를 렌더링한다.
- null 반환
- null을 반환하면 다음 ExceptionResolver를 찾아서 실행한다. 만약에 처리할 수 있는 ExceptionResolver가 없으면 예외처리가 안되고ㅡ 기존에 발생한 예외를 서블릿 밖으로 던진다.
✔ ExceptionResolver 활용
- 예외 상태 코드 반환
- 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태코드에 따른 오류를 처리하도록 위임한다.
- 이후 WAS는 서블릿 오류 페이지를 찾아서 내부에서 호출한다.
- 예를 들어서 기본으로 설정한 /error 가 호출된다.
- 뷰 템플릿 처리
- ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면의 뷰 렌더링을 해서 고객에게 제공할 수 있다.
- API 응답 처리
- response.getWriter().println("hello") 메서드 처럼 HTTP 응답 바디에 직접 데이터를 넣어줄 수 있다.
- 여기에 JSON으로 응답하면 API 응답 처리를 할 수 있다.
💡 사용법
📌 ApiExceptionController
package hello.exception.api;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
public class ApiExceptionController {
@GetMapping("/api/members/{id}")
public MemberDto getMember(@PathVariable String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
if (id.equals("bad")) {
throw new IllegalArgumentException("잘못된 입력 값");
}
return new MemberDto(id, "hello " + id);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String memberId;
private String name;
}
}
📌 MyHandlerExceptionResolver
package hello.exception.resolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
try {
if(ex instanceof IllegalArgumentException) {
log.info("IllegalArgumentException resolver to 400");
response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());
return new ModelAndView();
}
} catch (IOException e) {
log.error("resolver ex", e);
}
return null;
}
}
- IllegalArugmentException이 발생하면 response.sendError(400) 을 호출해서 HTTP 상태코드를 400으로 지정하고, 빈 ModelAndView를 반환한다.
📌 WebConfig (WebMvcConfigurer를 통해 등록)
package hello.exception;
import hello.exception.filter.LogFilter;
import hello.exception.interceptor.LogInterceptor;
import hello.exception.resolver.MyHandlerExceptionResolver;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import java.util.List;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
resolvers.add(new MyHandlerExceptionResolver());
}
}
- configureHandlerExceptionResolvers() 를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver가 제거되므로 extendHandlerExceptionResolvers() 를 사용해야 한다.
API 예외 - HandlerExceptionResolver 활용
📌 UserException (사용자 정의 예외)
package hello.exception.exception;
public class UserException extends RuntimeException{
public UserException() {
super();
}
public UserException(String message) {
super(message);
}
public UserException(String message, Throwable cause) {
super(message, cause);
}
public UserException(Throwable cause) {
super(cause);
}
protected UserException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
super(message, cause, enableSuppression, writableStackTrace);
}
}
📌 ApiExceptionController (예외 추가)
package hello.exception.api;
import hello.exception.exception.UserException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
public class ApiExceptionController {
@GetMapping("/api/members/{id}")
public MemberDto getMember(@PathVariable 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;
}
}
📌 UserHandlerExceptionResolver
package hello.exception.resolver;
import com.fasterxml.jackson.databind.ObjectMapper;
import hello.exception.exception.UserException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
@Slf4j
public class UserHandlerExceptionResolver implements HandlerExceptionResolver {
private final ObjectMapper objectMapper = new ObjectMapper();
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
try {
if (ex instanceof UserException) {
log.info("UserException resolver to 400");
String acceptHeader = request.getHeader("accept");
response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
if ("application/json".equals(acceptHeader)) {
Map<String, Object> errorResult = new HashMap<>();
errorResult.put("ex", ex.getClass());
errorResult.put("message", ex.getMessage());
String result = objectMapper.writeValueAsString(errorResult);
response.setContentType("application/json");
response.setCharacterEncoding("utf-8");
response.getWriter().write(result);
return new ModelAndView();
} else {
// TEST/HTML
return new ModelAndView("error/500");
}
}
} catch (IOException e) {
log.error("resolver ex", e);
}
return null;
}
}
- HTTP 요청 헤더의 Accept값이 application/json이면 JSON으로 오류를 내려주고, 그 외 경우에는 error/500에 있는 HTML 오류 페이지를 보여주도록 했다.
📌 WebConfig
package hello.exception;
import hello.exception.filter.LogFilter;
import hello.exception.interceptor.LogInterceptor;
import hello.exception.resolver.MyHandlerExceptionResolver;
import hello.exception.resolver.UserHandlerExceptionResolver;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import java.util.List;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
resolvers.add(new MyHandlerExceptionResolver());
resolvers.add(new UserHandlerExceptionResolver());
}
}
스프링이 제공하는 ExceptionResolver
- 스프링 부트가 기본으로 제공하는 ExceptionResolver가 있다.
- ExceptionHandlerResolverComposite에 다음 우선순위 순서로 등록된다.
- ExceptionHandlerExceptionResolver
- ResponseStatusExceptionResolver
- DefaultHandlerExceptionResolver
- ExceptionHandlerResolverComposite에 다음 우선순위 순서로 등록된다.
🔍 ResponseStatusExceptionResolver
- 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.
- 사용 예) @ResponseStatus(value=HttpStatus.Not_Found)
- 2가지 경우를 처리할 수 있다.
- @ResponseStatus 애노테이션이 붙어있는 예외
- ResponseStatusException 예외
💡 @ResponseStatus 애노테이션
📌 사용자 정의 예외 클래스
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 예외가 해당 애노테이션을 확인해서 오류 코드를 HttpStauts.Bad_Request(400)으로 변경하고 메시지도 담는다.
- ResponseStatusExceptionResolver 코드를 확인하면 결국 response.sendError(statusCode, resolvedReason) 메서드를 호출하는 것이다.
- sendError(400) 을 호출했기 때문에 WAS에서 다시 오류 페이지 /error 를 내부에서 요청한다.
- MessageSource 기능을 통해 @ResponseStatus 애노테이션의 속성인 reasone 값을 messages.properties에서 매핑하여 찾는 기능도 제공한다.
📌 messages.properties
error.bad = 잘못된 요청 오류입니다. 메시지 사용
📌 ApiExceptionController
@GetMapping("/api/response-status-ex1")
public String responseStatusEx1() {
throw new BadRequestException();
}
💡 ResponseStatusException 예외
- @ResponseStatus 애노테이션은 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다.
- 개발자가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.
- 추가로 애노테이션을 사용했기 때문에 조건에 따라 동적으로 변경하기 어렵다.
- 이 때는 ResponseStatusException 예외를 사용하면 된다.
📌 ApiExceptionController
@GetMapping("/api/response-status-ex2")
public String responseStatusEx2() {
throw new ResponseStatusException(HttpStatus.NOT_FOUND,
"error.bad", new IllegalArgumentException());
}
🔍 DefaultHandlerExceptionResolver
- 스프링 내부에서 발생하는 스프링 예외를 해결한다.
- 대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 전달되고, 결과적으로 500 오류가 발생한다.
- 그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP는 이런경우 HTTP 상태코드 400을 사용하도록 되어있다.
- 그래서 DefaultHandlerExceptionResolver는 이것을 500 오류가 아니라 HTTP 상태코드 400오류로 변경한다.
📌 ApiExceptionController
@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
return "ok";
}
🔍 ExceptionHnadlerExceptionResolver
- @ExceptionHandler 애노테이션으로 처리한다.
- API 예외 처리는 대부분 이 기능으로 해결한다.
💡 @ExceptionHandler 예외 처리 방법
- @ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정하면 된다.
- 참고로 지정한 예외 또는 그 예외의 자식 클래스도 모두 처리된다.
- 부모 예외 클래스와 자식 예외 클래스 모두 있을 경우 더 자세한 것이 우선순위를 가진다.
- 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다.
📌 ErrorResult
package hello.exception.exhandler;
import lombok.AllArgsConstructor;
import lombok.Data;
@Data
@AllArgsConstructor
public class ErrorResult {
private String code;
private String message;
}
- 예외가 발생했을 때 API 응답으로 사용하는 객체를 정의했다.
📌 ApiExceptionV2Controller (예외 처리)
package hello.exception.api;
import hello.exception.exception.UserException;
import hello.exception.exhandler.ErrorResult;
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.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("EX", "내부 오류");
}
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
log.error("[exceptionHandler] ex", e);
ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
@GetMapping("/api2/members/{id}")
public MemberDto getMember(@PathVariable 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;
}
}
📌 IllergalArgumentException 예외 처리
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
- 컨트롤러를 호출한 결과 IllergalArgumentException 예외가 컨트롤러 밖으로 던져진다.
- 예외가 발생했으므로 ExceptionResolver가 작동한다. (우선 순위가 높은 것부터 매핑된다.)
- ExceptionaHandlerExceptionResolver는 해당 컨트롤러에 IllergalArgumentException을 처리할 수 있는 @ExceptionHandler 가 있는지 확인한다.
- illegalExHandler() 메서드를 실행한다. @RestController 이므로 illegalExhandler()에도 @ResponseBody 가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같이 JSON으로 반환된다.
- @ResponseStatus(HttpStatus.BAD_REQUEST) 를 지정했으므로 HTTP 상태코드 400으로 응답한다.
📌 ResponseEntity 이용하여 응답하기
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
log.error("[exceptionHandler] ex", e);
ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
- @ExceptionHandler 에 예외를 지정하지 않아서 해당 메서드 파라미터 예외로 지정된다.
- 여기서 UserException을 사용한다.
- ResponseEntity를 사용해서 HTTP 메시지 바디에 직접 응답한다.
- HTTP 컨버터가 사용된다.
- ResponseEntity를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다.
- @ResponseStatus 는 애노테이션이므로 HTTP 응답코드를 동적으로 변경할 수 없다.
💡 다양한 예외 처리
@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
log.info("exception e", e);
}
- 다양한 예외를 한 번에 처리할 수 있다.
💡 예외 생략
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
log.error("[exceptionHandler] ex", e);
ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
- @ExceptionHandler 의 속성 값에 예외를 지정해주지 않으면 메서드의 파라미터의 예외가 자등으로 지정된다.
API 예외 처리 - @ControllerAdvice
- @ExceptionHandler 애노테이션을 사용해서 예외를 깔끔하게 처리할 수 있지만 정상 코드와 예외처리 코드가 하나의 컨트롤러에 석여있다.
- @ControllerAdvide 애노테이션 또는 @RestControllerAdvice 애노테이션을 사용하면 둘을 분리할 수 있다.
- @ControllerAdvide 는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler , @InitBinder 기능을 부여해주는 역할을 한다.
- @ControllerAdvide 에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다.
- @RestControllerAdvice 는 @ControllerAdvide 와 같고, @ResponseBody 애노테이션이 더 추가된 것이다.
- @RestController 와 @Controller 차이와 같다.
📌 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.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("EX", "내부 오류");
}
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
log.error("[exceptionHandler] ex", e);
ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
}
- @RestControllerAdvice 애노테이션을 적용하여 예외 컨트롤러만 따로 관리할 수 있다.
🔍 대상 컨트롤러 지정 방법
// 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 {}
- 특정 애노테이션이 있는 컨트롤러를 지정할 수 있다.
- 특정 패키지를 직접 지정할 수도 있다.
- 특정 클래스를 지정할 수 있다.
- 대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.
🧷 정리
- API 예외는 @ExceptionHandler 애노테이션과 @ControllerAdvice 애노테이션을 조합하면 해결할 수 있다.
👀 참고자료
https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard
'[ Spring ] > SpringMVC 2편' 카테고리의 다른 글
[Spring] 스프링 타입 컨버터 (0) | 2022.03.16 |
---|---|
[Spring] 예외 처리와 오류 페이지 (0) | 2022.03.15 |
[Spring] 로그인 처리2 - 필터, 인터셉터 (0) | 2022.03.13 |
[Spring] 로그인 처리1 - 쿠키, 세션 (0) | 2022.03.12 |
[Spring] 검증2 - Bean Validation (0) | 2022.03.11 |