[강의] 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 정리 - 예외 처리

크리링·2023년 3월 12일
강의
0

인프런 김영한님 스프링 강의 정리

목록 보기
6/13
post-thumbnail
post-custom-banner

강의 : 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술
코드 : study-mvc2-code.github





서블릿 예외 처리

스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아보자.

서블릿은 다음 2가지 방식으로 예외 처리를 지원한다.

  • Exception (예외)
  • response.sendError(HTTP 상태 코드, 오류 메시지)





Exception (예외)

자바 직접 실행
자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 쓰레드가 실행된다.
실행 도중에 예외를 잡지 못하고 처음 실행한 main()메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해동 쓰레드는 종료된다.

웹 애플리케이션
웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.
애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 없다. 그런데 애플리케이션에서 예외를 잡지 못하고 서블릿 밖으로까지 예외가 전달되면 어떻게 동작할까?

컨트롤러(예외발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS

결국 톰캣 같은 WAS까지 예외가 전달된다. WAS는 예외가 올라오면 어떻게 처리해야 할까?

HTTP Status 500 – Internal Server Error

Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다.

HTTP Status 404 – Not Found

톰캣이 기본으로 제공하는 404 오류 화면을 볼 수 있다.


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

오류가 발생했을 때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용해도 된다. 이것을 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.
이 메서드를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.

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

ServletExController

@GetMapping("/error-404")
public void error404(HttpServletResponse response) throws IOException {
 	response.sendError(404, "404 오류!");
}

@GetMapping("/error-500")
public void error500(HttpServletResponse response) throws IOException {
	response.sendError(500);
}

sendError 흐름

컨트롤러(response.sendError()) -> 인터셉터 -> 서블릿 -> 필터 -> WAS(sendError 호출 기록 확인)

response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인한다. 그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.



정리

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 사용자가 보기에 불편하다. 의미있는 오류 화면을 제공해보자.





서블릿 예외 처리 - 오류 화면 제공

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다. 서블릿이 제공하는 오류 화면 기능을 사용해보자.

서블릿은 Exception(예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다.
이 기능을 사용하면 친절한 오류 처리 화면을 준비해서 유저에게 보여줄 수 있다.

스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에, 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.

서블릿 오류 페이지 등록

...

@Component
public class WebServerCustomizer implements
WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
 	@Override
 	public void customize(ConfigurableWebServerFactory factory) {
 		ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/errorpage/404");
 		ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
 		ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/errorpage/500");
 		factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
 	}
}
  • response.sendError(404) : errorPage404 호출
  • response.sendError(500) : errorPage500 호출
  • RuntimeException 또는 그 자식 타입의 예외 : errorPageEx 호출

500 예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에 여기서는 예외가 발생한 경우도 500 오류 화면으로 처리했다.

오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다. 예를 들어서 위의 경우 RuntimeException은 물론이고 RuntimeException의 자식도 함께 처리한다.

오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다. 예를 들어서 RuntimeException 예외가 발생하면 errorPageEx에서 지정한 /error-page/500이 호출된다.

오류를 처리 컨트롤러

...
@Slf4j
@Controller
public class ErrorPageController {
 	@RequestMapping("/error-page/404")
 	public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
 		log.info("errorPage 404");
 		return "error-page/404";
 	}
 
 	@RequestMapping("/error-page/500")
 	public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
 		log.info("errorPage 500");
 		return "error-page/500";
	}
}

오류 처리 View

  • /templates/error-page/404.html
  • /templates/error-page/500.html



서블릿 예외 처리 - 오류 페이지 작동 원리

