springboot 自定義錯誤頁面

Spring Boot默認使用嵌入式Tomcat，默認沒有頁面來處理404等常見錯誤。因此，為了給用戶最佳的使用體驗，404等常見錯誤需要我們自定義頁面來處理。

在springboot2.0之前用org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer類來實現該功能。

使用Java 7內部類的實現：

@Bean
public EmbeddedServletContainerCustomizer containerCustomizer() {
    return new EmbeddedServletContainerCustomizer() {
        @Override
        public void customize(ConfigurableEmbeddedServletContainer container) {

            ErrorPage error401Page = new ErrorPage(HttpStatus.UNAUTHORIZED, "/401.html");
            ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
            ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");

            container.addErrorPages(error401Page, error404Page, error500Page);
        }
    };
}

Java 8的lambda表達式寫法：

@Bean
public EmbeddedServletContainerCustomizer containerCustomizer() {

   return (container -> {
        ErrorPage error401Page = new ErrorPage(HttpStatus.UNAUTHORIZED, "/401.html");
        ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
        ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");

        container.addErrorPages(error401Page, error404Page, error500Page);
   });
}

在代碼中創建了三個ErrorPage實例來處理三個通用的HTTP錯誤狀態碼，並將他們添加到container當中。ErrorPage類是一個封裝了錯誤信息的類，它可以在Jetty和Tomcat環境下使用。

 

錯誤頁面需要放在項目static內容目錄下，它的默認位置是：src/main/resources/static，如下圖所示：

 

在Spring Boot2.0以上配置嵌入式Servlet容器時EmbeddedServletContainerCustomizer類不存在，被WebServerFactoryCustomizer替代

       使用WebServerFactoryCustomizer接口替換EmbeddedServletContainerCustomizer組件完成對嵌入式Servlet容器的配置，示例代碼如下：

@Bean
 
public WebServerFactoryCustomizer<ConfigurableWebServerFactory> webServerFactoryCustomizer(){　

　　return (container -> {
    　　ErrorPage error401Page = new ErrorPage(HttpStatus.UNAUTHORIZED, "/error/401.html");
    　　ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/error/404.html");
    　　ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error/500.html");

    　　container.addErrorPages(error401Page, error404Page, error500Page);
　　});

 }

在WebServerFactoryCustomizer接口中使用ConfigurableWebServerFactory對象實現對customize()方法的轉換，從而實現對嵌入式servlet容器的配置。

 

附注：

springboot 1.x

import org.apache.catalina.connector.Connector;
import org.apache.coyote.ProtocolHandler;
import org.apache.coyote.http11.Http11NioProtocol;
import org.apache.tomcat.util.threads.ThreadPoolExecutor;
import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.embedded.tomcat.TomcatConnectorCustomizer;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory;
import org.springframework.boot.web.servlet.ErrorPage;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;


@Component
public class EmbeddedTomcatConfig implements EmbeddedServletContainerCustomizer{

    @Override
    public void customize(ConfigurableEmbeddedServletContainer container) {
        TomcatEmbeddedServletContainerFactory factory = (TomcatEmbeddedServletContainerFactory)container;
        factory.addConnectorCustomizers(new TomcatConnectorCustomizer() {
            @Override
            public void customize(Connector connector) {
                Http11NioProtocol protocol = (Http11NioProtocol) connector.getProtocolHandler();
                protocol.setMaxConnections(200);
                protocol.setMaxThreads(200);
                protocol.setSelectorTimeout(3000);
                protocol.setSessionTimeout(3000);
                protocol.setConnectionTimeout(3000);
            }
        });
    }
}

通過實現org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer的customize方法來實現自定義

springboot 2.x

import org.apache.catalina.connector.Connector;
import org.apache.coyote.ProtocolHandler;
import org.apache.coyote.http11.Http11NioProtocol;
import org.apache.tomcat.util.threads.ThreadPoolExecutor;
import org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;


@Component
public class EmbeddedTomcatConfig implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {

    @Override
    public void customize(ConfigurableServletWebServerFactory factory) {
        ((TomcatServletWebServerFactory)factory).addConnectorCustomizers(new TomcatConnectorCustomizer() {
            @Override
            public void customize(Connector connector) {
                Http11NioProtocol protocol = (Http11NioProtocol) connector.getProtocolHandler();
                protocol.setMaxConnections(200);
                protocol.setMaxThreads(200);
                protocol.setSelectorTimeout(3000);
                protocol.setSessionTimeout(3000);
                protocol.setConnectionTimeout(3000);
            }
        });
    }
}

在2.x版本改為實現org.springframework.boot.web.server.WebServerFactoryCustomizer接口的customize方法

springboot1.x的相關類如下：

• org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer
• org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer
• org.springframework.boot.context.embedded.tomcat.TomcatConnectorCustomizer
• org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory

springboot2.x的相關類如下：

• org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory
• org.springframework.boot.web.server.WebServerFactoryCustomizer
• org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer
• org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory