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

SpringBoot异常处理_springboot异常注解

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

在 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 做相应处理。
  • 安全可靠:不暴露系统内部细节。

相关推荐

eino v0.4.5版本深度解析:接口类型处理优化与错误机制全面升级

近日,eino框架发布了v0.4.5版本,该版本在错误处理、类型安全、流处理机制以及代理配置注释等方面进行了多项优化与修复。本次更新共包含6个提交,涉及10个文件的修改,由2位贡献者共同完成。本文将详...

SpringBoot异常处理_springboot异常注解

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

Jenkins运维之路(Jenkins流水线改造Day02-1-容器项目)

这回对线上容器服务器的流水线进行了一定的改造来满足目前线上的需求,还是会将所有的自动化脚本都放置到代码库中统一管理,我感觉一章不一定写的完,所以先给标题加了个-1,话不多说开干1.本次流水线的流程设计...

告别宕机!零基础搭建服务器监控告警系统!小白也能学会!

前言本文将带你从零开始,一步步搭建一个完整的服务器指标监控与邮件告警系统,使用的技术栈均为业界主流、稳定可靠的开源工具:Prometheus:云原生时代的监控王者,擅长指标采集与告警规则定义Node_...

httprunner实战接口测试笔记,拿走不谢

每天进步一点点,关注我们哦,每天分享测试技术文章本文章出自【码同学软件测试】码同学公众号:自动化软件测试码同学抖音号:小码哥聊软件测试01开始安装跟创建项目pipinstallhttprunne...

基于JMeter的性能压测平台实现_jmeter压测方案

这篇文章已经是两年前写的,短短两年时间,JMeter开源应用技术的发展已经是翻天覆地,最初由github开源项目zyanycall/stressTestPlatform形成的这款测试工具也开始慢...

12K+ Star!新一代的开源持续测试工具!

大家好,我是Java陈序员。在企业软件研发的持续交付流程中,测试环节往往是影响效率的关键瓶颈,用例管理混乱、接口调试复杂、团队协作不畅、与DevOps流程脱节等问题都能影响软件交付。今天,给大家...

Spring Boot3 中分库分表之后如何合并查询

在当今互联网应用飞速发展的时代,数据量呈爆发式增长。对于互联网软件开发人员而言,如何高效管理和查询海量数据成为了一项关键挑战。分库分表技术应运而生,它能有效缓解单库单表数据量过大带来的性能瓶颈。而在...

离线在docker镜像方式部署ragflow0.17.2

经常项目上会出现不能连外网的情况,要怎么使用ragflow镜像部署呢,这里提供详细的步骤。1、下载基础镜像根据docker-compose-base.yml及docker-compose.yml中的i...

看,教你手写一个最简单的SpringBoot Starter

何为Starter?想必大家都使用过SpringBoot,在SpringBoot项目中,使用最多的无非就是各种各样的Starter了。那何为Starter呢?你可以理解为一个可拔插式...

《群星stellaris》军事基地跳出怎么办?解决方法一览

《群星stellaris》军事基地跳出情况有些小伙伴出现过这种情况,究竟该怎么解决呢?玩家“gmjdadk”分享的自己的解决方法,看看能不能解决。我用英文原版、德语、法语和俄语四个版本对比了一下,结果...

数据开发工具dbt手拉手教程-03.定义数据源模型

本章节介绍在dbt项目中,如何定义数据源模型。定义并引入数据源通过Extract和Load方式加载到仓库中的数据,可以使用dbt中的sources组件进行定义和描述。通过在dbt中将这些数据集(表)声...

docker compose 常用命令手册_docker-compose init

以下是DockerCompose常用命令手册,按生命周期管理、服务运维、构建配置、扩缩容、调试工具分类,附带参数解析、示例和关键说明,覆盖多容器编排核心场景:一、生命周期管理(核心命令...

RagFlow与DeepSeek R1本地知识库搭建详细步骤及代码实现

一、环境准备硬件要求独立显卡(建议NVIDIAGPU,8GB显存以上)内存16GB以上,推荐32GB(处理大规模文档时更高效)SSD硬盘(加速文档解析与检索)软件安装bash#必装组件Docker...

Docker Compose 配置更新指南_docker-compose配置

高效管理容器配置变更的最佳实践方法重启范围保留数据卷适用场景docker-composeup-d变更的服务常规配置更新--force-recreate指定/所有服务强制重建down→up流程...