[Spring] API 예외 처리

bien·2023년 10월 5일
Spring
0

Spring_MVC2

목록 보기
7/7

시작

목표 API 예외 처리는 어떻게 해야할까?

HTML 페이지를 통해 오류 페이지를 제공하는 것은 간단한 해결방법이다. 오류 페이지는 단순히 사용자에게 오류 화면을 제공하고 끝이 난다.

그에 비해 API 경우에는 고려해야 할 부분이 훨씬 늘어난다. API는 각 상황에 맞는 개별 오류 응답 스펙을 정하고, JSON으로 데이터를 내려줘야 한다. 지금부터 API의 경우 어떻게 예외를 처리하면 좋을지 살펴보자.

우선, 서블릿 오류 페이지 방식을 사용해보자.

WebServerCustomizer 다시 동작

package com.study.admin.exception;

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

    @Override
    public void customize(ConfigurableWebServerFactory factory) {

        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
        ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");

        ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");

        factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
    }
}

WebServerCutomizer를 다시 사용하기 위해 @Component 애노테이션의 주석을 풀자. 이제 WAS에 예외가 전달되거나, response.sendError()가 호출되면 위에 등록한 예외 페이지 경로가 호출된다.

ApiExceptionController: API 예외 컨트롤러

package com.study.admin.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/member/{id}")
    public MemberDTO getMember(@PathVariable("id") 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인것을 확인하자!

정상 호출

http://localhost:8080/api/members/spring

정상인 경우 JSON 형식의 데이터가 정상 반환된다.

예외 발생 호출

http://localhost:8080/api/member/ex

그러나 오류 발생시 우리가 미리 만들어둔 오류 페이지 HTML이 반환된다. 이것은 API에 적절한 방식이 아니다. 클라이언트는 정상 요청이든 오류 요청이든 JSON이 반환되기를 기대한다.

문제 해결을 위해 오류 페이지 컨트롤러도 JSON 응답을 할 수 있도록 수정해야 한다.(에러 페이지를 매핑하는 컨트롤러에 api 응답을 추가하자!)

ErrorPageController: API 응답 추가

package com.study.admin.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 {

    //RequestDispatcher 상수로 정의되어 있음
    public static final String ERROR_EXCEPTION = "javax.servlet.error.exception";
    public static final String ERROR_EXCEPTION_TYPE = "javax.servlet.error.exception_type";
    public static final String ERROR_MESSAGE = "javax.servlet.error.message";
    public static final String ERROR_REQUEST_URI = "javax.servlet.error.request_uri";
    public static final String ERROR_SERVLET_NAME = "javax.servlet.error.servlet_name";
    public static final String ERROR_STATUS_CODE = "javax.servlet.error.status_code";

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

}
  • produces = MediaType.APPLICATION_JSON_VALUE
    • 클라이언트가 요청하는 HTTP Header의 Accpet 값이 application/json일때 해당 메서드가 호출된다는 의미.
  • 응답 데이터를 위해 Map을 만들고 status, message 키에 값을 할당했다. Jackson 라이브러리는 Map을 JSON 구조로 변환할 수 있다.
  • ResponseEntity를 사용해서 응답하기 때문에 컨버터가 동작하면서 클라이언트에 json이 반환된다.

예외 발생 호출 (JSON)

http://localhost:8080/api/member/ex

이제 JOSN으로 데이터를 반환하고 있다! 만약 HTTP Header에 Accept가 application/json이 아니라면, 기존 오류 응답인 HTML 응답이 출력되게 된다.

📌📝 (Tip) Accept vs Produces (Feat. Content-Type)

  • Content-Type (in header)
    • HTTP 메시지(요청 & 응답 모두)에 담아 보내는 데이터의 형식을 알려주는 속성.
    • ex) Content-Type: application/json
      = "이 포장지안에 동봉된 자료는 JSON 형식입니다." (I am)
  • Accept
    • HTTP 요청에 사용되는 헤더 속성. 클라이언트가 원하는 응답 데이터의 형식을 알려준다.
    • ex) Accept: application/json
      = "저는 JSON 형식의 데이터를 받고 싶습니다.(기대합니다)" (I hope)
  • Produces
    • SpringFramework와 같은 웹 프레임워크에서 사용되는 애노테이션 or 설정 옵션
    • 컨트롤러가 생성하는 응답의 형식을 지정하는데 사용된다.
    • ex)@RequestMapping(value = "/data", produces = "application/json") _"지금 제가 제공할 자료는 JSON 형식입니다."

