Spring Boot：异常处理

Spring Boot

前言
使用自定义错误页面处理异常
使用 @ExceptionHandler 注解处理异常
使用 @ControllerAdvice 注解处理异常
使用配置类处理异常
使用自定义类处理异常

在这里插入图片描述

前言

在 Spring Boot 中，异常处理是一个重要的部分，可以允许开发者优雅地处理应用程序中可能发生的错误和异常。Spring Boot 提供了一套完整的机制来处理异常，包括全局异常处理、特定异常处理以及自定义错误页面等。而当 Spring Boot 应用程序中发生异常时，Spring Boot 默认会提供一个错误页面来显示错误信息。这个默认的错误页面通常包括一个错误状态码（如 404 或 500 ），一个简短的错误描述，以及一个可选的堆栈跟踪（这取决于应用程序的配置）。通常情况下，开发者往往倾向于自定义错误页面。下面简单介绍 Spring Boot 异常处理的方式。
在这里插入图片描述

使用自定义错误页面处理异常

在 Spring Boot 中，自定义错误页面是一种常用来处理异常的方式，并提供用户友好的反馈。开发者可以为特定的 HTTP 状态码（如404、 500等）创建自定义的错误页面，也可以创建一个通用的错误页面来处理所有未捕获的异常。

简单示例：
首先，在 src/main/resources/templates 目录下创建一个错误页面，名为 Error.html 的 Thymeleaf 视图模板

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>ErrorDemo</title>
</head>
    <body>
        <h1 th:text="${status}">异常状态码</h1>
        <p th:text="${error}">错误提示信息</p>
        <p th:if="${message}">异常消息<span th:text="${message}"></span></p>
        <p th:text="exception">错误对象</p>
        <p th:text="errors">JSR303数据校验的异常信息</p>
        <p>Return to <a th:href="@{/}">Home</a>.</p>
    </body>
</html>

然后，创建 Controller 包再创建一个 TestController 类，并创建一个 Test.html

package cn.edu.SpringBootExceptionHandlingDemo.Controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class TestController {
    @GetMapping("/Test.html")
    public String index(){
        return "Test";
    }
}

最后，启动 Spring Boot ，故意触发异常（如访问一个不存在的 URL ），以查看自定义错误页面
结果如图：
在这里插入图片描述

使用 @ExceptionHandler 注解处理异常

在 Spring 中，@ExceptionHandler 注解允许指定一个方法来处理特定类型的异常。当你在控制器（ Controller ）或全局异常处理类（使用@ControllerAdvice 注解）中使用 @ExceptionHandler 注解时，Spring 会自动将匹配的异常传递给相应的方法进行处理。

简单示例：
首先，在 TestController 类上添加一个数学运算的实现，再使用 @ExceptionHandler 注解指定数字运算类型的异常使用 testError() 方法进行异常处理

package cn.edu.SpringBootExceptionHandlingDemo.Controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class TestController {
    @GetMapping("/Test.html")
    public String index(){
        double math = 20240329/0;
        return "Test";
    }

    // 指定数字运算异常后，使用该方法进行异常处理
    @ExceptionHandler(value = {java.lang.ArithmeticException.class})
    public ModelAndView testError(Exception exception){
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("err",exception);
        // 指定错误视图模板
        modelAndView.setViewName("ErrorExceptionHandler");
        return modelAndView;
    }
}

然后，在 Test.html 上添加运算结果，并创建错误视图模板 ErrorExceptionHandler.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Test</title>
</head>
<body>
    运算结果为：<p th:text="${math}" />
    Hello World!!!
</body>
</html>

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>ErrorExceptionHandlerDemo</title>
</head>
<body>
    异常信息：[[${err}]]
</body>
</html>

最后，启动 Spring Boot ，打开浏览器输入 http://localhost:8080/Test.html 并按下回车键
结果如图：
在这里插入图片描述

使用 @ControllerAdvice 注解处理异常

使用 @ExceptionHandler 注解虽然比自定义错误页面更加灵活处理异常，但是只局限于使用该注解的 Controller 类内部上。而使用@ControllerAdvice 注解可以定义一个类来包含多个 @ExceptionHandler 方法，每个方法处理特定类型的异常。这样，便不需要在每个控制器中重复编写异常处理逻辑了。

简单示例：
在 Contoller 包内创建一个 AdviceController 类，将上述 @ExceptionHandler 方法剪切到该位置

package cn.edu.SpringBootExceptionHandlingDemo.Controller;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

@ControllerAdvice
public class AdviceController {
    // 指定数字运算异常后，使用该方法进行异常处理
    @ExceptionHandler(value = {java.lang.ArithmeticException.class})
    public ModelAndView testError(Exception exception){
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("err",exception);
        // 指定错误视图模板
        modelAndView.setViewName("ErrorExceptionHandler");
        return modelAndView;
    }
}

最后，启动 Spring Boot ，打开浏览器输入 http://localhost:8080/Test.html 并按下回车键
结果一样，但使用 @ControllerAdvice 注解无需重复编写异常处理逻辑：
在这里插入图片描述

使用配置类处理异常

在 Spring 中，SimpleMappingExceptionResolver 是一个方便的异常解析器，可以将特定类型的异常映射到特定的视图名称，使得异常处理更加简单和统一；也可以通过配置类来配置 SimpleMappingExceptionResolver ，以便在应用程序中全局处理异常。

简单示例：
创建 Configuration 包并在包内创建一个 ErrorConfiguration 配置类，将 AdviceController 类移除或注释以免影响测试结果

package cn.edu.SpringBootExceptionHandlingDemo.Configuration;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;

import java.util.Properties;

@Configuration
public class ErrorConfiguration {
    @Bean
    public SimpleMappingExceptionResolver simpleMappingExceptionResolver(){
        SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();
        Properties properties = new Properties();
        // 异常处理类型、显示错误视图名称
        properties.put("java.lang.ArithmeticException","ErrorExceptionHandler.html");
        simpleMappingExceptionResolver.setExceptionMappings(properties);
        // 指定异常信息变量名称为 err ，默认为 exception
        simpleMappingExceptionResolver.setExceptionAttribute("err");
        return simpleMappingExceptionResolver;
    }
}

最后，启动 Spring Boot ，打开浏览器输入 http://localhost:8080/Test.html 并按下回车键
结果一样：
在这里插入图片描述

使用自定义类处理异常

在 Spring Boot 中，也可以创建一个自定义的异常处理器，通常通过实现 HandlerExceptionResolver 接口或继承 SimpleMappingExceptionResolver 类，并在其中添加自定义逻辑，便可以处理异常。

简单示例：
接着，在 Configuration 内创建一个 CustomErrorConfiguration 自定义类并实现 HandlerExceptionResolver 接口，将 ErrorConfiguration 配置类和 AdviceController 类移除或注释以免影响测试结果

package cn.edu.SpringBootExceptionHandlingDemo.Configuration;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

@Configuration
public class CustomErrorConfiguration implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView modelAndView = new ModelAndView();
        // 数字运算类型异常
        if(ex instanceof ArithmeticException){
            modelAndView.setViewName("ErrorExceptionHandler");
        }
        // 异常信息对象
        modelAndView.addObject("err",ex);
        return modelAndView;
    }
}