김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 9일차

API 예외 처리

HTML 페이지의 경우 4xx, 5xx 와 같은 오류 페이지만 있으면 대부분 문제를 해결 할 수 있다.

API의 경우에는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.

package hello.exception.api;

import hello.exception.exception.BadRequestException;
import hello.exception.exception.UserException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ResponseStatusException;

@Slf4j
@RestController
public class ApiExceptionController {

    @GetMapping("/api/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;
    }
}

API를 요청할때 정상의 경우 JSON 형식으로 데이터가 정상 반환된다. 하지만 오류가 발생하면 오류페이지 HTML이 반환된다. JSON 응답을 할 수 있도록 수정했다.

ErrorPageController

@RequestMapping(value = "/error-page/500" , produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Map<String , Object>> errorPage500Api(HttpServletResponse response, HttpServletRequest request){

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

produces = MediaType.APPLICATION_JSON_VALUE 뜻은 클라이언트가 요청하는 HTTP Header의 Accept의 값이 application/json일 때 해당 메서드가 호출된다는 것이다.

API 예외 처리 - 스프링 부트 기본 오류 처리

API 예외처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다.

BasicErrorController

/error 동일한 경로를 처리하는 errorHtml() , error() 두 메서드가 있다.

errorHtml() : produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 헤더 값이 text/html인 경우에는

errorHtml()을 호출해서 view를 제공한다.

error() : 그외 경우에 호출되고 ResponseEntity로 HTTP Body에 JSON 데이터를 반환한다.

스프링 부트는 BasicErrorController가 제공하는 기본 정보들을 활용해서 오류 API를 생성해준다.

API 예외 처리 - HandlerExceptionResolver 시작

IllegalArgumentException을 처리하지 못해서 컨트롤러 밖으로 넘어가는 일이 발생하면 HTTP 상태 코드를 400으로 처리하고 싶다면 어떻게 해야할까?

현재 실행해보면 상태 코드가 500이다.

HandlerExceptionResolver

스프링 MVC는 컨트롤러 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의 할 수 있는 방법을 제공한다.

HandlerExceptionResolver를 사용하면 된다. 줄여서 ExceptionResolver라고 한다.

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) {

        log.info("call resolver={}", 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;
    }
}

ExceptionResolver 가 ModelAndView를 반환하는 이유는 Exception을 처리해서 정상 흐름 처럼 변경하기 위해서다.

코드에서는 IllegalArgumentException이 발생하면 response.sendError(400) 을 호출해서 HTTP 상태 코드를 400으로 지정하고 빈 ModelAndView를 반환한다.

빈 ModelAndView 을 반환하면 뷰를 렌더링 하지않고, 정상 흐름으로 서블릿이 리턴된다.

null을 반환하면 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

WebConfig

@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    resolvers.add(new MyHandlerExceptionResolver());
}

상태코드가 400으로 바뀌었다.

API 예외 처리 - HandlerExceptionResolver 활용

예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아와 다시 /error를 호출하는 과정은 복잡하다. ExceptionResolver를 활용하면 복잡한 과정 없이 깔끔하게 해결할 수 있다.

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

}

package hello.exception.resolver;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.exception.exception.UserException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.ui.Model;
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 {
                  //TEXT/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

@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    resolvers.add(new MyHandlerExceptionResolver());
    resolvers.add((new UserHandlerExceptionResolver()));
}

ExceptionResolver를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver에서 예외를 처리해버린다.

예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외처리는 끝이 난다.

하지만 ExceptionResolver를 구현하려고 하면 너무 복잡하다

스프링이 제공하는 ExceptionResolver를 사용하면 편리하다.

API 예외 처리 - 스프링이 제공하는 ExceptionResolver1

스프링 부트가 기본으로 제공하는 ExceptionResolver는 다음과 같다.

1. ExceptionHandlerExceptionResolver

2. ResponseStatusExceptionResolver

3. DefaultHandlerExceptionResolver -> 우선 순위가 가장 낮다.

ResponseStatusExceptionResolver

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

다음 두가지를 처리한다.

@ResponseStatus가 달려있는 예외

ResponseStatusException 예외

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 {

}

BandRequestException 예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver 예외가 해당 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST로 변경하고 메시지도 담는다.

ApiExceptionController

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

messages.properties

error.bad = 잘못된 요청 오류입니다.

reason을 MessageSource에서 찾는 기능도 제공한다.