스프링 부트 기본 오류 처리

(앞서 HTML페이지 제공 오류처리 방식 처럼) API의 경우에도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다.

BasicErrorController 코드

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {	

	@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
	public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}
    
    @RequestMapping
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}

/error를 처리하는 errorHtml(), error() 두가지 메서드가 있다.

  • errorHtml(): produces = MediaType.TEXT_HTML_VALUE 클라이언트 요청의 Accept 헤더 값이 text/html인 경우에는 errorHtml()을 호출해서 view를 제공한다.
  • error(): 그 외 호출되고 ResponseEntity로 HTTP Body에 JSON 데이터를 반환한다.

스프링 부트의 예외 처리

앞서 학습했듯이 스프링 부트의 기본 설정은 오류 발생시 /error를 오류 페이지로 요청한다. BasicErrorController는 이 경로를 기본으로 받는다.

  • servier.error.path로 수정 가능하다.
  • 기본 경로가 /error

주의
스프링이 기본 제공하는 기능인 BasciErrorController를 사용하기 위해서는 WebServerCustomizer의 @Component를 주석처리 해야 한다.

Postman 실행 결과

GET "http://localhost:8080/api/member/ex"

매번 API로 Vue에서 이런 json 데이터를 받으면서도 아무 생각이 없었다. 생각해보면 나는 따로 오류와 관련된 코드를 구현한적이 없는데, 어떤 주체가 이런 정보를 담은 객체를 전송해주는지 한번도 의문을 느끼지 않았다는게 놀랍다..

스프링의 BasicErrorcontroller가 에러와 관련된 기능을 기본적으로 제공하고 있다! 별도로 설정하지 않으면 위의 정보를 api를 요청한 사용자에게 제공한다!

HTML 페이지 vs API 오류

BasicErrorController를 확장하여 JSON메시지를 변경할 수도 있다. 그러나 API오류는 @ExceptionHandler가 제공하는 기능을 사용하는것이 더 권장된다. BasicErrorController를 사용해 JSON 오류 메시지를 변경할 수 있다는 것 정도로만 알아두자.

HTML 페이지를 제공해야 하는 경우, BasicErrorController를 통해 오류 처리 페이지를 지정해 두는 것이 간단하고 편리한 해결 방법이다.

그러나 API의 오류 처리는 완전히 다른 문제이다. API마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. API의 도메인, 엔티티마다 개별적으로 분리되어 예외에 대한 응답을 준비해야 할 수도 있다.(회원, 상품 등) 이처럼 세밀하고 복잡한 오류에 대한 대응으로는 @ExceptionHandler의 사용이 더 권장된다!

HandlerExceptionResolver 시작

목표: 서블릿을 넘어 WAS까지 예외가 전달되는 경우, HTTP 상태코드는 500으로 지정된다. IllegalArgumentException과 같은 클라이언트 측의 문제는 400대 오류로 지정하고 싶을 수도 있다. 오류 메시지, 형식, 상태코드 등을 API마다 다르게 처리하고 싶다.

문제 상황: 상태 코드 변환

ApiExceptionController 수정

package com.study.admin.exception.api;

@Slf4j
@RestController
public class ApiExceptionController {

    @GetMapping("/api/member/{id}")
    public MemberDTO getMember(@PathVariable("id") 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;
    }

}

사용자의 잘못된 접근에 대한 코드를 추가했다. 이제 사용자가 옳지 않은 파라미터를 들고 사이트에 접근하면, 컨트롤러에서 에러를 발생시킨다. 사용자 측의 잘못(Bad Request)는 400대 에러로 다뤄지고, 그래서 나도 400대 에러로 사용자측에 전송하고 싶은 입장이다.

