스프링 부트를 사용해 예외 처리 페이지 제공하기

서블릿만으로 예외 처리 페이지를 만들기 위해서 다음과 같은 복잡한 과정이 필요합니다.

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. 뷰 템플릿

• 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

해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 됩니다.

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

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

 

오류 페이지 추가하기

• resources/templates/error/4xx.html
• resources/templates/error/404.html
• resources/templates/error/500.html

컨트롤러 설정

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

    @GetMapping("/error-400")
    public void error400(HttpServletResponse response) throws IOException {
        response.sendError(400, "400 오류!");
    }
    @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);
    }
}

 

테스트

http://localhost:8080/error-404 => 404.html

http://localhost:8080/error-400 => 4xx.html (400 오류 페이지가 없지만 4xx가 있음)

http://localhost:8080/error-500 => 500.html

http://localhost:8080/error-ex => 500.html (예외는 500으로 처리)

 

 

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

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

그래서 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 포함 여부

 

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

never, always, on_param

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

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

그런데 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장하지 않습니다.

on_param으로 설정하고 다음과 같이 HTTP 요청 시 파라미터를 전달하면 해당 정보들이 model에 담겨서 뷰 템플릿에서 출력됩니다.

message=&errors=&trace=

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

 

• 테스트하기

http://localhost:8080/error-ex?message=&errors=&trace=

 

• 스프링 부트 오류 관련 옵션

server.error.whitelabel.enabled=true : 오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오류 페이지 적용

server.error.path=/error : 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용됩니다.

 

• 확장 포인트

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