[Spring] 예외 처리와 오류 페이지

 

 

 

서블릿 예외 처리

• 서블릿은 2가지 방식으로 예외 처리를 지원한다.
  • Exception (예외)
  •  response.sendError(HTTP 상태코드, 오류 메시지)  

 

✔ 스프링 부트가 제공하는 기본 예외 페이지 끄기

server.error.whitelabel.enabled=false

• application.properties 설정 파일에서 작성하면 예외가 발생해도 스프링 부트가 제공하는 기본 예외 페이지가 나타나지 않는다.

 

🔍 Exception (예외)

💡 자바에서 직접 실행 (main 메서드)

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

 

💡 웹 애플리케이션

• 웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.
• 애플리케이션에서 예외가 발생했을 때, try-catch문으로 예외를 잡으면 상관 없다.
• 그러나 예외 해결을 하지 못했을 경우,  톰캣 같은 WAS까지 예외가 전달된다.
• 예외 흐름
  • WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러 (예외 발생)

 

📌 ServletExController (서블릿 예외 컨트롤러)

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Controller
@Slf4j
public class ServletExController {

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

• 실행하면 tomcat이 기본으로 제공하는 오류 화면을 볼 수 있다.
  • HTTP Status 500 – Internal Server Error
• Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태코드 500을 반환한다.

 

 

🔍 response.sendError()

• 오류가 발생했을 때 HttpServletResponse가 제공하는  sendError()  메서드 사용해도 된다.
• 해당 메서드를 호출한다고 당장 예외가 발생하는 것은 아니다. 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

response.sendError(HTTP 상태 코드)

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

 

📌 ServletExController (서블릿 예외 컨트롤러)

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Controller
@Slf4j
public class ServletExController {

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

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

}

 

💡 sendError 흐름

• WAS (sendError 호출 기록 확인) ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러 ( response.sendError() )
•  response.sendError() 를 호출하면 response 내부에서 오류가 발생했다는 상태를 저장한다.
• 서블릿 컨테이너는 response에  sendError() 가 호출되었는지 확인한 후 클라이언트에게 응답한다.
• 호출되었다면 설정한 오류 코드에 맞춰 기본 오류 페이지를 보여준다.

 

 

---

 

 

서블릿 예외 처리 - 오류 화면 제공

• 서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다. 그러므로 서블릿이 제공하는 오류 화면 기능을 사용해야 한다.
• 서블릿은 Exception(예외)이 발생해서 서블릿 밖으로 전달되거나 또는  response.sendError() 가 호출되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다. 이 기능을 사용하여 친절한 오류 처리 화면을 고객에게 제공할 수 있다.
• 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.

 

📌 서블릿 오류 페이지 등록 (오류 페이지 정보)

package hello.exception;

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

@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 호출
•  response.sendError(500)  : errorPage500 호출
• RuntimeException 또는 그 자식 타입의 예외 : errorPageEx 호출
  • 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다.
• 오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다.
• 오류 및 예외가 발생하면 Errorpage 생성자에 있는 두 번째 파라미터값인 주소값으로 이동하도록 오류 처리 컨트롤러가 필요하다.

 

📌 ErrorPageController (오류 처리 컨트롤러)

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

 

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

 

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

 

 

---

 

 

서블릿 예외 처리 - 오류 페이지 작동 원리

• 서블릿은 Exception이 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을 때 설정된 오류 페이지를 찾는다.
• 예외 발생 흐름
  • WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러 (예외 발생)
  • WAS (오류 페이지 요청) → 필터 → 서블릿 → 인터셉터 → 컨트롤러 (오류 페이지 설정 URL) → View
• sendError 흐름
  • WAS (sendError 호출 기록 확인) ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러 ( response.sendError() )
  • WAS (오류 페이지 요청) → 필터 → 서블릿 → 인터셉터 → 컨트롤러 (오류 페이지 설정 URL) → View
• WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인한다.
  • 예) new ErrorPage(RuntimeExcetpion.class, "/error-page/500")
  • 예를 들어서 RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다.
  • 확인해보지 RuntimeException의 오류 페이지는 /error-page/500으로 지정되어 있다.
  • WAS는 오류 페이지를 출력하기 위해 /error-page/500을 다시 요청한다.
•  중요한 점은 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어난지 전혀 모른다.
• 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출 동작이 일어난다.

 

🧷 정리

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

 