http://localhost:8080/api/member/bad

그러나 실행해보면 사용자 코드는 500이다
WAS 입장에서는 애플리케이션 내부에서 일어난 에러로, 서버 측 에러로 다뤄지기 때문이다.

이런 상황에서 상태 코드를 변경하고 싶으면 어떻게 해야할까?

해결 방법: HandlerExceptionResolver

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

ExceptionResolver 적용 전

ExceptionResolver 적용 후

  • 참고: ExceptionResolver로 예외를 해결해도 postHandle()는 호출되지 않는다.

HandlerExceptionResovler 인터페이스

public interface HandlerExceptionResolver {

  ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, 
  								Object handler, Exception ex);
  • handler: 핸들러(컨트롤러) 정보
  • Exception ex: 핸들러(컨트롤러)에서 발생한 예외

MyHandlerExceptionResolver

package hello.exception.resolver;

 @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;
		
        }
 }
  • ExceptionResolver가 ModelAndView를 반환하는 이유는 마치 try, catch를 하듯이 Excpetion을 처리해서 정상흐름처럼 변경하는 것이 목적이다. 이름 그대로 Exceptoin을 Resolver(해결)하는 것이 목적이다.
  • 여기서는 IllegalArgumentException이 발생하면 response.sendError(400)를 호출해서 HTTP 상태 코드를 400으로 지정하고, 빈 ModelAndView를 반환한다.

반환 값에 따른 동작 방식

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

  • 빈 ModelAndView: new ModelAndView()처럼 빈 ModelAndView를 반환하면 뷰를 렌더링하지 않고 정상 흐름으로 서블릿이 리턴된다.
  • ModelAndView 지정: ModelAndView에 view, model등의 정보를 지정해서 반환하면 뷰를 렌더링한다.
  • null: null을 반환하면, 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

ExceptionResolver 활용

  • 예외 상태 코드 반환
    • 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임
    • 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error가 호출됨
  • 뷰 템플릿 처리
    • ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링 해서 고객에게 제공
  • API 응답 처리
    • response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON으로 응답하면 API 응답 처리를 할 수 있다.

WebConfig

/**
 * 기본 설정을 유지하면서 추가
 */
 @Override
 public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> 
resolvers) {
    resolvers.add(new MyHandlerExceptionResolver());
 }

configureHandlerExceptionResolvers(..) 를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver가 제거되므로 주의, extendHandlerExceptionResolvers를 사용하자!

HandlerExceptionResolver 활용

예외를 여기서 마무리하기

예외 발생 시(그리고 예외가 다뤄지지 않는다면) WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error를 호출하는 복잡한 과정을 거치게 된다. ExceptionResolver를 활용하면 예외 발생 시 이런 복잡한 과정 없이 여기에서 문제를 깔끔하게 해결할 수 있다.

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

RuntimeExceptin을 상속한다.

ApiExceptionController 예외 추가

package com.study.admin.exception.api;

@Slf4j
@RestController
public class ApiExceptionController {

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

}

http://localhost:8080/api/members/user-ex 호출 시 UserException이 발생하도록 코드를 변경한다.

UserHandlerExceptionResolver

package com.study.global.error.handler;

public class UserHandlerExceptionResolver {
}

@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에서 예외 처리는 끝이 난다. 결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.

서블릿 컨테이너까지 예외가 올라감녀 복잡하고 지저분하게 추가 프로세스가 실행된다. 반면 ExceptionResolver를 사용하면 예외 처리가 상당히 깔끔해진다.

그러나 직접 ExceptionResolver를 구현하는 것은 복잡한 과정이므로, 스프링이 제공하는 ExceptionResolver들을 알아보자!

스프링 부트가 기본으로 제공하는 ExceptionResolver 목록

HandlerExceptionResolverComposite에 다음 순서로 등록되어 있다.
1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver :우선순위가 가장 낮다.

