百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

SpringBoot异常处理_springboot异常注解

liuian 2025-09-18 22:49 25 浏览

在 Spring Boot 中,异常处理是构建健壮、可维护 Web 应用的关键部分。良好的异常处理机制可以统一返回格式、提升用户体验、便于调试和监控。

以下是 Spring Boot 中处理异常的完整指南和最佳实践:

一、核心注解

1. @ControllerAdvice

  • 全局控制器增强,用于定义全局异常处理器
  • 可以作用于所有 @Controller 或 @RestController。

2. @ExceptionHandler

  • 定义具体的异常处理方法。
  • 可以在控制器内部使用(局部),也可以配合 @ControllerAdvice 使用(全局)。

二、全局异常处理(推荐方式)

示例:创建全局异常处理器

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.NoHandlerFoundException;

@ControllerAdvice
public class GlobalExceptionHandler {

    // 处理自定义业务异常
    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException e) {
        ErrorResponse error = new ErrorResponse(
                "BUSINESS_ERROR",
                e.getMessage(),
                System.currentTimeMillis()
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(error);
    }

    // 处理参数校验异常(如 @Valid)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<ErrorResponse> handleValidationException(MethodArgumentNotValidException e) {
        String message = e.getBindingResult().getFieldError().getDefaultMessage();
        ErrorResponse error = new ErrorResponse(
                "VALIDATION_ERROR",
                message,
                System.currentTimeMillis()
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(error);
    }

    // 处理资源未找到(404)
    @ExceptionHandler(NoHandlerFoundException.class)
    public ResponseEntity<ErrorResponse> handleNotFoundException(NoHandlerFoundException e) {
        ErrorResponse error = new ErrorResponse(
                "NOT_FOUND",
                "The requested resource was not found: " + e.getRequestURL(),
                System.currentTimeMillis()
        );
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(error);
    }

    // 处理空指针等系统异常
    @ExceptionHandler(NullPointerException.class)
    public ResponseEntity<ErrorResponse> handleNullPointerException(NullPointerException e) {
        ErrorResponse error = new ErrorResponse(
                "SYSTEM_ERROR",
                "A system error occurred.",
                System.currentTimeMillis()
        );
        // 记录详细日志
        // log.error("NullPointerException", e);
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(error);
    }

    // 处理所有未被捕获的异常(兜底)
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGeneralException(Exception e) {
        ErrorResponse error = new ErrorResponse(
                "INTERNAL_ERROR",
                "An unexpected error occurred.",
                System.currentTimeMillis()
        );
        // 记录完整异常堆栈
        // log.error("Unhandled exception", e);
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(error);
    }
}


定义统一的错误响应体

public class ErrorResponse {
    private String code;
    private String message;
    private long timestamp;

    public ErrorResponse(String code, String message, long timestamp) {
        this.code = code;
        this.message = message;
        this.timestamp = timestamp;
    }

    // getter & setter
}

三、自定义业务异常

public class BusinessException extends RuntimeException {
    public BusinessException(String message) {
        super(message);
    }

    public BusinessException(String message, Throwable cause) {
        super(message, cause);
    }
}

在业务逻辑中抛出:

@Service
public class UserService {
    public User getUser(Long id) {
        if (id <= 0) {
            throw new BusinessException("Invalid user ID: " + id);
        }
        // ...
    }
}

四、处理参数校验异常

1. 添加依赖(已包含在 web starter 中)

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2. 在 DTO 上使用校验注解

public class CreateUserRequest {
    @NotBlank(message = "Name is required")
    private String name;

    @Email(message = "Invalid email format")
    private String email;

    // getter & setter
}

3. 在 Controller 中启用校验

@PostMapping("/users")
public ResponseEntity<User> createUser(@Valid @RequestBody CreateUserRequest request) {
// ...
}

4. 全局处理 MethodArgumentNotValidException

如上文所示,在 GlobalExceptionHandler 中处理。

五、配置文件设置(可选)

# application.yml
spring:
  # 启用精确的异常映射(可选)
  web:
    resources:
      add-mappings: true

# 开发环境可开启详细错误信息(生产环境务必关闭!)
server:
  error:
    include-message: always
    include-binding-errors: always
    include-stacktrace: on_param

生产环境警告:不要暴露堆栈信息给前端,防止信息泄露。

六、特殊异常处理

1. 处理 404(NoHandlerFound)

# application.yml
spring:
  mvc:
    throw-exception-if-no-handler-found: true  # 未找到处理器时抛出异常
  web:
    resources:
      add-mappings: false  # 禁用默认静态资源映射(可选)

然后在 @ControllerAdvice 中捕获 NoHandlerFoundException。

2. 处理 Spring Security 异常

@ExceptionHandler(AccessDeniedException.class)
public ResponseEntity<ErrorResponse> handleAccessDenied(AccessDeniedException e) {
    return ResponseEntity.status(HttpStatus.FORBIDDEN).body(...);
}

七、最佳实践

实践

说明

使用 @ControllerAdvice

实现全局异常处理,避免重复代码

定义统一错误格式

前后端约定一致的错误结构

区分异常类型

业务异常、系统异常、校验异常分别处理

记录日志

特别是系统异常,便于排查问题

生产环境隐藏细节

不暴露堆栈、数据库错误等敏感信息

使用自定义异常

提高代码可读性和可维护性

返回合适的 HTTP 状态码

如 400、401、403、404、500 等

八、测试异常处理

@Test
public void shouldReturn400WhenInvalidInput() throws Exception {
    mockMvc.perform(post("/api/users")
                    .contentType(MediaType.APPLICATION_JSON)
                    .content("{\"name\": \"\", \"email\": \"invalid\"}"))
            .andExpect(status().isBadRequest())
            .andExpect(jsonPath("$.code").value("VALIDATION_ERROR"));
}