📌 ErrorPageController (오류 정보 출력)

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
@Controller
public class ErrorPageController {
    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");
        printErrorInfo(request);
        return "error-page/500";
    }

    private void printErrorInfo(HttpServletRequest request) {
        log.info("ERROR_EXCEPTION : {}", request.getAttribute(ERROR_EXCEPTION));
        log.info("ERROR_EXCEPTION_TYPE : {}", request.getAttribute(ERROR_EXCEPTION_TYPE));
        log.info("ERROR_MESSAGE : {}", request.getAttribute(ERROR_MESSAGE));
        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());
    }
}

• 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 상태 코드

 

 

---

 

 

서블릿 예외 처리 - 필터

• 예외 발생과 오류 페이지 요청 흐름
  • WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러 (예외 발생)
  • WAS (오류 페이지 요청) → 필터 → 서블릿 → 인터셉터 → 컨트롤러 (오류 페이지 설정 URL) → View
• 오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한 번 호출이 발생한다. 이 때 필터, 서블릿, 인터셉터도 모두 호출된다. 
  • 로그인 인증 체크 같은 경우, 이미 한 번 필터나 인터셉터에서 로그인 체크를 완료 한 상태다. 서버 내부에서 오류 페이지를 호출한다고 해당 필터나 인터셉터를 한 번 더 호출 하는 것은 비효율적이다.
  • 따라서 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지 출력을 위한 내부 요청인지 구분할 수 있어야 한다. 
• 서블릿은 이런 비효율 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다. 

 

🔍 DispatcherType

• DispatcherType을 이용하여 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청한 것인지 구별할 수 있다.
  • 고객이 처음 요청하면 dispatcherType=REQUEST 다.

 

📌 javax.servlet.DispatcherType

public enum DispatcherType {
 FORWARD,
 INCLUDE,
 REQUEST,
 ASYNC,
 ERROR
}

• REQUEST : 클라이언트 요청
• ERROR  : 오류 요청
• FORWARD : 서블릿이나 JSP를 호출할 때
  • RequestDispatcher.forward(request, response)
• INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결괄르 포함할 때
  • RequestDispatcher.include(request, response)
• ASYNC : 서블릿 비동기 호출

 

📌 LogFilter (DispatcherType 로그 추가)

package hello.exception.filter;


import lombok.extern.slf4j.Slf4j;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;

@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 {}", e.getMessage());
            throw e;
        } finally {
            log.info("RESPONSE [{}] [{}] [{}]", uuid, request.getDispatcherType(), requestURI);
        }
    }

    @Override
    public void destroy() {
        log.info("log filter destroy");
    }
}

 

📌 WebConfig

package hello.exception;


import hello.exception.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.servlet.DispatcherType;
import javax.servlet.Filter;


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

•  filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR)  
  • 이렇게 두 가지 모두 넣으면 클라이언트 요청과 오류 페이지 요청에서도 필터가 호출된다.
  • 아무것도 넣지 않으면 기본갓이 DispatcherType.REQUEST이다. 즉, 클라이언트의 요청이 있는 경우에만 필터가 적용된다.
  • 특별히 오류 페이지 경로도 필터를 적용할 것이 아니라면 기본 값을 그대로 사용하면 된다.

 

 

---

 

 

서블릿 예외 처리 - 인터셉터

• 예외 발생시 인터셉터의 중복 호출을 제거할 수 있다.

 

 

📌 LogInterceptor (DispatcherType 로그 추가)

package hello.exception.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

@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("REQUEST [{}] [{}] [{}]", logId, request.getDispatcherType(), requestURI);

        if (ex!=null) {
            log.error("afterCompletion error!!", ex);
        }

    }
}

 

📌 WebConfig

package hello.exception;


import hello.exception.filter.LogFilter;
import hello.exception.interceptor.LogInterceptor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.servlet.DispatcherType;
import javax.servlet.Filter;


@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor())
                .order(1)
                .addPathPatterns("/**")
                .excludePathPatterns("/css/**", "*.ico", "/error", "/error-page/**");  // excludePathPatterns에 오류 페이지 경로 추가

    }
}

• 서블릿 필터의 경우 필터를 등록할 때 해당 DispatcherType인 경우에만 필터를 적용할 지 선택할 수 있다.
• 하지만 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이라서 DispatcherType과 무관하게 항상 호출된다.
• 대신 인터셉터는 요청 경로에 따라서 추가하거나 제외하기 쉽다.
• 이러한 설정을 통해 오류 페이지 경로를 excludePathPatterns를 사용해서 빼면 된다.

 

 

 

🧷 정리