ExceptionHAndlerExceptionResolver
@ExceptionHandler를 처리한다. API 예외 처리는 대부분 이 기능으로 해결.

ResponseStatusExceptionResolver
HTTP 상태 코드 지정
예) @ResponseStatus(value = HttpStatus.NOT_FOUND

DefaultHandlerExcpetionResolver
스프링 내부 기본 예외 처리

📚 ResponseStatusExceptionResolver

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

다음 두 경우를 처리한다.

  • @ResponseStatus가 달려 있는 예외
  • ResponseStatusExcpeiton 예외

📗 @ResponseStatus

package hello.exception.exception;

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

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

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

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

ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)를 호출하는 것을 확인할 수 있다. sendError(400)를 호출했기 때문에 WAS에서 다시 오류페이지 (/error)를 내부 요청한다.
예외 처리를 여기서 끝낸게 아니라, response.sendError로만 변경해준 것.

ApiExceptionController 추가

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

실행 결과

http://localhost:8080/api/response-status-ex1?message=

 {
 "status": 400,
 "error": "Bad Request",
 "exception": "hello.exception.exception.BadRequestException",
 "message": "잘못된 요청 오류",
 "path": "/api/response-status-ex1"
 }

메시지 기능

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

package hello.exception.exception;

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

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

messages.properties

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

메시지 사용 결과

http://localhost:8080/api/response-status-ex1?message=

 {
 "status": 400,
 "error": "Bad Request",
 "exception": "hello.exception.exception.BadRequestException",
 "message":  "잘못된 요청 오류입니다. 메시지 사용",
 "path": "/api/response-status-ex1"
 }

📗 ResponseStatusExcpetion

@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다.(애노테이션을 직접 추가해야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에서는 적용할 수 없다.) 추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 이때는 ResponseStatusException 예외를 사용하면 된다.

ApiExceptionController 추가

@GetMapping("/api/response-status-ex2")
 public String responseStatusEx2() {
 	throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
 }
  • 던지는 Exception을 ResponseStatusException로 던지고, http 상태코드, 메시지, 처리하고자 하는 Exception을 파라미터로 넣어준다.

실행 결과

📚 DefaultHandlerExceptionResolver

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다. 대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데, 이 경우 예외가 발생했기 때문에 근야 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.

그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출하여 발생하는 문제이고, 이런 경우 HTTP 상태코드 400의 사용이 권장된다. DefaultHandlerExceptionResolver는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다.

DefaultHandlerExceptionResolver클래스 안에 스프링 내부 오류를 어떻게 처리할 지 수많은 내용이 정리되어 있다.

DefaultHandlerExcpeitonResolver