서블릿은 Exception(예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을 때 설정된 오류 페이지를 찾는다.

예외 발생 흐름

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

sendError 흐름

컨트롤러(response.sendError()) -> 인터셉터 -> 서블릿 -> 필터 -> WAS(sendError 호출 기록 확인)

WAS는 해당 예외 처리하는 오류 페이지 정보를 확인한다.
new ErrorPage(RuntimeException.class, "/error-page/500")

예를 들어서 RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다. 확인해보니 RuntimeException의 오류 페이지로 /error-page/500이 지정되어 있다. WAS는 오류 페이지를 출력하기 위해 /error-page/500를 다시 요청한다.

오류 페이지 요청 흐름

WAS '/error-page/500' 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 (/error-page/500) -> View

예외 발생과 오류 페이지 요청 흐름

1. 컨트롤러(예외발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS
2. WAS '/error-page/500' 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 (/error-page/500) -> View

중요한 점은 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모른다는 점이다. 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다.



오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨준다. 필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있다.

ErrorPageController - 오류 출력

...
@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"; // 클라이언트 요청 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"; // HTTP 상태 코드

 	@RequestMapping("/error-page/404")
 	public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
 		log.info("errorPage 404");
 		printErrorInfo(request);
 		return "error-page/404";
 	}
    
 	@RequestMapping("/error-page/500")
 	public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
 		log.info("errorPage 500");
 		printErrorInfo(request);
 		return "error-page/500";
 	}
    	
 	private void printErrorInfo(HttpServletRequest request) {
 		log.info("ERROR_EXCEPTION: ex=", request.getAttribute(ERROR_EXCEPTION));
 		log.info("ERROR_EXCEPTION_TYPE: {}", request.getAttribute(ERROR_EXCEPTION_TYPE));
 		log.info("ERROR_MESSAGE: {}", request.getAttribute(ERROR_MESSAGE)); // ex의 경우 NestedServletException 스프링이 한번 감싸서 반환
 		log.info("ERROR_REQUEST_URI: {}", request.getAttribute(ERROR_REQUEST_URI));
 		log.info("ERROR_SERVLET_NAME: {}", request.getAttribute(ERROR_SERVLET_NAME));
 		log.info("ERROR_STATUS_CODE: {}", request.getAttribute(ERROR_STATUS_CODE));
 		log.info("dispatchType={}", request.getDispatcherType());
 	}
}



서블릿 예외 처리 - 필터

1. 컨트롤러(예외발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS
2. WAS '/error-page/500' 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 (/error-page/500) -> View

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다. 이때 필터, 서블릿, 인터셉터 모두 다시 호출된다. 비효율적이다.
결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야한다. 서블릿은 이런 문제를 해결하기 위해 DispatcherType이라는 추가 정보를 제공한다.



DispatcherType

필터는 이런 경우를 위해서 dispatcherType이라는 옵션을 제공한다.
이전 강의의 마지막에 다음 로그를 추가했다.
log.info("dispatchType={}", request.getDispatcherType())
그리고 출력해보면 오류 페이지에서 dispatchType=ERROR 로 나오는 것을 확인할 수 있다.
고객이 처음 요청하면 dispatcherType=REQUEST 이다.
이렇듯 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지
DispatcherType 으로 구분할 수 있는 방법을 제공한다.

LogFilter - DispatcherType 로그 추가

@Slf4j
public class LogFilter implements Filter {
 	@Override
 	public void init(FilterConfig filterConfig) throws ServletException {
 		log.info("log filter init");
 	}
    
 	@Override
 	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
 		HttpServletRequest httpRequest = (HttpServletRequest) request;
 		String requestURI = httpRequest.getRequestURI();
 		String uuid = UUID.randomUUID().toString();
 		try {
 			log.info("REQUEST [{}][{}][{}]", uuid,
			request.getDispatcherType(), requestURI);
 			chain.doFilter(request, response);
 		} catch (Exception e) {
 			throw e;
 		} finally {
 			log.info("RESPONSE [{}][{}][{}]", uuid,
			request.getDispatcherType(), requestURI);
		}
 	}
    
 	@Override
 	public void destroy() {
 		log.info("log filter destroy");
 	}
}

WebConfig

@Configuration
public class WebConfig implements WebMvcConfigurer {
 	@Bean
 	public FilterRegistrationBean logFilter() {
 		FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
 		filterRegistrationBean.setFilter(new LogFilter());
 		filterRegistrationBean.setOrder(1);
 		filterRegistrationBean.addUrlPatterns("/*");
 		filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST,
DispatcherType.ERROR); // 두가지를 넣으면 클라이언트 요청, 오류 페이지 요청에서도 필터 호출된다.
 		return filterRegistrationBean;
 	}
}





서블릿 예외 처리 - 인터셉터

인터셉터 중복 호출 제거

LogInterceptor - DispatcherType 로그 추가

@Slf4j
public class LogInterceptor implements HandlerInterceptor {
 	
    public static final String LOG_ID = "logId";
    
 	@Override
 	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 		String requestURI = request.getRequestURI();
 		String uuid = UUID.randomUUID().toString();
 		request.setAttribute(LOG_ID, uuid);
 		log.info("REQUEST [{}][{}][{}][{}]", uuid, request.getDispatcherType(), requestURI, handler);
 		return true;
 	}
    
 	@Override
 	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
 		log.info("postHandle [{}]", modelAndView);
 	}
    
 	@Override
 	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 		String requestURI = request.getRequestURI();
 		String logId = (String)request.getAttribute(LOG_ID);
 		log.info("RESPONSE [{}][{}][{}]", logId, request.getDispatcherType(), requestURI);
 		if (ex != null) {
 			log.error("afterCompletion error!!", ex);
 		}
 	}
}