@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다.

이때는 ResponseStatusException 예외를 사용하면 된다.

ApiExceptionController

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

API 예외 처리 - 스프링이 제공하는 ExceptionResolver2

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다.

대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데,

이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고 결과적으로 500에러가 발생한다.

DefaultHandlerExceptionResolver는 이것을 500오류가 아니라 HTTP 상태 코드 400오류로 변경한다.

ApiExceptionController

@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
    return "ok";
}

Integer data에 문자를 입력하면 내부에서 TypeMismatchException이 발생한다.

API 예외 처리 - @ExceptionHandler

API 예외처리의 어려운 점

HandlerExceptionResolver를 떠올려 보면 ModelAndView를 반환해야 했다. 이것은 API 응답에는 필요하지 않다.

API 응답을 위해서 HttpServletResponse에 직접 응답 데이터를 넣어 주었다. 이것은 매우 불편하다.

@ExceptionHandler

스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 제공한다.

이것이 바로 ExceptionHandlerExceptionResolver 이다.

스프링은 ExceptionHandlerExceptionResolver 를 기본으로 제공하고 ExceptionHandler 는 우선순위도 가장 높다.

package hello.exception.exhandler;

import lombok.AllArgsConstructor;
import lombok.Data;

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

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.BAD_REQUEST)
    @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);
    }

    @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 예외 처리 방법

@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다.

우선순위

스프링의 우선순위는 항상 자세한 것이 우선권을 가진다. 예를 들어서 부모, 자식 클래스가 있으면

@ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다.

자식 예외가 발생하면 부모예외처리, 자식예외처리 둘다 호출 대상이 된다.

스프링은 자세한 것이 우선권을 가지기 때문에 자식예외처리가 호출 된다.

예외 생략

@ExceptionHandler에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정 된다.

@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {

컨트롤러를 호출한 결과 IllegalArugmentException 예외가 컨트롤러 밖으로 던져진다.

예외가 발생했으므로 ExceptionResolve가 작동한다.

가장 우선순위가 높은 ExceptionHandlerExceptionResolver 가 실행된다.

ExceptionHandlerExceptionResolver 는 해당 컨트롤러에 IllegalArugmentException 을 처리할 수 잇는 @ExceptionHandler가 있는지 확인한다.

illegalExHandler() 를 실행한다. @RestController 이므로 illegalExHandler()에도 @ResponseBody가 적용된다.

따라서 HTTP 컨버터가 사용되고, 응답이 JSON으로 반환된다.

@ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTTP 상태 코드 400으로 응답한다.

API 예외처리- @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.RestController;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@Slf4j
@RestControllerAdvice
public class ExControllerAdvice {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @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);
    }

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ErrorResult exHandle(Exception e) {
        log.error("[exceptionHandle] ex" , e);
        return new ErrorResult("EX", "내부 오류");
    }

}

@ControllerAdvice

@ControllerAdvice는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder 기능을 부여해주는 역할을 한다.

@ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다.

대상 컨트롤러 지정 방법


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

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2

'SPRING' 카테고리의 다른 글

김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 11일차 (0)	2022.02.03
김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 10일차 (0)	2022.01.28
김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 8일차 (0)	2022.01.24
김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 7일차 (0)	2022.01.20
김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 6일차 (0)	2022.01.18

일호의 개발노트

김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 9일차

API 예외 처리

API 예외 처리 - 스프링 부트 기본 오류 처리

API 예외 처리 - HandlerExceptionResolver 시작

API 예외 처리 - HandlerExceptionResolver 활용

API 예외 처리 - 스프링이 제공하는 ExceptionResolver1

API 예외 처리 - 스프링이 제공하는 ExceptionResolver2

API 예외 처리 - @ExceptionHandler

API 예외처리- @ControllerAdvice

출처

'SPRING' 카테고리의 다른 글

티스토리툴바

김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 9일차

API 예외 처리

API 예외 처리 - 스프링 부트 기본 오류 처리

API 예외 처리 - HandlerExceptionResolver 시작

API 예외 처리 - HandlerExceptionResolver 활용

API 예외 처리 - 스프링이 제공하는 ExceptionResolver1

API 예외 처리 - 스프링이 제공하는 ExceptionResolver2

API 예외 처리 - @ExceptionHandler

API 예외처리- @ControllerAdvice

출처

'SPRING' 카테고리의 다른 글

'SPRING' Related Articles

티스토리툴바