public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionResolver {

	@Override
	@Nullable
	protected ModelAndView doResolveException(
			HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex) {

		try {
			if (ex instanceof HttpRequestMethodNotSupportedException) {
				return handleHttpRequestMethodNotSupported(
						(HttpRequestMethodNotSupportedException) ex, request, response, handler);
			}
			else if (ex instanceof HttpMediaTypeNotSupportedException) {
				return handleHttpMediaTypeNotSupported(
						(HttpMediaTypeNotSupportedException) ex, request, response, handler);
			}
			else if (ex instanceof HttpMediaTypeNotAcceptableException) {
				return handleHttpMediaTypeNotAcceptable(
						(HttpMediaTypeNotAcceptableException) ex, request, response, handler);
			}
			else if (ex instanceof MissingPathVariableException) {
				return handleMissingPathVariable(
						(MissingPathVariableException) ex, request, response, handler);
			}
			else if (ex instanceof MissingServletRequestParameterException) {
				return handleMissingServletRequestParameter(
						(MissingServletRequestParameterException) ex, request, response, handler);
			}
			else if (ex instanceof ServletRequestBindingException) {
				return handleServletRequestBindingException(
						(ServletRequestBindingException) ex, request, response, handler);
			}
			else if (ex instanceof ConversionNotSupportedException) {
				return handleConversionNotSupported(
						(ConversionNotSupportedException) ex, request, response, handler);
			}
			else if (ex instanceof TypeMismatchException) {
				return handleTypeMismatch(
						(TypeMismatchException) ex, request, response, handler);
			}
			else if (ex instanceof HttpMessageNotReadableException) {
				return handleHttpMessageNotReadable(
						(HttpMessageNotReadableException) ex, request, response, handler);
			}
			else if (ex instanceof HttpMessageNotWritableException) {
				return handleHttpMessageNotWritable(
						(HttpMessageNotWritableException) ex, request, response, handler);
			}
			else if (ex instanceof MethodArgumentNotValidException) {
				return handleMethodArgumentNotValidException(
						(MethodArgumentNotValidException) ex, request, response, handler);
			}
			else if (ex instanceof MissingServletRequestPartException) {
				return handleMissingServletRequestPartException(
						(MissingServletRequestPartException) ex, request, response, handler);
			}
			else if (ex instanceof BindException) {
				return handleBindException((BindException) ex, request, response, handler);
			}
			else if (ex instanceof NoHandlerFoundException) {
				return handleNoHandlerFoundException(
						(NoHandlerFoundException) ex, request, response, handler);
			}
			else if (ex instanceof AsyncRequestTimeoutException) {
				return handleAsyncRequestTimeoutException(
						(AsyncRequestTimeoutException) ex, request, response, handler);
			}
		}
		catch (Exception handlerEx) {
			if (logger.isWarnEnabled()) {
				logger.warn("Failure while trying to resolve exception [" + ex.getClass().getName() + "]", handlerEx);
			}
		}
		return null;
	}
    
    	protected ModelAndView handleTypeMismatch(TypeMismatchException ex,
			HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException {

		response.sendError(HttpServletResponse.SC_BAD_REQUEST);
		return new ModelAndView();
	}

	/**
	 * Invoked to send a server error. Sets the status to 500 and also sets the
	 * request attribute "javax.servlet.error.exception" to the Exception.
	 */
	protected void sendServerError(Exception ex, HttpServletRequest request, HttpServletResponse response)
			throws IOException {

		request.setAttribute("javax.servlet.error.exception", ex);
		response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
	}

}

한번 봐두면 좋을거 같아서 코드를 들고왔다.

  • handleTypeMismatch 메서드를 보면 response.sendError(HttpServletResponse.SC_BAD_REQUEST) 코드를 확인할 수 있다. 결국 response.sendError() 방식으로 문제를 해결한다.
  • sendError(400)을 호출했기 때문에 WAS에서 다시 오류 페이지(/error)를 내부 요청한다.

ApiExceptionController

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

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

실행 결과

HTTP 상태코드가 400대인 것을 확인할 수 있다.

정리

  1. ExceptionHandlerExceptionResolver
  2. ResponseStatusExceptionResolver: HTTP 응답 코드 변경
  3. DefaultHandlerExceptionResolver: 스프링 내부 예외 처리

📚 @ExceptionHandler

HTML 화면 오류 vs API 오류

웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController를 사용하는게 편하다. 이때는 단순히 5xx, 4xx 관련 오류 화면을 보여주면 된다. 이미 BasicErrorController에서 해당 메커니즘을 모두 구현해두었다.

그러나 API는 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라 다른 데이터를 출력해야 할 수도 있다. 같은 예외더라도 어느 컨트롤러에서 발생했는가에 따라 다른 예외 응답을 내려줘야할 수도 있다. 한마디로 매우 세밀한 제어가 필요하다.

결국 지금까지 살펴본 BasicErrorController를 사용하거나 HandlerExceptionResolver를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않다.

API 예외 처리의 어려운 점

  • HandlerExcpeitonResolver는 ModelAndView를 반환한다. 이는 API 응답에는 필요하지 않다.
  • API 응답을 위해 HttpServletResponse에 직접 응답 데이터를 넣어주어야 한다.
    • 과거 서블릿을 직접 사용했던것 처럼 매우 번거로운 행위다.
  • 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기가 힘들다.
    • 예를들어 회원 처리 컨트롤러의 RuntimeExcpetion 예외와 상품관리 컨트롤러의 RuntimeException 예외를 다른 방식으로 처리하고 싶다면 어떻게 해야할까?

@ExceptionHandler

스프링은 API 예외 처리 문제를 해결하기위해 @ExceptionHandler라는 유용한 예외 처리 기능 애노테이션을 제공한다. 이것이 바로 ExceptionHandlerExceptionResolver이다. 스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver중에 우선순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.

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

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

    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandle(IllegalArgumentException e) {
        log.error("[exceptionHandle] ex", e);
        return new ErrorResult("BAD", e.getMessage());
    }

이 코드에서는 IllegalArgumentException와 그 하위 자식 클래스를 모두 처리할 수 있다.

우선 순위

스프링에서는 항상 자세한 것이 우선권을 가진다.
부모, 자식 클래스가 있는 경우 다음과 같이 예외가 처리된다.

 @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에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.
메뉴얼: https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-exceptionhandler.html#mvc-ann-exceptionhandler-args

이렇게 여러 파라미터와 응답 선택권이 있다.

IllegalArgumentException 처리

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandle(IllegalArgumentException e) {
        log.error("[exceptionHandle] ex", e);
        return new ErrorResult("BAD", e.getMessage());
    }
  • 컨트롤러 호출한 결과 IllegalArgumentExcpetion 예외가 컨트롤러 밖으로 던져진다.
  • 예외가 발생했으므로 ExceptionResolver가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행된다.
  • ExceptionHandlerExceptionResolver는 해당 컨트롤러에 IllegalArgumentExcpetion을 처리할 수 있는 @ExceptionHandler가 있는지 확인한다.
  • illegalExHandle()를 실행한다. @RestController 이므로 illegalExHandler()에도 @ResponseBody가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환된다.
  • @ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTTP 상태코드 400으로 응답한다.

UserException 처리

    @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);
    }
  • @ExceptionHandler에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다. 여기서는 UserException
  • ResponseEntity를 사용해서 HTTP 메시지 바디에 직접 응답한다. 물론 HTTP 컨버터가 사용 된다.
    • ResponseEntity를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다. 앞서 살펴본 @ResponseStatus는 애노테이션으로 HTTP 응답 코드를 동적으로 변경할 수 없다.

