Home 예외 처리(오류 페이지)
Post
Cancel

예외 처리(오류 페이지)

사용자가 생각하지 못한 행동을 해서 NullPointException 같은 의도치 않은 예외, 오류가 발생하면 따로 오류 페이지를 만들어서 보여주는게 서비스 사용자 입장에서도 좋고 오류에 대처하기도 편할 수 있다.

이럴 때 어떻게 처리하는지 알아본다.

참고

Bean Validation 이용할 때, 스프링 프로젝트 생성 시 Dependencies에 Validation 추가하면 따로 추가 안해도 됨.

서블릿에서의 예외 발생 동작 구조

스프링이 아닌 순수 서블릿 컨테이너의 예외 처리를 먼저 알아본다.

서블릿은 아래 두 가지 방식으로 예외처리를 지원한다.

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

Exception

  • 자바 직접 실행의 경우 예외

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

  • 웹 애플리케이션에서의 예외

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

애플리케이션에서 예외가 발생했다고 가정하자. 어디선가 try ~ catch로 예외를 잡아 처리하면 아무런 문제가 없다. 하지만 만약 애플리케이션에서 예외를 잡지 못한다면?

애플리케이션에서 못잡고 서블릿 밖으로 예외가 전달된다면?

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

서블릿 밖으로 예외가 전달될 경우, 톰캣같은 WAS까지 예외가 전달된다.

WAS의 예외 처리 방식

우선 스프링부트가 제공하는 오류페이지를 삭제하고 실행하면 위와 같은 화면이 뜬다.

컨트롤러에서 RuntimeException을 날리면 아래와 같은 화면이 뜬다.

즉 톰캣이 기본으로 제공하는 것은 페이지를 찾을 수 없다는 404 오류이고, Exception의 경우(예외가 발생한 경우) 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해 HTTP 상태코드 500을 반환한다.

response.sendError()

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

이것을 호출한다고 바로 예외가 발생하는 것은 아니다. 단지 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

  • Controller
1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Slf4j  
@Controller  
public class ServletExController {  
  
	@GetMapping("/error-ex")  
	public void errorEx() {  
		throw new RuntimeException("예외 발생!");  
	}  
	  
	@GetMapping("/error-500")  
	public void error404(HttpServletResponse response) throws IOException {  
		response.sendError(500, "500 오류!");  
	}  
}

흐름을 보면 아래와 같다.

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

컨트롤러에서 response.sendError() 를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장하게 된다.

그리고 서블릿 컨테이너는 고객에게 응답 전 response에 sendError()가 호출되었는지 확인한다.

호출되었다면 설정한 오류 코드에 맞추어 기본 오류페이지를 보여준다.

서블릿 예외 처리

서블릿에서 제공하는 예외, 오류 처리를 알아본다.

오류 화면 제공 - 구현

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

서블릿은 Exception이 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을 때 이 두 상황에 각각 오류 처리를 제공한다.

과거에는 web.xml 이라는 파일에 오류 화면을 등록했지만 지금은 스프링 부트를 통해 서블릿 컨테이너를 실행하기 때문에 스프링 부트가 제공하는 기능을 사용해 서블릿 오류 페이지를 등록하면 된다.

  • 서블릿 오류 페이지 등록
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// /hello/exception/WebServerCustomizer

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

response.sendError(404)가 호출된다면 위의 errorPage404를 호출하는 것이다. RuntimeException이나 그 자식 타입의 예외가 발생하면 errorPageEx 호출.

참고로 오류페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다.

오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다. 위의 코드에서 new ErrorPage() 내부의 path가 그것이다.

@Component 붙여야 동작.

  • 컨트롤러
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@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";  
	}  
}
1
2
3
4
@GetMapping("/error-ex")  
public void errorEx() {  
	throw new RuntimeException("예외 발생!");  
}

위의 코드를 보자. /error-ex 로 가면 RuntimeException가 발생하도록 했다. 따라서 원래는 아래와 같은 기본 오류 화면이 발생했다.

WebServerCustomizer에서 각 오류에 맞는 path를 등록해두었고 그 path를 바탕으로 위와 같이 컨트롤러를 만들어두면, 저 컨트롤러에서 새로운 오류 페이지 view를 반환하게 된다.

컨트롤러를 통해 만들어놓은 “500.html”로 뷰가 보여지게 된다.

오류 페이지 작동 원리

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

위에서 설명했던 흐름을 다시 보자.

1
WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러 (예외 발생)
1
WAS(sendError 호출 기록 확인) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(response.sendError())

이렇게 Exception이 발생하거나 sendError()가 호출되면 WAS까지 전달된다.

WAS는 이러면 해당 예외를 처리하는 오류 페이지 정보를 확인한다.

1
new ErrorPage(RuntimeException.class, "/error-page/500")

RuntimeException의 오류 페이지로 /error-page/500 이 지정되어있다는 것을 확인하는 것이다.

WAS는 이렇게 확인이 되면 오류 페이지를 출력하기 위해 /error-page/500을 다시 요청한다.

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

