[스프링] 예외 처리

만약 프로그램 도중 오류가 발생했을 때 해당 예외에 대한 처리는 크게 두 가지로 나눌 수 있다.

 

1. 오류 페이지를 통한 예외 처리

2. API를 통한 예외 처리

 

오류 페이지를 통한 예외 처리

웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.

애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아 처리하면 아무 문제가 없지만 만약 예외를 잡지 못하고 서블릿 밖으로 예외가 전달되게 되면 톰캣같은 WAS 까지 예외가 전달되게 된다.

 

WAS (여기까지 전파) <= 필터 <= 서블릿 <= 인터셉터 <= 컨트롤러 (예외 발생)

 

HttpServletResponse가 제공하는 sendError 라는 메서드가 있는데, 이를 호출하면 당장 예외가 발생하는 것은 아니지만 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다. 이 메서드를 호출하면 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인하고, 호출 되었다면 설정한 오류 코드에 맞춰 기본 오류 페이지를 보여주게 된다. 보여주고 싶은 오류 페이지는 사용자가 만들어서 명시적으로 추가해 줘도 된다.

 

- response.sendError(HTTP 상태 코드)
- response.sendError(HTTP 상태 코드, 오류 메시지)

 

서블릿은 Exception이 발생하면 서블릿 밖으로 전달하거나 response.sendError() 가 호출 되었을 때 설정된 오류 페이지를 찾는데, 예를 들어 RuntimeException 예외가 WAS 까지 전달되면 WAS는 오류 페이지 정보를 확인하고 해당 오류 페이지를 출력하기 위해 컨트롤러를 다시 호출하게 된다. 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 모르고, 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다. 그 과정에서 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

 

1. WAS (여기까지 전파) <= 필터 <= 서블릿 <= 인터셉터 <= 컨트롤러(예외발생)
2. WAS `/error-page/500` 다시 요청 => 필터 => 서블릿 => 인터셉터 => 컨트롤러(/error-page/ 500) => View

 

서버 내부에서 오류 페이지를 호출한다고 해당 필터나 인터셉트가 한번 더 호출되는 것은 매우 비효율적으로 보인다. 서블릿은 이런 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다. 들어올 수 있는 값들은 다음과 같다.

 

• REQUEST : 클라이언트 요청
• ERROR : 오류 요청
• FORWARD : 서블릿에서 다른 서블릿 또는 JSP 호출
• INCLUDE : 서블릿에서 다른 서블릿 또는 JSP의 결과 포함
• ASYNC : 서블릿 비동기 호출

필터는 기본 값이 DispatcherType.REQUEST, 즉 클라이언트의 요청이 있는 경우에만 적용이 된다. 원한다면 ERROR를 추가해도 된다. 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능으로 DispatcherType과 무관하게 항상 호출된다. 대신 excludePathPatterns를 사용해 오류 페이지 경로를 빼주면 된다.

 

이렇게 예외 처리 페이지를 만들기 위해

• WebServerCustomizer를 만들고
• 예외 종류에 따라서 ErrorPage를 추가하고
• 예외 처리용 컨트롤러 ErrorPageController를 만들었다.

그러나 스프링 부트는 이런 복잡한 과정을 모두 기본으로 제공한다.

 

• ErrorPage를 자동으로 등록한다. 이때 /error 라는 경로로 기본 오류 페이지를 설정한다.
  • 서블릿 밖으로 예외가 발생하거나 response.sendError(...)가 호출되면 모든 오류는 /error를 호출하게 된다.
• BasicErrorController라는 스프링 컨트롤러를 자동으로 등록한다.
  • ErrorPage에서 등록한 /error를 매핑해서 처리한다.

 

 

결국 개발자는 오류 페이지만 등록하면 끝이 난다.

 

BasicErrorController는 기본적인 로직이 모두 개발되어 있다. 개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라 등록하면 된다. 정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해서 동적으로 화면을 만들고 싶으면 뷰 템플릿 경로에 오류 페이지 파일을 만들어서 넣어두기만 하면 된다.

 

 