Exception

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ErrorResult exHandle(Exception e) {
        log.error("[exceptionHandle] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }
  • throw new RuntimeException("잘못된 사용자")이 코드가 실행되면서, 컨트롤러 밖으로 RuntimeException이 던져진다.
  • RuntimeException은 Exception의 자식 클래스이므로 이 메서드가 호출된다.
  • @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)로 HTTP 상태코드를 500으로 응답한다.

HTML 오류 화면

다음과 같이 ModelAndView를 사용해 오류화면(HTML)을 응답하는데 사용할 수도 있다.

 @ExceptionHandler(ViewException.class)
 public ModelAndView ex(ViewException e) {
    log.info("exception e", e);
	return new ModelAndView("error");
 }

잘 사용되지는 않는다.

📚 @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

컨트롤러에 있던 @ExceptionHandler를 모두 제거한다

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는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandelr, @InitBinder 기능을 부여해주는 역할을 한다.
  • @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용)
  • @RestControllerAdvice는 @ControllerAdivce와 같고, @ResponseBody가 추가되어 있다.
    • @Controller, @RestController의 차이와 같다.

대상 컨트롤러 지정 방법

  • 대상 컨트롤러 지정을 생략하면 모든 컨트롤러가 지정된다.
// Target all Controllers annotated with @RestController
 @ControllerAdvice(annotations = RestController.class)
 public class ExampleAdvice1 {}
  • @RestController가 적용된 컨트롤러에만 예외처리를 설정할 수 있다.
 // 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://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-controller-advice

Reference

[인프런, 김영한]: 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술

profile
bien
Good Luck!
이전 포스트

[Spring] Bean Validation

0개의 댓글