핵심

핵심은 웹 브라우저(클라이언트)는 서버 내부에서 컨트롤러에서 WAS까지 오류나 예외를 전파하고, WAS에서 다시 오류 페이지를 위해 요청하는 이러한 내부 과정을 전혀 모른다는 점이다.

오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다.

  1. 예외가 발생해 WAS까지 전파.
  2. WAS는 오류 페이지 경로를 찾아 내부에서 오류 페이지를 호출. 이 때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

오류 정보 추가

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
@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("/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");  
		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());  
	}  
}

컨트롤러에 위와 같이 로그를 찍어보는 메서드를 추가한다.

위와 같이 request에서 오류 정보들을 가져와 사용할 수 있다.

서블릿 예외 처리에서의 필터, 인터셉터

위에서 설명한 예외 발생했을 때의 흐름을 보면 컨트롤러에서 WAS까지, 그리고 WAS에서 컨트롤러까지 왔다갔다할 때 필터와 인터셉터를 각각 거친다.

즉 오류가 발생하면 필터, 서블릿, 인터셉터가 모두 다시 호출되는 것이다.

로그인 인증 체크 같은 경우를 생각해보자. 이미 한번 필터나 인터셉터에서 로그인 체크를 완료했다. 따라서 서버 내부에서 오류 페이지를 호출했다고 하여 해당 필터나 인터셉터가 한 번 더 호출되는 것은 매우 비효율적이다.

결국은 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분해 이런 문제를 해결해야 한다.

서블릿은 이러한 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다.

DispatcherType

1
log.info("dispatchType={}", request.getDispatcherType());

위에서 이러한 로그를 찍었었다. 오류 페이지를 발생시키는 페이지로 가서 로그를 찍어보면 dispatchType=ERROR 로 나오는 것을 확인할 수 있다.

고객이 처음 요청할때는 dispatchType=REQUEST 이다.

이렇게 DispatcherType을 통해 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 구분할 수 있다.

  • javax.servlet.DispatcherType
1
2
3
4
5
6
7
public enum DispatcherType {
	FORWARD,
	INCLUDE,
	REQUEST,
	ASYNC,
	ERROR
}
  • FORWARD: 서블릿에서 다른 서블릿이나 JSP를 호출하는 경우
  • INCLUDE: 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때
  • REQUEST: 클라이언트 요청
  • ASYNC: 서블릿 비동기 호출
  • ERROR: 오류 요청

필터에서의 DispatcherType 이용

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@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) {  
			log.info("exception!");	
			throw e;  
		} finally {  
			log.info("RESPONSE [{}][{}][{}]", uuid,  
			request.getDispatcherType(), requestURI);  
		}  
	}  
	
	@Override  
	public void destroy() {  
		log.info("log filter destroy");  
	}  
}

이전 포스트의 LogFilter이다. 단 로그에 dispatcherType을 추가했다. 필터 클래스를 만들고 WebConfig에 추가한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
@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;  
	}  
}

setDispatcherTypes를 통해 어떤 DispatcherType에만 작동할 것인지 정할 수 있다.

log를 통해 흐름을 알아보자.

처음 /error-ex, 즉 500 ERROR 페이지를 반환하는 URL로 간다.

처음에는 당연히 /error-ex로의 요청이기 때문에 REQUEST이다. 그리고 다음 단계로 넘어가기 위해 doChain()을 호출하는데 (try) 예외가 발생한다.

따라서 catch의 exception!이 찍히고, finally의 로그가 찍히는 것을 볼 수 있다.

그리고 위에 설명했듯 이렇게 예외가 발생하면 WAS에서 ErrorPage를 보이기 위해 다시 요청한다.

이 때 DispatchType은 ERROR로 찍히는 것을 볼 수 있다. 로그를 통해 위에서 설명했던 흐름을 볼 수 있었다.

만약 WebConfig에 Filter를 등록할 때, setDispatcherTypes에서 ERROR를 지우면 당연히 WAS가 오류페이지를 위한 요청을 할 때 필터는 작동하지 않기 때문에 아래와 같이 로그가 찍히지 않는 것이다.

반대로 오류 페이지 요청 때만 작동하는 필터가 필요하다면 setDispatcherTypes에서 ERROR만 남기면 된다.

인터셉터의 경우

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@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);  
		}  
	}  
}

위와 같이 기존에 만들어봤던 로그 인터셉터와 비슷하고, getDispatcherType()만 추가한 상태이다.

그리고 webConfig에 아래와 같이 인터셉터를 추가해준다.

1
2
3
4
5
6
7
@Override  
public void addInterceptors(InterceptorRegistry registry) {  
	registry.addInterceptor(new LogInterceptor())  
			.order(1)  
			.addPathPatterns("/**")  
			.excludePathPatterns("/css/**", "*.ico", "/error", "/error-page/**"); // 오류 페이지 경로  
}

