spring boot errorcontroller-摩杜云开发者社区

使用Spring Boot ErrorController实现自定义错误页面

介绍

在开发Web应用程序时，处理错误页面是一项重要的任务。Spring Boot提供了ErrorController接口，允许我们自定义错误处理逻辑和错误页面。本文将介绍如何使用Spring Boot的ErrorController接口来实现自定义错误页面。

流程

下表展示了整个过程的步骤：

步骤	描述
1	创建一个实现ErrorController接口的自定义错误处理器类
2	配置Spring Boot应用程序，告诉它使用我们的自定义错误处理器
3	创建一个自定义的错误页面
4	测试错误处理器和错误页面的功能

接下来，我们将逐步介绍每个步骤需要做什么，以及相应的代码。

代码实现

步骤1：创建自定义的错误处理器类

首先，我们需要创建一个实现ErrorController接口的自定义类。这个类将处理发生的错误并返回相应的错误页面。

@Controller
public class CustomErrorController implements ErrorController {

    @RequestMapping("/error")
    public String handleError(HttpServletRequest request) {
        // 获取错误代码
        Object status = request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
        
        // 根据错误代码返回不同的错误页面
        if (status != null) {
            int statusCode = Integer.parseInt(status.toString());
            
            if (statusCode == HttpStatus.NOT_FOUND.value()) {
                return "error404";
            } else if (statusCode == HttpStatus.INTERNAL_SERVER_ERROR.value()) {
                return "error500";
            }
        }
        
        // 默认错误页面
        return "error";
    }

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

在这个例子中，我们创建了一个名为CustomErrorController的类，通过注解@Controller将其声明为一个控制器。我们实现了ErrorController接口，并重写了它的两个方法：handleError和getErrorPath。

handleError方法是处理错误的核心方法。它接收一个HttpServletRequest对象作为参数，通过获取错误代码来判断发生了哪种类型的错误，并返回相应的错误页面。

getErrorPath方法返回一个String，指定了错误处理器的路径。在我们的例子中，我们简单地返回了"/error"作为路径。

步骤2：配置Spring Boot应用程序

为了告诉Spring Boot应用程序使用我们的自定义错误处理器，我们需要在配置类中添加一些配置。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private CustomErrorController customErrorController;

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/error").setViewName("error");
    }

    @Bean
    public ErrorController errorController() {
        return customErrorController;
    }
}

在这个例子中，我们创建了一个名为WebConfig的配置类，通过注解@Configuration将其声明为一个配置类。我们实现了WebMvcConfigurer接口，并重写了它的addViewControllers方法。

addViewControllers方法用于配置错误页面的映射。我们在这里添加了一个映射，将"/error"路径映射到名为"error"的视图。

我们还创建了一个名为errorController的Bean，并将CustomErrorController注入到它中。这样，Spring Boot应用程序将使用我们的自定义错误处理器。

步骤3：创建自定义错误页面

现在，我们需要创建一些自定义的错误页面，用于展示不同类型的错误信息。在这个例子中，我们创建了error.html、error404.html和error500.html三个页面。

<!-- error.html -->
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Error</title>
</head>
<body>
    Error
    <p>An error occurred.</p>
</body>
</html>

<!-- error404.html -->
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>404 Not Found</title>
</head>
<body>
    404 Not Found
    <p>The requested page was not found.</p>
</body>
</html>

<!-- error500.html -->
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>500 Internal Server Error</title>
</head>
<body>
    500 Internal Server Error