앞서 필터의 경우에는 필터를 등록할 때 어떤 DispatcherType 인 경우에 필터를 적용할 지 선택할 수 있었다. 그런데 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType 과 무관하게 항상 호출된다.

대신에 인터셉터는 다음과 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이러한 설정을 사용해서 오류 페이지 경로를 excludePathPatterns 를 사용해서 빼주면 된다.

@Configuration
public class WebConfig implements WebMvcConfigurer {
 	@Override
 	public void addInterceptors(InterceptorRegistry registry) {
 		registry.addInterceptor(new LogInterceptor())
 			.order(1)
 			.addPathPatterns("/**")
 			.excludePathPatterns( "/css/**", "/*.ico" , "/error", "/error-page/**" //오류 페이지 경로
 		);
 	}
    
 	//@Bean
 	public FilterRegistrationBean logFilter() {
		...
 	}
}

전체 흐름 정리

/hello 정상 요청

WAS(/hello, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

/error-ex 오류 요청

  • 필터는 DispatchType으로 중복 호출 제거 (dispatchType=REQUEST)
  • 인터셉터는 경로 정보로 중복 호출 제거 (excludePathPatterns("/error-page/**"))
1. WAS(/error-ex, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
2. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
3. WAS 오류 페이지 확인
4. WAS(/error-page/500, dispatchType=ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) ->
컨트롤러(/error-page/500) -> View



스프링 부터 - 오류 페이지1

지금까지 예외처리 페이지를 만들기 위해서 복잡한 과정을 거쳤다.

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

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

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

주의
WebServerCustomizer에 @Component를 주석 처리

이제 오류가 발생했을 때 오류 페이지로 /error를 기본 요청한다. 스프링 부트가 자동 등록한 BasicErrorController는 이 경로를 기본으로 받는다.

개발자는 오류 페이지만 등록
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





스프링 부트 - 오류 페이지 2

BasicErrorController가 제공하는 기본 정보들

BasicErrorController 컨트롤러는 다음 정보를 model에 담아서 뷰에 전달한다. 뷰 템플릿은 이 값을 활용해서 출력할 수 있다.

* timestamp: Fri Feb 05 00:00:00 KST 2021
* status: 400
* error: Bad Request
* exception: org.springframework.validation.BindException
* trace: 예외 trace
* message: Validation failed for object='data'. Error count: 1
* errors: Errors(BindingResult)
* path: 클라이언트 요청 경로 (`/hello`)

오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않다. 고객이 해당 정보를 읽어도 혼란만 더해지고, 보안상 문제가 될 수 있다.

application.properties

server.error.include-exception=true
server.error.include-message=on_param
server.error.include-stacktrace=on_param
server.error.include-binding-errors=on_param

기본 값이 never인 부분은 다음 3가지 옵션을 사용할 수 있다.
never, always, on_param

실무에서는 이것들을 노출하면 안된다! 사용자에게는 이쁜 오류 화면과 고객이 이해할 수 있는 간단한 오류 메시지를 보여주고 오류는 서버에 로그로 남겨서 로그로 확인해야 한다.





API 예외 처리

API 경우에는 지금까지의 문제보다 생각할 내용이 더 많다. 오류 페이지는 단순히 고객에게 오류 화면을 보여주면 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.





API 예외 처리 - 시작

WebServerCustomizer (@Component 애노테이션) + ApiExceptionController(API 예외 컨트롤러)

@Slf4j
@RestController
public class ApiExceptionController {
 	@GetMapping("/api/members/{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;
 	}
}

단순한 회원 조회기능에서 예외 테스트를 위해 id의 값이 ex이면 예외가 발생하도록 코드생성

Postman으로 테스트
HTTP Header에 Accept가 application/json인 것을 확인

API를 요청했을때, 정상의 경우 API로 JSON형 식으로 데이터 반환, 오류 발생시 오류 페이지 HTML 반환 -> 정상이든, 오류이든 JSON으로 반환되야함

ErrorPageController - API 응답 추가

@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.APPLICATIOIN_JSON_VALUE의 뜻은 클라이언트가 요청하는 HTTP Header의 Accept의 값이 application/json일 때 해당 메소드가 호출된다는 것이다. 결국 클라이언트가 받고 싶은 미디어타입이 json이면 이 컨트롤러의 메소드가 호출된다.

응답 데이터를 위해서 Map 을 만들고 status , message 키에 값을 할당했다. Jackson 라이브러리는 Map 을 JSON 구조로 변환할 수 있다.
ResponseEntity 를 사용해서 응답하기 때문에 메시지 컨버터가 동작하면서 클라이언트에 JSON이 반환된다.





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

스프링 부트가 제공하는 BasicErrorController에서 /error 동일한 경로를 처리하는 errorHtml(), error() 두 메소드를 확인할 수 있다.

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



    스프링 부트의 예외 처리

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



HTML 페이지 vs API 오류
BasicErrorController 를 확장하면 JSON 메시지도 변경할 수 있다.
스프링 부트가 제공하는 BasicErrorController 는 HTML 페이지를 제공하는 경우에는 매우 편리하다.
4xx, 5xx 등등 모두 잘 처리해준다. 그런데 API 오류 처리는 다른 차원의 이야기이다. API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. 예를 들어서 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있다.
결과적으로 매우 세밀하고 복잡하다. 따라서 이 방법은 HTML 화면을 처리할 때 사용하고, API는 오류 처리는 뒤에서 설명할 @ExceptionHandler 를 사용하자.





API 예외 처리 - HandlerExceptionResolver 시작

오류 메시지, 형식 등을 API 마다 다르게 처리하고 싶다.

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

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("잘못된 입력 값");
 	}
	return new MemberDto(id, "hello " + id);
}

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




