SpringBoot——全局异常处理

目录

异常

项目总结

新建一个SpringBoot项目

pom.xml

Result（通用的响应结果类）

MyBusinessException自定义异常类

GlobalExceptionHandler全局异常处理类

ExceptionController控制器

SpringbootExceptionApplication启动类

---

参考文章：

• 1、http://t.csdnimg.cn/wzes2

异常

• SpringBoot项目采用了全局异常的概念——所有方法均将异常抛出，并且专门安排一个类统一拦截并处理这些异常。
• 对异常的处理：
  • 1、抛出异常
  • 2、使用 try...catch...finally 捕获处理异常
• SpringBoot提供了两个注解用于拦截异常
  • 1、@ControllerAdvice：标注该类为全局异常处理类，默认拦截所有被触发的异常
  • 2、@ExceptionHandler：标注方法，用于处理特定异常

---

项目总结

• 统一异常处理通过@ControllerAdvice注解向控制器发送通知，并接收所有Controller层的通知，再结合@ExceptionHandler注解对指定的异常进行捕获处理，最后将结果返回给用户

新建一个SpringBoot项目

项目结构：

pom.xml

"1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0modelVersion>
	<parent>
		<groupId>org.springframework.bootgroupId>
		<artifactId>spring-boot-starter-parentartifactId>
		<version>2.3.12.RELEASEversion>
		<relativePath/> 
	parent>
	<groupId>com.studygroupId>
	<artifactId>springboot_exceptionartifactId>
	<version>0.0.1-SNAPSHOTversion>
	<name>springboot_exceptionname>
	<description>Demo project for Spring Bootdescription>
	<properties>
		<java.version>8java.version>
	properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.bootgroupId>
			<artifactId>spring-boot-starter-webartifactId>
		dependency>
 
		<dependency>
			<groupId>org.springframework.bootgroupId>
			<artifactId>spring-boot-starter-testartifactId>
			<scope>testscope>
		dependency>
 
		<dependency>
			<groupId>org.projectlombokgroupId>
			<artifactId>lombokartifactId>
		dependency>
	dependencies>
 
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.bootgroupId>
				<artifactId>spring-boot-maven-pluginartifactId>
			plugin>
		plugins>
	build>
 
project>

Result（通用的响应结果类）

Result类的作用：

1. 统一的响应格式：提高接口的一致性和可维护性。
2. 封装错误信息：当发生异常或错误时，可以使用Result类来封装错误信息，包括错误消息和对应的状态码，便于客户端进行统一的处理和解析。
3. 携带业务数据：除了错误信息，Result类也可以携带业务数据，例如查询结果、对象详情等，从而完整地描述接口的执行结果。

package com.study.springboot_exception.event;
 
import lombok.Data;
 
@Data
public class Result {
    private String message;
    private int code;
    private T data;
}

MyBusinessException自定义异常类

package com.study.springboot_exception.exception;
 
import lombok.Data;
 
/**
 * 自定义异常类: 用于及时处理一些不符合业务逻辑的数据
 * 注意:
 * 1.必须继承RuntimeException运行时异常,并重写父类构造方法
 */
@Data
public class MyBusinessException extends RuntimeException{
 
    private static final long serialVersionUID=1L;
    private int code;
    private String message;
 
    public MyBusinessException(String message){
        super(message);
        this.message=message;
    }
    public MyBusinessException(int code,String message){
        super(message);
        this.code=code;
        this.message=message;
    }
 
}

GlobalExceptionHandler全局异常处理类

• 比较常见的错误状态：
  • 200：正常响应
  • 400：错误的请求
  • 404：资源不存在
  • 500：代码无法继续执行
• 
• SpringBoot项目是Restful风格，大多使用@RestControllerAdvice注解

package com.study.springboot_exception.exception;
 
import com.study.springboot_exception.event.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
 
import java.util.StringJoiner;
 
/**
 * 全局异常处理类
 */
@Slf4j
@RestControllerAdvice//标记该类为全局异常处理类
public class GlobalExceptionHandler {
 
    /**
     * 处理自定义异常
     */
    @ExceptionHandler(MyBusinessException.class)//处理特定异常
    public Result handleBizException(MyBusinessException ex){
        Result