오봉이와 함께하는 개발 블로그

스프링 MVC 2 - 스프링 부트 : 오류 페이지 본문

BE/Spring

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

오봉봉이 2022. 8. 30. 22:20
728x90

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

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

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

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

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

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

스프링 부트가 제공하는 기본 오류 메커니즘을 사용하도록 WebServerCustomizer에 있는 @Component를 주석 처리하자.
그럼 이제 오류가 발생했을 때 오류 페이지로 /error를 기본 요청한다.
스프링 부트가 자동 등록한 BasicErrorController는 이 경로를 기본으로 받는다.

개발자는 오류 페이지만 등록
BasicErrorController는 기본적인 로직이 모두 개발되어 있다.
개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라서 등록하면 된다.
정적 HTML이면 정적 리소스, 뷰 템플릿을 사용하고, 동적으로 오류 화면을 만들고 싶으면 뷰 템플릿 경로에 오류 페이지 파일을 만들어서 넣어두기만 하면 된다.

뷰 선택 우선순위

BasicErrorController의 처리 순서

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

해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.
뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500처럼 구체적인 것이 5xx처럼 덜 구체적인 것 보다 우선순위가 높다.
5xx, 4xx 라고 하면 500대, 400대 오류를 처리해준다.

오류 뷰 템플릿 추가

resources/templates/error/404.html

<!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>

resources/templates/error/4xx.html

<!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>4xx 오류 화면 스프링 부트 제공</h2>
    </div>

    <div>
        <p>오류 화면 입니다.</p>
    </div>

    <hr class="my-4">

</div> <!-- /container -->

</body>
</html>

resources/templates/error/500.html

<!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>

    <hr class="my-4">

</div> <!-- /container -->

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

오류 정보 추가 - resources/templates/error/500.html

<!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 포함 여부(true, false)
server.error.include-message=never : message 포함 여부
server.error.include-stacktrace=never : trace 포함 여부
server.error.include-binding-errors=never : errors 포함 여부

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

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

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

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

스프링 부트 오류 관련 옵션

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

확장 포인트

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

정리

스프링 부트가 기본으로 제공하는 오류 페이지를 활용하면 오류 페이지와 관련된 대부분의 문제는 손쉽게 해결할 수 있다.
웹 어플리케이션에서 오류 처리는 적당히 예쁜 웹 페이지를 만들어서 보여주면 되는 것이기 때문에 간단하다.
하지만 문제는 API 애플리케이션에서 발생한다.
API 통신에서 예외가 발생하면 어떤 형식으로 에러를 전달할지 정하는 규약을 만들어 놓고 규약에 따라 전달해야 하기 때문이다.

출처 : 인프런 김영한 지식공유자님 강의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술
728x90
저작자표시

'BE > Spring' 카테고리의 다른 글

스프링 MVC 2 - 스프링 부트 기본 오류 처리  (0) 2022.08.31
스프링 MVC 2 - API 예외 처리 : 시작  (0) 2022.08.30
스프링 MVC 2 - 서블릿 예외 처리 : 인터셉터  (0) 2022.08.30
스프링 MVC 2 - 서블릿 예외 처리 : 필터  (0) 2022.08.30
스프링 MVC 2 - 서블릿 예외 처리 오류 페이지 작동 원리  (0) 2022.08.30
'BE/Spring' Related Articles more
Comments