SpringBoot定制三种错误页面及错误数据方法示例

下面是对SpringBoot定制三种错误页面及错误数据方法的详细讲解和示例说明：

1. SpringBoot错误处理

在SpringBoot应用中，我们可以自定义错误页面，以显示更友好的错误提示信息，同时也可以记录异常日志。

SpringBoot提供了一组异常处理相关的注解，包括 @ControllerAdvice 和 @ExceptionHandler 等，用于定制全局异常处理、定制特定异常处理等。

2. SpringBoot三种错误处理方式

SpringBoot提供了3种错误处理的方式：

重定向到错误页面
转发到错误页面
返回错误数据

下面我们依次介绍这三种方式的实现方法。

2.1 重定向到错误页面

在SpringBoot中，重定向到错误页面通常是通过配置一个ErrorController来实现的。

在启动类中添加如下代码：

@Controller
public class MyErrorController implements ErrorController {

    private final static String ERROR_PATH = "/error";

    @RequestMapping(ERROR_PATH)
    public String handleError() {
        return "error";
    }

    @Override
    public String getErrorPath() {
        return ERROR_PATH;
    }
}

其中，我们自定义了一个MyErrorController，实现了ErrorController接口，并重写了其中的 handleError() 方法，返回一个指向error.html的视图。同时，我们还重写了getErrorPath()方法，返回错误路径。

2.2 转发到错误页面

转发到错误页面通常是在控制器中实现的。

@ControllerAdvice
public class MyExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    public ModelAndView errorHandler(HttpServletRequest req, Exception e) {
        ModelAndView mav = new ModelAndView();
        mav.addObject("exception", e);
        mav.addObject("url", req.getRequestURL());
        mav.setViewName("error");
        return mav;
    }
}

在控制器中，我们使用 @ControllerAdvice 和 @ExceptionHandler 注解来指定需要处理的异常，并在异常处理方法中返回一个ModelAndView对象，包含需要显示的错误信息和视图名称。

2.3 返回错误数据

前两种方式都是返回HTML页面，如果需要返回具体的错误数据，可以使用@RestControllerAdvice注解来设置全局异常处理。返回一个JSON格式的错误信息。

@RestControllerAdvice
public class MyExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    public Map<String, Object> errorHandler(HttpServletRequest req, Exception e) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 100);
        map.put("message", e.getMessage());
        map.put("url", req.getRequestURL());
        return map;
    }
}

在异常处理方法中，我们返回一个Map，包含需要显示的错误信息、状态码和请求URL等信息。

3. SpringBoot错误页面模板

在SpringBoot中，我们可以使用thymeleaf模板引擎来定制错误页面。请参考示例代码：

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
    <title>Error</title>
</head>
<body>
<div>
    <h2>错误信息</h2>
    <div th:text="${exception.message}"></div>
</div>
<div>
    <h2>请求URL</h2>
    <div th:text="${url}"></div>
</div>
</body>
</html>

在模板中使用thymeleaf语法，可以方便地获取异常信息、请求URL等数据，同时也可以自定义html模板的样式。

4. 示例说明

下面我们通过两个示例，演示如何使用SpringBoot实现错误处理：

4.1 示例1：重定向到错误页面

我们以简单的web应用为例，演示如何实现通过重定向到错误页面来实现错误处理。

@SpringBootApplication
public class ExampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }

    @Controller
    public class IndexController {

        @RequestMapping("/")
        public String index() {
            return "index";
        }

        @RequestMapping("/error")
        public String error() {
            throw new RuntimeException("发生错误！！");
        }
    }
}

在应用启动类中，我们添加了一个IndexController，并在其中定义了一个访问根路径"/"的方法和一个访问“/error”的方法，用于模拟发生异常。

在“/error”请求时，抛出一个RuntimeException异常，然后通过设置视图返回值为"error"来重定向到错误页面。此时，我们需要在resources/templates/目录下创建一个error.html的模板文件，用于显示错误页面。

4.2 示例2：转发到错误页面

我们还以web应用为例，演示如何实现通过转发到错误页面来实现错误处理。

@SpringBootApplication
public class ExampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }

    @RestController
    public class IndexController {

        @RequestMapping("/test")
        public String test() {
            System.out.println("start");
            int i = 1 / 0;
            System.out.println("end");
            return "test";
        }
    }

    @ControllerAdvice
    public class MyExceptionHandler {

        @ExceptionHandler(value = Exception.class)
        public ModelAndView errorHandler(HttpServletRequest req, Exception e) {
            ModelAndView mav = new ModelAndView();
            mav.addObject("exception", e);
            mav.addObject("url", req.getRequestURL());
            mav.setViewName("error");
            return mav;
        }
    }
}

在应用启动类中，我们添加了一个IndexController，并在其中定义了一个访问“/test”的方法。在方法中，我们故意抛出一个异常，用于模拟异常情况。

在MyExceptionHandler中，我们使用@ControllerAdvice和@ExceptionHandler注解来指定需要处理的异常，并在异常处理方法中返回一个ModelAndView对象，包含需要显示的错误信息和视图名称。此时，我们需要在resources/templates/目录下创建一个error.html的模板文件，用于显示错误页面。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：SpringBoot定制三种错误页面及错误数据方法示例 - Python技术站