본문 바로가기
Spring/스프링 MVC 활용

#8 예외 처리와 오류 페이지

by 히포파타마스 2021. 8. 2.

예외 처리와 오류 페이지

 

1. 서블릿 예외 처리

순수 서블릿 컨테이너는 다음 두 가지 방식으로 예외 처리를 지원한다.

 

● Exception(예외)

◎ 자바 직접 실행

자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 쓰레드가 실행된다.

실행 도중에 예외를 잡지 못하고 main 까지 예외가 던져지면, 예외 정보를 남기고 해당 쓰레드는 종료된다.

 

◎ 웹 어플리케이션

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

만약 어플리케이션에서 예외를 잡지 못하고, 서블릿 밖까지 예외가 전달되면 WAS 까지 예외가 전달된다.

 

스프링 부트에서는 WAS에 예외가 전달되면 기본적으로 예외 페이지를 제공한다.

 

[whitelabel error page]

스프링 부트에 error page와 관련해서 '아무것도' 작성된 것이 없으면 위와 같은 기본 에러 페이지가 제공된다.  

 

application.properties에 다음과 같이 설정하면 스프링 부트가 제공하는 기본 예외 페이지를 끌 수 있다.

 

[whitelabel error page 끄기]

server.error.whitelabel.enabled=false

 

서블릿도 기본적인 예외 페이지를 제공한다.

[서블릿 예외 컨트롤러]

@Slf4j
@Controller
public class ServletExController {
	
    @GetMapping("/error-ex") 
	public void errorEx() {
		throw new RuntimeException("예외 발생!"); 
	}
}

 

에러를 발생시키면 다음과 같이 tomcat이 기본으로 제공하는 오류 화면을 볼 수 있다.

 

[서블릿 기본 오류 페이지]

HTTP Status 500 – Internal Server Error

 

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

오류가 발생했을 때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용해도 된다.

sendError를 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 것을 전달할 수 있다.

[sendError 생성자]

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

 

[sendError 사용 예]

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

 

sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장한다.

서블릿 컨테이너는 고객에게 응답 전에 reponse에 sendError()가 호출되었는지를 확인하고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

 

 

 

■ 서블릿 오류 화면 커스텀

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다.

서블릿은 오류 화면을 개발자가 커스텀할 수 있는 기능을 제공한다.

 

스프링 부트를 사용할 때 서블릿 오류 화면 기능을 사용하기 위해서는 먼저 서블릿 오류 페이지를 등록해야 한다.

 

[서블릿 에러 페이지 등록]

@Component
public class WebServerCustomizer implements
WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
	
	@Override
	public void customize(ConfigurableWebServerFactory factory) {
		ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
		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);
	} 
}

WebServerFactoryCustomizer를 상속받은 클래스를 만들고 스프링 빈에 등록하면 된다.

customize() 메서드에 URL과 상태 코드를 추가하면 상태 코드에 맞는 에러가 발생할 때, 해당 URL로 이동한다.

 

작성한 설정에 맞춰 컨트롤러와 에러 처리 View를 작성해주면 된다.

 

[서블릿 에러 컨트롤러]

@Slf4j
@Controller
public class ErrorPageController {

	@RequestMapping("/error-page/404")
	public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
		return "error-page/404"; 
	}

	@RequestMapping("/error-page/500")
	public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
		return "error-page/500"; 
	}
}

 

[서블릿 에러 View - 404]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org"> 
<head>
	<meta charset="utf-8"> 
</head>
<body>

	<div class="container" style="max-width: 600px">
		<div class="py-5 text-center">
			<h2>404 오류 화면</h2> 
		</div>
	
		<div>
			<p>오류 화면 입니다.</p> 
		</div>
	
		<hr class="my-4">
	</div> <!-- /container --> 

</body>
</html>

 

실제로 없는 리소스를 URL에 입력해서 404 오류를 발생시키면 해당 상태 코드에 매칭 되는 error-page/404로 이동하게 된다.

 

[서블릿 에러 결과 - 404]

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

그러면, WAS는 등록된 오류 페이지 정보를 확인하고 발생한 오류와 매칭 되는 페이지를 다시 요청한다.

 

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

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

 

 

□ 오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨준다.

 

● javax.servlet.error.exception : 예외

● javax.servlet.error.exception_type : 예외 타입

● javax.servlet.error.message : 오류 메시지

● javax.servlet.error.request_uri : 클라이언트 요청 URI

● javax.servlet.error.servlet_name : 오류가 발생한 서블릿 이름

