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

已于 2023-06-28 16:24:16 修改
阅读量2.2k 收藏 5
点赞数
分类专栏： Java 文章标签： spring boot java 后端
于 2023-05-18 19:19:09 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_14840559/article/details/130753519
版权

文章目录

背景

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

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

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

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

安排

方案

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

  • 方法一：在配置文件中设置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>

验证

项目结构：

页面效果：

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

遇到的问题

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

服务端：

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]

解决：

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

spring:
  resources:
    add-mappings: false

注意：

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

喝不完一杯咖啡
关注
专栏目录
【SpringBoot】29、SpringBoot中定制异常页面
Asurplus
08-07 20万+
定制异常页面，可以避免用户产生恐慌心理，使得产品有更好的用户体验。今天来学习在 SpringBoot 中如何定制开发异常页面 一、历史回顾 在 SpringMVC 年代，我们的异常页面一般配置在 web.xml 文件中，如下： <!-- 配置404页面 --> <error-page> <error-code>404</error-code> <location>/error/404.html</location>
SpringBoot2.2.6统一异常返回json，取消Whitelabel Error Page
你那么害怕明天，怎么能过好今天！
03-25 696
统一异常返回非常简单就是@RestControllerAdvice+@ExceptionHandler()这两个注解 一、新建一个自定义异常类，继承RuntimeException public class CommonException extends RuntimeException { String message; @Override public String getMessage() { return super.getMessage();
java Spring Boot自定义错误页面
m0_72642319的博客
06-28 720
java Spring Boot自定义错误页面
Spring Boot自定义错误页面
12-06
该资源是我的博文《Spring Boot自定义错误页面》的关联资源，博文链接：http://blog.csdn.net/github_32521685/article/details/50198467
项目中配置 Knife4j
最新发布
2301_77615930的博客
08-29 249
项目中配置 Knife4j 总是报错 Whitelabel Error Page 解决办法
springboot自定义错误页面
我要上天
05-19 1万+
自定义一个controller实现ErrorController，重写getErrorPath方法，ErrorController是springboot自带的错误控制器@Controller @RequestMapping(value = "/error")//这个映射是必须的 public class BaseErrorController implements ErrorController {
SpringBoot自定义错误页面
weixin_34010949的博客
09-10 208
Spring Boot以一种新的微服务的方式来替代以Spring Framework构建项目的传统方式，我已经计划在后续的项目开发中使用它。它已经帮我们做了90%的工作，剩下10%的工作需要我们自己去完成。对于我来说，自定义错误页面就是其中之一。比如404错误，如果不处理的话，会出现“This application has no explic...
Spring Boot自定义错误页面，Whitelabel Error Page处理方式
热门推荐
Viking的博客
12-06 8万+
我已经是Spring Framework框架的忠实粉丝。对于企业软件开发者来说它提供了对常见问题的通用解决方案，包括那些你在未来开发中没有意识到的问题。但是，它构建的J2EE项目变得比较臃肿，需要被一种新的解决方案替代。我最大的抱怨就是最开始使用Spring Framework构建项目十分缓慢和复杂，比如构建一个包含JPA的MVC应用。为改变这种情况，Spring Boot应运而生了。Spring
4-SpringBoot项目运行页面报错：Whitelabel Error Page的解决办法
小茜的博客
10-04 5121
解决办法1：让项目启动类和Controller处于同一层 解决办法2：可能这个url请求根本没有写对应的Controller方法，需要写一个url请求对应的Controller方法来处理url请求 @RequestMapping(path = {"/reglogin"}, method = {RequestMethod.GET}) public String regloginPage(Model model, @RequestParam(value = "next", required = false).
搭建springboot项目出现Whitelabel Error Page，type=Internal Server Error, status=500问题解决方法
qq_56740869的博客
03-21 4345
Whitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback. Mon Mar 21 12:43:37 CST 2022 There was an unexpected error (type=Internal Server Error, status=500).
springBoot测试页面Whitelabel Error Page解决方案
JavaEE_ZCR的博客
11-11 635
springBoot测试页面Whitelabel Error Page解决方案 前言: Spring Boot 主要作用就是帮助开发人员快速的构建庞大的spring项目，并且尽可能的减少一切xml配置，做到开箱即用，迅速上手，让开发人员关注业务而非配置。 笔者在测试的时候出现的这个问题,相信也有不少小伙伴会碰到下面就分享一下笔者的解决方案,笔者出现这个问题的原因很简单,先看看笔者的项目包结构 可以明显看到,这个项目的springBoot驱动类Application和项目其他测试类是在同一级目录下(包目
spring boot Whitelabel Error Page
nick_king的博客
12-27 197
Whitelabel Error Page 出现这个情况可能会有很多原因，我的原因是在配置文件上，我在配置文件中是这么写的： 在controller中也写了个hello，具体的如下图所示： 但是我启动过后访问localhost:8080/hello，始终都是Whitelabel Error Page这个错误，经过多次排查以及自己的猜测，找到了解决办法，访问localhost:8080/hel...
Spring boot 提示“Whitelabel Error Page”
惊鸿的博客
03-21 4226
spring出现下图的错误： 首先有以下可能: 1、端口错误 由于我近期学习了 自定义环境，可以随意切换开发的环境，我们记得地址框输入的时候，要改成自己的端口号 2、GetMapping 书写错误 此处也要和地址栏一一对应 3、controller 和我们的启动类不在同包下 这个问题我弄了好久，这背时的同一目录下，童鞋们！必须在同一目录！下,如： ...
springboot项目中出现Whitelabel Error Page
u012778718的博客
06-04 2847
访问springboot项目显示结果 出现白页的原因： 请求进入org.springframework.web.servlet.DispatcherServlet#doDispatch方法中： #通过请求查询可供处理的handler mappedHandler = getHandler(processedRequest); 默认注册了4个handlerMapping，分别是： org.springframework.web.servlet.mvc.method.annotation.RequestM
Spring Boot定制错误页面
NewBeen1的博客
11-06 343
本文将通过实例代码和原理解析，详细介绍如何在Spring Boot应用中定制错误页面，提升用户体验和故障排除效率。
自定义 whitelabel Error Page异常页面 | MSCode微服务平台框架代码源码
iframework的博客
04-16 383
自定义 whitelabel Error Page异常页面。 MSCode微服务平台框架mscodecloud.com 代码示例 server.error.whitelabel.enabled=false MSCode微服务平台框架mscodecloud.com 基于Spring Cloud、Spring Boot和Activiti7工作流，提供所有源码和详尽文档，帮助企业快速开发分布...
SpringBoot 页面显示whitelabel error page
zjh12312311的博客
02-16 551
报错：HikariPool-1 - Driver does not support get/set network timeout for connections. (com.mysql.jdbc.JDBC4Connection.getNetworkTimeout()I) 原因：丢了@ResponseBody，它是作用在方法上的，所以每个方法都要加。@ResponseBody 表示该方法的返回...
springboot项目启动成功，页面Whitelabel Error Page
09-20
要解决页面显示"Whitelabel Error Page"的问题，您需要按照以下步骤进行操作: 1. 首先，请确保您的pom.xml文件中已正确引入了Spring Boot Thymeleaf依赖，如下所示: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> ``` 2. 然后，您需要在application.properties文件中添加以下配置: ```properties spring.web.resources.static-locations=classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,classpath:/templates/ spring.thymeleaf.cache=false spring.thymeleaf.prefix=classpath:/templates/ spring.thymeleaf.suffix=.html spring.thymeleaf.encoding=utf-8 ``` 这些配置将指定Thymeleaf模板的位置和相关属性。 完成以上步骤后，重新启动您的Spring Boot项目，应该可以看到您的自定义页面而不是"Whitelabel Error Page"。 请注意，如果您没有创建自定义错误处理器或映射错误页面，Spring Boot会显示默认的"Whitelabel Error Page"。如果您想要自定义错误页面，可以创建一个`ErrorController`类并在其中处理错误，并将错误页面放置在指定的位置。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值