SpringBoot - BasicErrorController

현시기얌·2021년 8월 15일

ServletException

목록 보기
7/7

BasicErrorController

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

timestampSun Aug 16 00:00:00 KST 2021
status400
errorBad Request
exceptionorg.springframework.validation.BindException
trace예외 trace
messageValidation failed for obeject='data'. Error count: 1
errorsErrors(BindResult)
path클라이언트 요청 경로 ('/hello')

하지만 이런 오류 관련 내부 정보들을 클라이언트에게 노출하는 것은 좋지 않다.
따라서 BasicErrorController에서 다음 오류 정보를 model에 포함할지 여부를 선택할 수 있다.

application.yml

server:
  error:
    whitelabel:
      enabled: false
    include-exception: false
    include-message: never
    include-stacktrace: never
    include-binding-errors: never

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

on_param은 파라미터가 있으면 해당 정보를 노출한다. 디버그시 문제를 확인하기 위해 사용할 수 있다. 그런데 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장하지 않는다.
on_param으로 설정하고 다음과 같이 HTTP 요청 시 파라미터를 전달하면 해당 정보들이 model에 담겨서 뷰 템플릿에서 출력된다.
message=&errors=&trace=

오류 정보 추가 500.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="|erros: ${errors}|"></li>
            <li th:text="|trace: ${trace}|"></li>
        </ul>
    </ul>

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

</body>
</html>

결과

스프링 부트 오류 관련 옵션

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

확장 포인트

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

profile
현시깁니다

0개의 댓글