SpringBoot 统一配置错误页面 403 404 500

女爷i 2022-12-31 02:27 278阅读 0赞

## 场景 ##

后端框架：SpringBoot  
当请求资源不存在时，页面如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70]  
如何配置自己的页面，当404时显示？

## 解决 ##

1.  先在`src/main/resources/static/`目录下准备好页面  
    `403.html`  
    `404.html`  
    `500.html`  
    `index.html`  
    如图：  
    ![在这里插入图片描述][20201228223357855.png]

名字可以自己命名，只要和代码中对应起来就可以。

1.  新增配置类

在**可以被扫描到的包**下面添加以下配置类：

import org.springframework.boot.web.server.ErrorPage;
    import org.springframework.boot.web.server.ErrorPageRegistrar;
    import org.springframework.boot.web.server.ErrorPageRegistry;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.http.HttpStatus;
    
    /** * SpringBoot配置错误页面 */
    @Configuration
    public class BachErrorPageRegistrar implements ErrorPageRegistrar { 
    
        @Override
        public void registerErrorPages(ErrorPageRegistry registry) { 
            ErrorPage[] errorPages = new ErrorPage[] { 
                    new ErrorPage(HttpStatus.FORBIDDEN, "/403.html"),
                    new ErrorPage(HttpStatus.NOT_FOUND, "/404.html"),
                    new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html"),
            };
            registry.addErrorPages(errorPages);
        }
    
    }

当然，当HTTP响应码为`403 404 500`等错误时，也可以返回`index.html`。  
如果功能上没有细致要求的话。

对于步骤2，还有另一种配置方法(适用于 SpringBoot 2+)：

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
    import org.springframework.boot.web.server.ErrorPage;
    import org.springframework.boot.web.server.WebServerFactoryCustomizer;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.http.HttpStatus;
    
    @Configuration
    public class ErrorPageConfig { 
    
        @Bean
        public WebServerFactoryCustomizer<ConfigurableWebServerFactory> webServerFactoryCustomizer() { 
            WebServerFactoryCustomizer<ConfigurableWebServerFactory> webCustomizer = new WebServerFactoryCustomizer<ConfigurableWebServerFactory>() { 
                @Override
                public void customize(ConfigurableWebServerFactory factory) { 
                    ErrorPage[] errorPages = new ErrorPage[] { 
                            new ErrorPage(HttpStatus.FORBIDDEN, "/403.html"),
                            new ErrorPage(HttpStatus.NOT_FOUND, "/404.html"),
                            new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html"),
                    };
                    factory.addErrorPages(errorPages);
                }
            };
            return webCustomizer;
        }
    
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70]: /images/20221120/3361ebe74c3d47b6b929189616aee4b8.png
[20201228223357855.png]: /images/20221120/dc07cdf1a6d147699cd9ddabefebdb04.png