【SpringBoot】SpringBoot 纯后端项目如何自定义异常页面(Whitelabel Error Page)

「爱情、让人受尽委屈。」 2023-10-10 18:24 10阅读 0赞

#### 文章目录 ####

*  背景
 *  安排
 *   *  方案
     *  步骤
 *  验证
 *  遇到的问题

## 背景 ##

*  一个短链服务，业务将长链接给我，我转换成短地址，用户访问短地址时，我再做redirect；
 *  没有前端，纯后端项目
 *  短链会有过期时间，过期后将返回错误信息
 *  某一天一个宁静的下午，业务反馈，你这错误码，直接给用户看，不友好，麻烦弄一个404页面吧。

![3ca7aeb298ed478957c2b9e8cb8ffa85.png][]

当前代码如下：当查询不到对应链接（过期、或者不存在）时，返回JSON格式的统一响应：

![2938bf6b61cfe80c3c55e9a1310f85c4.png][]

灵机一动，不需要JSON是吧，我直接返回404不就行了吗？于是稍作改动：

![67533a264567f6e8eddcb16ffbd9e9b2.png][]

此时再访问，会跳转到默认的error页面，看起来是比一个JSON串友好，但是，这东西，除了咱们这些**计算机科学家**，大部分人也看不懂，还是不友好！！！

![f2e7faa40daacb5cf2185c02326b6efd.png][]

## 安排 ##

### 方案 ###

有三种方法可以解决眼下的问题：

*  方法一：在配置文件中设置`server.error.whitelabel.enabled`为`false`，然后在controller中定义`/error`请求，返回自定义的内容。
 *  方法二：在项目中创建一个名为`error`的视图（如HTML或JSP文件），放在模板目录下（如`src/main/resources/templates`），然后SpringBoot会自动将错误请求转发到该视图。
 *  方法三：实现`ErrorPageRegistrar`接口，注册不同的错误页面，针对不同的HTTP状态码。
 *  方法四：搭一个nginx，作为404页面的静态资源服务器。

用户需求是返回一个好看的404页面，方法一排除；

项目是纯后端项目，方法二排除；

为一个页面搭一个nginx，不值当，方法四排除；

所以，选定方法三。

### 步骤 ###

方法三的详细说明如下：

*  首先，你需要创建一个配置类，实现`ErrorPageRegistrar`接口，这个接口有一个方法`registerErrorPages`，用于注册不同的错误页面。
 *  然后，你需要在`registerErrorPages`方法中创建一个`ErrorPage`数组，每个`ErrorPage`对象包含一个`HttpStatus`和一个路径，表示当发生该状态码的错误时，跳转到哪个路径。
 *  最后，你需要调用`registry.addErrorPages(errorPages)`方法，将错误页面数组注册到错误页面注册器中。

下面是一个示例代码：

@Configuration
    public class ErrorCodePageHandler implements ErrorPageRegistrar {
        
    
        @Override
        public void registerErrorPages(ErrorPageRegistry registry) {
        
            ErrorPage[] errorPages = new ErrorPage[2];
            // 添加错误页面进行映射
            errorPages[0] = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
            errorPages[1] = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");
            registry.addErrorPages(errorPages);
        }
    }

html文件需要放在静态资源目录下（如`src/main/resources/static`），然后在该文件夹中创建一个名为`404.html`的文件，写上你想要显示的内容。

这样，当发生404错误时，SpringBoot会自动将请求转发到`/404.html`路径，显示你自定义的错误页面。

一个最简单的404.html：

<!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>404 Not Found</title>
    </head>
    <body>
        <h1>Oops!</h1>
        <p>The page you are looking for does not exist.</p>
    </body>
    </html>

## 验证 ##

项目结构：

![0842773b7fd93d5cc2bec7e83153d546.png][]

页面效果：

![f5b1a80c6be4b39240142c2e005324b9.png][]

当然，这个页面不是最终效果，会有专业的小姐姐提供优美的页面。

## 遇到的问题 ##

浏览器：找不到与以下网址对应的网页：HTTP ERROR 404

![893bb89a4f8e3b12262d837c779c5e83.png][]

服务端：

No mapping for GET /404.html

No handler found for GET /404.html

Resolved \[org.springframework.web.servlet.NoHandlerFoundException: No handler found for GET /404.html\]

![9726e2a302dd4527f6520e3d3fa1006e.png][]

**解决：**

将配置文件中spring.resources.add-mappings去掉或改为true

spring:
      resources:
        add-mappings: false

**注意：**

如果有Controller中的mapping正好将/404.html匹配了，跳转时会直接走匹配的Controller方法，比如我的uri之前是/\{code\}，没加任何限制，就出现了response 404之后，又走了一次Controller。改成下面的好了：

![af85f71b88d8481450901b3f5c389ac8.png][]

[3ca7aeb298ed478957c2b9e8cb8ffa85.png]: https://img-blog.csdnimg.cn/img_convert/3ca7aeb298ed478957c2b9e8cb8ffa85.png
[2938bf6b61cfe80c3c55e9a1310f85c4.png]: https://img-blog.csdnimg.cn/img_convert/2938bf6b61cfe80c3c55e9a1310f85c4.png
[67533a264567f6e8eddcb16ffbd9e9b2.png]: https://img-blog.csdnimg.cn/img_convert/67533a264567f6e8eddcb16ffbd9e9b2.png
[f2e7faa40daacb5cf2185c02326b6efd.png]: https://img-blog.csdnimg.cn/img_convert/f2e7faa40daacb5cf2185c02326b6efd.png
[0842773b7fd93d5cc2bec7e83153d546.png]: https://img-blog.csdnimg.cn/img_convert/0842773b7fd93d5cc2bec7e83153d546.png
[f5b1a80c6be4b39240142c2e005324b9.png]: https://img-blog.csdnimg.cn/img_convert/f5b1a80c6be4b39240142c2e005324b9.png
[893bb89a4f8e3b12262d837c779c5e83.png]: https://img-blog.csdnimg.cn/img_convert/893bb89a4f8e3b12262d837c779c5e83.png
[9726e2a302dd4527f6520e3d3fa1006e.png]: https://img-blog.csdnimg.cn/img_convert/9726e2a302dd4527f6520e3d3fa1006e.png
[af85f71b88d8481450901b3f5c389ac8.png]: https://img-blog.csdnimg.cn/img_convert/af85f71b88d8481450901b3f5c389ac8.png