Spring Boot 404配置转发页面

简介

在使用Spring Boot开发Web应用时，经常会遇到404页面不存在的情况。为了提供更好的用户体验，我们可以配置一个转发页面，当用户请求不存在的页面时，自动跳转到指定的页面。

本文将介绍如何在Spring Boot项目中配置404转发页面，并提供相关的代码示例。我们将以一个简单的示例项目为例进行讲解。

准备工作

首先，我们需要准备一个Spring Boot项目。可以使用以下命令创建一个新的Spring Boot项目：

$ spring init -n=example -g=com.example -a=example --dependencies=web example-project

这将创建一个名为example-project的新的Spring Boot项目，使用com.example作为包名，并添加Web依赖。

配置转发页面

创建404页面

首先，我们需要创建一个404页面。在src/main/resources/templates目录下创建一个名为404.html的文件，并编写以下内容：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>404 Page Not Found</title>
</head>
<body>
    404 Page Not Found
    <p>The requested page does not exist.</p>
</body>
</html>

这是一个简单的HTML页面，显示了404错误信息。

配置转发

接下来，我们需要配置Spring Boot项目，将404请求转发到我们创建的404页面。

在src/main/java/com/example/exampleproject目录下创建一个名为CustomErrorController.java的Java类，并编写以下内容：

@Controller
public class CustomErrorController implements ErrorController {

    @RequestMapping("/error")
    public String handleError(HttpServletRequest request) {
        // 获取错误状态码
        Object status = request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);

        // 如果是404错误，转发到404页面
        if (status != null && status.toString().equals(HttpStatus.NOT_FOUND.toString())) {
            return "404";
        }

        // 其他错误，转发到默认错误页面
        return "error";
    }

    @Override
    public String getErrorPath() {
        return "/error";
    }
}

这个类是一个自定义的错误控制器，实现了Spring Boot提供的ErrorController接口。其中，handleError方法用于处理错误请求，根据错误状态码决定转发到哪个页面。如果是404错误，将转发到404.html页面，否则转发到默认的错误页面。

测试转发功能

现在，我们已经完成了404转发页面的配置。接下来，我们可以使用以下命令运行项目：

$ mvn spring-boot:run

项目启动后，我们可以在浏览器中访问一个不存在的页面，例如http://localhost:8080/nonexistent。应该能够看到浏览器显示了我们创建的404页面，即404 Page Not Found。

总结

通过以上步骤，我们成功地配置了Spring Boot项目的404页面转发功能。当用户请求一个不存在的页面时，自动跳转到指定的404页面，提供更好的用户体验。

在实际开发中，我们可以根据需要自定义404页面的样式和内容，让用户感知到页面不存在的原因，并提供相应的帮助或导航。

希望本文对你理解和配置Spring Boot的404页面转发功能有所帮助。如果有任何疑问，请随时提问。

附录

类图

以下是本文中涉及的类的简单类图：

classDiagram
    class CustomErrorController {
        +handleError(HttpServletRequest request): String
        +getErrorPath(): String
    }

流程图

以下是本文中配置404页面转发的流程图：

flowchart TD
    A[开始] --> B{请求是否为404错误}
    B -- 是 --> C[转发到404页面]
    B -- 否 --> D[转发到默认错误页面]
    C --> E[结束]
    D --> E[结束]
    E[结束] --> F[返回页面]

参考资料

  • [Spring Boot官方文档](
  • [Spring Boot Reference Guide](