필터의 경우 필터를 등록할 때 어떤 DispatcherType인 경우에 필터를 적용할 지 정했다.

하지만 인터셉터의 경우 서블릿이 제공하는 기능이 아닌 스프링이 제공하는 기능이기 때문에 DispatcherType과 무관하게 항상 호출된다.

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

참고

위에서 /error-page/** 를 제거해보면 /error-page/500 같은 내부에서의 호출 경우에도 인터셉터가 당연히 호출된다.

이렇게 내부적으로 컨트롤러가 호출 되는 부분을 로그로 찍고 싶거나 할 때 제거해 사용할 수 있는 것이다.

이러한 구조를 알고 상황에 맞게 사용하는 것이 중요하다.

전체 흐름 정리

  • 정상 요청

WAS -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

  • /error-ex 와 같은 오류 요청
  1. WAS(/error-ex, REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
  2. WAS <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러 (예외발생)
  3. WAS 오류 페이지 확인
  4. WAS(/error-page/500, ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) -> 컨트롤러(/error-page/500) -> view

스프링 부트 오류 처리

위에서 서블릿으로 예외 처리 페이지를 만들기 위해 아래와 같은 복잡한 과정을 거친다.

  • WebServerCustomizer를 만들어 예외 종류에 따라 ErrorPage 추가.
  • 예외 처리용 컨트롤러 ErrorpageController를 통해 ErrorPage에 맞는 View 반환

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

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

(ErrorMvcAutoConfiguration이라는 클래스가 오류 페이지를 자동으로 등록하는 역할을 한다.)

개발자는 오류 페이지만 등록한다.

BasicErrorController는 기본적인 로직이 모두 개발되어 있기 때문에 개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라 등록하면 된다.

정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해 동적으로 오류 화면을 만들고 싶다면 뷰 템플릿 경로에 오류 페이지 파일을 만들어 넣어두기만 하면 되는 것이다.

뷰 선택 우선순위

BasicErrorController의 처리 순서이다.

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

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

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

5xx 라고 하면 500대 오류를 처리하는 방식이다.

구현

즉, 단순하게 html 파일만 지정된 경로에 넣어주면 되는 것이다.

오류 페이지를 만들 때 BasicErrorController 가 제공하는 기본 정보들을 이용해보자.

1
2
3
4
5
6
7
8
* 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`)

위와 같은 정보들을 제공한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<!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>500 오류 화면 스프링 부트 제공</h2>  
		</div>  
		<div>  
			<p>오류 화면 입니다.</p>  
		</div>  
		<ul>  
			<li>오류 정보</li>  
				<ul>  
					<li th:text="|timestamp: ${timestamp}|"></li>  
					<li th:text="|path: ${path}|"></li>  
					<li th:text="|status: ${status}|"></li>  
					<li th:text="|message: ${message}|"></li>  
					<li th:text="|error: ${error}|"></li>  
					<li th:text="|exception: ${exception}|"></li>  
					<li th:text="|errors: ${errors}|"></li>  
					<li th:text="|trace: ${trace}|"></li>  
				</ul>  
			</li>  
		</ul>  
		<hr class="my-4">  
		</div> <!-- /container -->  
	</body>  
</html>

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

그래서 BasicErrorController 오류 컨트롤러에서 다음 오류 정보를 model에 포함할 지 여부를 선택할 수 있다.

application.properties

  • server.error.include-exception=false: exception 포함 여부
  • server.error.include-message: message 포함 여부
  • server.error.include-stacktrace=never : trace 포함 여부
  • server.error.include-binding-errors=never : errors 포함 여부

기본값이 never인 경우 아래의 3가지 옵션을 사용할 수 있다.

  • never : 사용하지 않음
  • always : 항상 사용
  • on_param : 파라미터가 있을 때 사용

on_param은 파라미터가 있으면 해당 정보를 노출하는데 디버그 시 문제를 확인하기 위해 사용할 수 있다.

하지만 이러한 부분도 개발 서버에서는 사용할 수 있지만 운영 서버에서는 권장하지 않는다. on_param으로 설정하고 아래와 같이 HTTP 요청 시 파라미터를 전달하면 해당 정보들이 model에 담겨 뷰 템플릿에서 출력 된다.

1
message=&errors=&trace=

실제 실무에서는 이런 것들을 노출하면 안된다. 사용자에게는 그저 이쁜 오류화면과 고객이 이해할 수 있는 간단한 오류 메시지를 보여주면 된다.

오류는 서버에 로그로 남겨서 확인하도록 하자.

참고

스프링 부트 관련 옵션

  • server.error.whitelabel.enabled=true: 오류 처리 화면을 못 찾을 시 스프링 whitelabel 오류 페이지 적용
  • server.error.path=/error: 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용된다.

확장 포인트

에러 공통 처리 컨트롤러의 기능을 변경하고 싶다면 ErrorController 인터페이스를 상속받아 구현하거나 BasicErrorController를 상속받아 기능을 추가하면 된다.

This post is licensed under CC BY 4.0 by the author.