九、高级:自定义 ErrorController(可选)

如果需要完全控制错误页面或响应,可以实现 ErrorController 接口(Spring Boot 2.3+ 推荐使用 implements ErrorAttributes 或 @ControllerAdvice)。

总结

Spring Boot 的异常处理流程:

请求 → Controller → Service → 抛出异常
                                               ↓
@ExceptionHandler (局部或全局)
↓
统一返回 JSON 错误响应

核心原则

  • 集中处理:使用 @ControllerAdvice 避免散落在各处的 try-catch。
  • 类型化处理:不同异常返回不同状态码和提示。
  • 用户友好:前端能根据 code 或 message 做相应处理。
  • 安全可靠:不暴露系统内部细节。

相关推荐

桌面上的文件删除了怎么恢复
  • 桌面上的文件删除了怎么恢复
  • 桌面上的文件删除了怎么恢复
  • 桌面上的文件删除了怎么恢复
  • 桌面上的文件删除了怎么恢复
麦克风没声音(win11麦克风没声音)

一.先确保你的麦克风能正常使用。请确保麦克风本身是好的,连接线没有问题,请确保你的测试软件已正确设置,如YY之类的软件。二.确认你的麦克风是否插入正确的插孔一般麦克风是插入红色插孔中。三.确认你...

vs2015官网下载(vs2015 下载)

VisualStudio2015下载完成之后,会有一个名为“vs2015.pro_chs.iso”的光盘镜像文件。光盘镜像文件将光盘镜像文件在虚拟光驱中加载之后,可以打开查看光盘内容。安装文件双...

u盘自我保护怎么解除(怎么样取消u盘的自我保护)

要解除U盘保护,首先插入U盘后打开“我的电脑”,右击选择U盘图标,点击“属性”。在弹出的对话框中,选择“安全”标签,然后点击“编辑”按钮,根据自己的需要选择或取消“对于系统用户完全控制”权限,点击“确...

如何设置自动关机win10(windows 10如何设置自动关机)

Win10设置自动关机,需要以下步骤:1.按“Win+R”组合键,呼出“运行”;2.将定时关机命令设置为“shutdown-s-t7200”;3.在“运行”内输入命令,点击“确定”即可;4.如果设置错...

公版驱动(公版驱动和专用驱动的区别)

公版这个名词特指显卡本身,与驱动无关。一般采用芯片制造商自己设计的显卡,称为公版。显卡驱动只有WHQL版本、Beta版本、兼容版、定制版之分。兼容版一般称为万能驱动,不会给显卡带来多少优化,只是让你能...

nod32是什么软件(nod32是哪个国家的)

起源于捷克斯洛伐克总部现在美国下面是nod32的由来:nod是根据一部电视剧(城市边缘的医院)起的,原意是“磁盘边的医院”32是源于当16-bitNOD-ICE很成熟的时候32位处理器出来了升级适应3...

欧拉linux系统官网(欧拉系统命令)

在华为欧拉服务器上配置Linux网络,首先需要编辑网络配置文件,位于/etc/sysconfig/network-scripts目录下,根据网络需求配置对应的网络接口,IP地址、子网掩码、网关等信息,...

笔记本摄像头无法打开(笔记本的摄像头打不开了)
  • 笔记本摄像头无法打开(笔记本的摄像头打不开了)
  • 笔记本摄像头无法打开(笔记本的摄像头打不开了)
  • 笔记本摄像头无法打开(笔记本的摄像头打不开了)
  • 笔记本摄像头无法打开(笔记本的摄像头打不开了)
deepin安装显卡驱动(deepin安装显卡驱动后无法进入图形界面)

1、首先必须使用rufus制作U盘启动,必须选择DD格式2、从其他linux镜像比如Ubantu或其他拷贝出EFI的引导文件,具体是镜像中的EFI—boot—grubx86.efi这个文件,把这个文件...

小米路由器管理员初始密码(miwifi小米路由器管理员初始密码)

小米路由器管理员密码初始是123456。1、小米路由器的管理员初始密码是admin。2、如果输入admin路由器没有反应,说明密码错误,可以查看路由器背面的管理员登录密码,登录后可以自行修改设置账户名...

路由器组网具体连接方法(路由器组网教程)

举例:你正在用一个TP-LINK的无线路由器上网,信号不是太好,你想在下边再连一个无线路由器的话,就得在第二个路由器上设置了,先不管第一个路由器,设置步骤:把第二个无线路由器连接到电脑上(只是路...

雨林木风win7纯净版gho(雨林木风win7官网)

雨林木风WIN7光盘重装系统的步骤是将光盘放入光驱内,设置光驱为第一启动盘,打开电脑后进入光盘引导,最后将系统文件镜像到系统盘上1.你下载的雨林木风GHOSTXPSP3纯净版Y8.0是一个克隆光...

电脑一直正在重新启动怎么解决

1、电脑误删除或者是破坏了系统文件。那么需要重新安装系统。2、可能是安装的软件或者是插件跟系统兼容性冲突导致的。可以强制关机3次,然后重新启动电脑会出现恢复界面——选择安全模式——然后电脑会重新启...

如何下载ps软件免费版(ps如何下载免费版本)
如何下载ps软件免费版(ps如何下载免费版本)

1.在搜索引擎中输入adobe并点击搜索。2.点击adobe官网。3.点击支持并点击下载与安装。4.点击开始免费试用并点击下载。5.打开文件夹并点击打开进行安装即可。6.根据以上步骤即可下载安装ps。AdobePhotoshopCS6号...

2026-01-14 05:37 liuian