● javax.servlet.error.status_code : HTTP 상태 코드

 

 

 

■ 서블릿 필터, 인터셉터 - DispatcherType

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다.

이때 필터, 서블릿, 인터셉터 모두 다시 호출된다.

하지만 필터와 인터셉터에서 이미 완료된 작업을 에러 페이지를 요청할 때 굳이 다시 호출하는 것은 매우 비효율적이다.

서블릿은 이런 문제를 해결하기 위해 DispatcherType으로 요청 타입을 구분하고 에러 페이지를 요청할 경우, 필터를 호출하지 않는다.

 

예를 들어, 고객이 처음 요청할 때는 dispatcherType=REQUEST 이고 에러 페이지를 요청할 때는 dispatcherType=ERROR가 된다.

 

만약 에러 페이지를 호출할 때도 필터를 적용시키고 싶다면 필터를 등록할 때 다음과 같은 메서드를 사용해서 설정을 추가해주면 된다.

 

[에러 페이지 호출 - 필터 설정]

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);

이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다.

기본값은 DispatcherType.REQUEST 이다.

 

 

□ 인터셉터

인터셉터는 스프링이 제공하는 기능이기 때문에 DispatcherType과 무관하게 항상 호출된다.

때문에 오류 페이지 요청에 인터셉터를 적용하고 싶지 않다면 excludePathPatterns를 사용해서 빼주면 된다.

 

 

 

 

2. 스프링 부트 예외 처리

서블릿에서 예외 처리 페이지를 만들기 위해서는 WebServerFactoryCostomizer를 상속받아 빈에 등록하고, 예외 종류에 따라 ErrorPage를 추가한 뒤, 그에 맞는 컨트롤러를 만들었다.

 

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

 

● ErrorPage는 자동으로 등록된다.

◎ 이때 /error 라는 경로를 기본 오류 페이지로 설정한다.

 

● BasicErrorController라는 스프링 에러 컨트롤러를 자동으로 등록한다.

◎ 자동으로 등록된 ErrorPage를 매핑해서 처리하는 컨트롤러이다.

 

개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라서 등록하면 된다.

 

[뷰 선택 우선순위 예시]

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

● 해당 경로 위치(기본 :  /error)에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.

●뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500처럼 구체적인 것이 5xx처럼 덜 구체적인 것보다 우선순위가 높다.

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

 

[오류 뷰 템플릿 추가 - 스프링 부트]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org"> 
<head>
	<meta charset="utf-8"> 
</head>

<body>
	<div class="container" style="max-width: 600px">
		<div class="py-5 text-center">
			<h2>404 오류 화면 스프링 부트 제공</h2> 
		</div>
		<div>
			<p>오류 화면 입니다.</p> 
		</div>

		<hr class="my-4">
        
	</div> <!-- /container --> 

</body>
</html>

위의 예제를 /templates/error/ 에 404로 저장하면 404 오류가 발생했을 때 자동으로 해당 페이지를 요청한다.

 

[오류 뷰 템플릿 결과 - 404, 스프링 부트]

존재하지 않는 URL을 입력해서 404 오류를 발생시키면 자동으로 /templates/error/404.html 페이지를 요청한다.

 

 

 

■ 기본 오류 정보 제공

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

 

오류 관련 내부 정보들을 고객에게 노출하는 것은 그리 좋지는 않다.

고객이 해당 정보를 읽어도 혼란스럽고 보안상 문제가 될 수 도 있다.

이런 이유로 BasicErrorController 에서 다음 오류 정보를 model에 포함할지 여부 선택을 할 수 있다.

 

[오류 정보 제공 설정 - application.properties]

erver.error.include-exception=false: exception 포함여부( true, false)
server.error.include-message=never: message 포함여부
server.error.include-stacktrace=never: trace 포함여부
server.error.include-binding-errors=never: errors 포함여부

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

 

● naver : 사용하지 않음

● always : 항상 사용

● on_param : 파라미터가 있을 때 사용

ex) message=on_param 일 때,

      http://localhost:8080/error-404?message=

      이면, message 정보가 model에 포함된다.

저작자표시

'Spring > 스프링 MVC 활용' 카테고리의 다른 글

#10 스프링 타입 컨버터  (0) 2021.08.03
#9 API 예외 처리  (0) 2021.08.03
#7 로그인 처리 - 필터, 인터셉터  (0) 2021.08.01
#6 로그인 처리 - 쿠키, 세션  (0) 2021.07.30
#5 Bean Validation  (0) 2021.07.28

관련글

댓글

티스토리툴바