HandlerExceptionResolver - 인터페이스

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

MyHandlerExceptionResolver

...
@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를 하듯이, Exception을 처리해서 정상 흐름처럼 변경하는 것이 목적이다. 이름 그대로 Exception을 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를 사용하자.





API 예외 처리 - HandlerExceptionResolver 활용

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

사용자 정의 예외를 하나 추가하자.

UserException

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 - 예외 추가

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

이 예외를 처리하는 UserHandlerExceptionResolver

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에 UserHandlerExceptionResolver 추가

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

정리

ExceptionResolver 를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver 에서 예외를 처리해버린다.
결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다. 서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다. 반면에 ExceptionResolver 를 사용하면 예외처리가 상당히 깔끔해진다.
그런데 직접 ExceptionResolver 를 구현하려고 하니 상당히 복잡하다. 지금부터 스프링이 제공하는 ExceptionResolver 들을 알아보자.





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

스프링 부트가 기본으로 제공하는 ExceptionResolver 는 다음과 같다.
HandlerExceptionResolverComposite에 다음 순서로 등록
1. ExceptionHandlerExceptionResolver -> @ExceptionHandler 처리 (대부분 해결)
2. ResponseStatusExceptionResolver -> HTTP 상태 코드 지정 예) @ResponseStatus(value = HttpStatus.NOT_FOUND)
3. DefaultHandlerExceptionResolver 우선 순위가 가장 낮다.


ResponseStatusExceptionResolver

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

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

@ResponseStatus 애노테이션을 적용하면 HTTP 상태 코드를 변경

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

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

ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason) 를 호출하는 것을 확인할 수 있다. sendError(400) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청한다

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





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

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

그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.
DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다.
스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.





API 예외 처리 - @ExceptionHandler

API 오류에는 매우 세밀한 제어가 필요
지금까지 살펴본 BasicErrorController를 사용하거나 HandlerExceptionResolver를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않다.

API 예외처리의 어려운점

  • HandlerExceptionResolver 를 떠올려 보면 ModelAndView 를 반환해야 했다. 이것은 API 응답에는 필요하지 않다.
  • API 응답을 위해서 HttpServletResponse 에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.
  • 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까?

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

ErrorResult

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

ApiExceptionV2Controller

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

IllegalArgumentException 또는 그 하위 자식 클래스 모두 처리 예제

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

스프링의 우선순위는 자세한 것이 우선권 (자식예외 > 부모예외)

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으로 응답한다.





API 예외 처리 - @ControllerAdvice

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

ExControllerAdvice

@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 모두 제거


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

스프링 공식 문서 예제에서 보는 것 처럼 특정 애노테이션이 있는 컨트롤러를 지정할 수 있고, 특정 패키지를
직접 지정할 수도 있다. 패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다. 그리고
특정 클래스를 지정할 수도 있다.
대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다





정리

@ExceptionHandler 와 @ControllerAdvice 를 조합하면 예외를 깔끔하게 해결할 수 있다

profile
크리링
이전 포스트

[강의] 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 정리 - 로그인 처리

다음 포스트

[강의] 김영한님의 스프링 핵심 원리 - 고급편 (로그 추적기와 디자인 패턴)

post-custom-banner

0개의 댓글