• 정상 요청
  • WAS(/hello, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View
• 에러 페이지 오류 요청
  • WAS(/error-ex, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
  • WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
  • WAS가 오류 페이지를 확인한다.
  • WAS (/error-page/500, dispatchType=ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) -> 컨트롤러(/error-page/500) -> View
• 에러 페이지 오류 요청시 필터는 DispatchType으로 중복 호출을 제거할 수 있고, 인터셉터는 경로 정보로 중복 호출을 제거할 수 있다.

 

 

---

 

 

스프링 부트 - 오류 페이지

• 스프링 부트에서는 오류 페이지 기능을 제공한다.
  • 스프링 부트는 ErrorPage를 자동 등록한다. 이 때 /error 라는 경로로 기본 오류 페이지를 설정한다.
    • new ErrorPage("/error"), 상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.
    • 서블릿 밖에서 예외가 발생하거나, response.sendError(...)가 호출되면 모든 오류는 /error를 호출한다.
  • 스프링 부트는 BasiseErrorController 라는 스프링 컨트롤러를 자동으로 등록한다.
    • ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러다.
• 참고) ErrorMvcAutoConfiguration 클래스는 오류 페이지를 자동으로 등록해주는 역할을 한다.
• 이제 오류가 발생하면 오류 페이지로 /error를 기본 요청으로 한다. 스프링 부트가 자동으로 등록한 BasicErrorController는 이 경로를 기본으로 받는다.
• 스프링 부트가기본으로 제공하는 오류 페이지를 활용하면 오류 페이지와 관련된 대부분의 문제는 쉽게 해결할 수 있다.

 

🔍 따라서 개발자는 오류 페이지(HTML 파일)만 등록하면 된다.

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

 

💡 뷰 선택 우선 순위 (BasicErrorController의 처리 순서)

• 뷰 템플릿이 정적 리로스보다 우선순위가 높다.
• 404, 500 처럼 구체적인 것이 5xx 처럼 덜 구체적인 것보다 우선순위가 높다.
• 사용 예)
  • 뷰 템플릿
    • 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 상태 코드 이름의 뷰파일을 넣어두면 된다.

 

✔ 오류 페이지(HTML 파일) 예시)

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

 

 

🔍 BasicErrorController가 제공하는 기본 정보들

• BasicErrorController 컨트롤러는 에러 정보를 model에 담아서 뷰에 전달한다.
• 뷰 템플릿은 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`)

• 그러나 오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않다.
• 고객이 해당 정보를 읽어도 혼란만 더 가중되고 보안상 문제가 될 수 있다.
• 실무에서는 사용자에게 이쁜 오류 화면만 보여줘서 고객이 이해할 수 있는 간단한 오류 메시지만 보여줘야 한다. 오류는 서버에 로그로 남겨서 로그로 확인해야 한다.

 

 

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

• 오류 정보를 출력할 뷰
• 그러나 오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않다.
• 고객이 해당 정보를 읽어도 혼란만 더 가중되고 보안상 문제가 될 수 있다.

 

💡 오류 정보를 model에 포함할지 여부를 선택할 수 있다.

📌 application.properties

server.error.whitelabel.enabled=false

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

server.error.path=/error

• server.error.include-exception
  • exception 포함 여부
  • false (기본값) / true
• server.error.include-message
  
  • message 포함 여부
  • never (기본값) / always / on_param (파라미터가 있을 때 사용)
    • on_param 일 경우 url 주소에 'message=' 를 적으면 해당 오류 메시지가 출력된다.
• server.error.include-stacktracer 
  • trace 포함 여부
  • never (기본값) / always / on_param
• server.error.include-binding-errors
  • errors 포함 여부
  • never (기본값) / always / on_param 
• 기본 값인 never 또는 false로 사용할 것을 권장한다.
  • application.properties 파일에 적지 않으면 자동으로 기본값으로 설정된다.
• 해당 에러 정보들은 개발 서버에서는 쓰일 수 있으나 운영 서버에서는 사용하면 안된다.
• server.error.whitelabel.enabled
  • 오류 처리 화면을 못 찾을시, 스프링 whitelabel 오류 페이지를 적용할지 여부
  • true (기본값) / false

• server.error.path=
  • 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로 설정 (에러 발생시 전달할 경로 설정)
  • /error (기본값)

 

💡 확장 포인트

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

 

 

 

🧷 정리

📌 application.properties

server.error.whitelabel.enabled=false

• 스프링 부트가 제공하는 기본 오류 페이지를 fasle로 비활성화 한다.
• resource/static/error 또는 /resource/templates/error 폴더를 생성한 후 거기 안에 5xx.HTML, 404.HTML, 4xx.HTML 이런 식으로 파일을 생성하면 스프링 부트가 우선순위에 따라 자동으로 오류 페이지를 매핑해준다.

 

 

 

 

 

---

👀 참고 자료

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의