뷰 선택 우선순위

1. 뷰 템플릿
   • resources/templates/error/500.html
   • resources/templates/error/5xx.html
2. 정적 리소스 (static, public)
   • resources/static/error/400.html
   • resources/static/error/404.html
   • resources/static/error/4xx.html
3. 적용 대상이 없을 때 뷰 이름 (error)
   • resources/templates/error.html

 

해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.

5xx, 4xx 라고 하면 500대, 400대 오류를 처리해준다.

 

 

 

API 예외 처리

HTML 페이지의 경우 4xx, 5xx와 같은 오류 페이지만 있다면 대부분의 문제를 해결할 수 있다. 그런데 API의 경우 API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. 예를 들어 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 같은 예외라도 그 결과가 달라질 수 있다. API는 각 오류 상황에 맞는 세밀하고 복잡한 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.

 

 

HandlerExceptionResolver

스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공하는데, 이때 HandlerExceptionResolver가 사용된다. 줄여서 ExceptionResolver라 한다.

 

 

원래는 컨트롤러에서 예외가 발생하면 afterCompletion 실행 후 예외를 WAS에 전달하게 되는데, ExceptionResolver를 사용하면 발생한 예외를 해결하려 시도하고 만약 해결이 잘 되었다면 view 호출 후 정상 응답을 보내게 된다.

 

HandlerExceptionResolver 의 반환 값에 따른 DispatcherServlet 의 동작 방식은 다음과 같다.

 

• 빈 ModelAndView : new ModelAndView() 처럼 빈 ModelAndView 를 반환하면 뷰를 렌더링 하지 않고, 정상 흐름으로 서블릿이 리턴된다.
• ModelAndView 지정 : ModelAndView 에 View , Model 등의 정보를 지정해서 반환하면 뷰를 렌더링 한다. 그러나 대부분 API 오류 처리를 위해 JSON을 반환하므로 거의 사용하지 않는다.
• null : 다음 ExceptionResolver 를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver 가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

 

ExceptionResolver 를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver 에서 예외를 처리해버린다. 따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 난다. 결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.

 

 

스프링이 제공하는 ExceptionResolver

1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver

 

ResponseStatusExceptionResolver

 

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

• @ResponseStatus 가 달려있는 예외

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {
}

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

 

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

 

• ResponseStatusException 예외

@ResponseStatus는 애노테이션을 사용하기 때문에 개발자가 직접 변경할 수 없는 라이브러리의 예외 코드나 조건에 따라 동적으로 변하는 코드에 적용하는 것은 어렵다. 이때는 ResponseStatusException을 사용하면 된다.

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

 

 

 

DefaultHandlerExceptionResolver

 

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다. 대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고 결과적으로 500 오류가 발생한다. 그러나 이러한 오류는 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제로 400 상태 코드를 반환해야 한다. 이때 DefaultHandlerExceptionResolver는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다.

 

 

 

@ExceptionHandler

HandlerExceptionResolver를 떠올려 보면 ModelAndView를 반환해야 했는데, 이는 API 응답에는 필요하지 않다. 또한 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기도 어려웠다. 따라서 스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver 이다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.

 

ErrorResult

package hello.exception.exhandler;

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class ErrorResult {
    private String code;
    private String message;
}

 

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;
    }
}

 

 

예외 처리 방법은 @ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.

 

 

 

@ControllerAdvice

@ExceptionHandler 를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다. @ControllerAdvice 또는 @RestControllerAdvice 를 사용하면 둘을 분리할 수 있다.

 

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", "내부 오류");
    }
}

 

• @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다.
• @RestControllerAdvice는 @ControllerAdvice와 같고 @ResponseBody가 추가된 것이다.

 

 

대상 컨트롤러 지정 방법

// 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 {}

 

패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다. 지정을 생략하면 모든 컨트롤러에 적용된다. 보통 패키지로 지정을 한다.