Spring Boot 统一异常处理与全局响应增强

简介: 本文介绍如何在Spring Boot中实现全局异常处理,通过`@RestControllerAdvice`和自定义`BusinessException`统一拦截异常,结合`JsonResult`标准化响应格式,避免信息泄露,提升前后端协作效率与系统健壮性。

1. 为什么需要全局异常处理?

在没有统一异常处理的情况下,常见问题包括:

  • 用户传入非法参数,后端直接抛出 NullPointerException,前端收到 500;
  • 数据库主键冲突,返回一大段 Java 堆栈,暴露系统内部结构;
  • 不同 Controller 对相同异常(如“用户不存在”)返回不同格式,前端难以统一处理。

✅ 解决方案:使用 Spring 的 @ControllerAdvice + @ExceptionHandler 实现 全局异常拦截与标准化响应。


2. 结合 JsonResult,设计异常响应结构

我们复用上一课定义的 JsonResult<T>,并约定:

  • 成功:code = "0"
  • 失败:code ≠ "0",msg 描述原因,data = null

✅ 示例:用户未找到异常

{
  "code": "1002",
  "msg": "用户不存在",
  "data": null
}

3. 自定义业务异常类(可选但推荐)

为区分系统异常和业务异常,建议定义自己的异常:

public class BusinessException extends RuntimeException {
    private String code;
    public BusinessException(String code, String message) {
        super(message);
        this.code = code;
    }
    // getter
    public String getCode() { return code; }
}

常见业务异常码示例:

  • "1001":参数校验失败
  • "1002":资源不存在
  • "1003":权限不足

4. 全局异常处理器:GlobalExceptionHandler

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice // = @ControllerAdvice + @ResponseBody
public class GlobalExceptionHandler {
    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    /**
     * 捕获自定义业务异常
     */
    @ExceptionHandler(BusinessException.class)
    public JsonResult<?> handleBusinessException(BusinessException e) {
        logger.warn("业务异常:code={}, msg={}", e.getCode(), e.getMessage());
        return new JsonResult<>(e.getCode(), e.getMessage());
    }
    /**
     * 捕获参数校验异常(如 @Valid 失败)
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public JsonResult<?> handleValidationException(MethodArgumentNotValidException e) {
        String msg = e.getBindingResult().getFieldError().getDefaultMessage();
        logger.warn("参数校验失败:{}", msg);
        return new JsonResult<>("1001", msg != null ? msg : "请求参数错误");
    }
    /**
     * 捕获空指针等运行时异常(兜底)
     */
    @ExceptionHandler(Exception.class)
    public JsonResult<?> handleGenericException(Exception e) {
        logger.error("系统异常:", e); // 记录完整堆栈
        return new JsonResult<>("500", "系统繁忙,请稍后再试");
    }
}

🔑 关键点:

  • @RestControllerAdvice:对所有 @RestController 生效;
  • 优先匹配具体异常(如 BusinessException),最后用 Exception 兜底;
  • 务必记录日志,便于排查问题。

5. 在业务代码中主动抛出异常

@Service
public class UserService {
    public User getUserById(Long id) {
        if (id == null || id <= 0) {
            throw new BusinessException("1001", "用户ID不能为空且必须大于0");
        }
        User user = userMapper.selectById(id);
        if (user == null) {
            throw new BusinessException("1002", "用户不存在");
        }
        return user;
    }
}

Controller 层无需 try-catch:

@GetMapping("/user/{id}")
public JsonResult<User> getUser(@PathVariable Long id) {
    User user = userService.getUserById(id);
    return new JsonResult<>(user);
}

6. 测试效果

请求:GET /user/999(用户不存在)

{
  "code": "1002",
  "msg": "用户不存在",
  "data": null
}

请求:GET /user/0(参数非法)

{
  "code": "1001",
  "msg": "用户ID不能为空且必须大于0",
  "data": null
}

发生未知异常(如数据库宕机)

{
  "code": "500",
  "msg": "系统繁忙,请稍后再试",
  "data": null
}

✅ 所有响应格式统一,前端只需判断 code 即可处理!


7. 进阶建议

场景 方案
国际化错误消息 将 msg 替换为 message key,前端根据语言包显示
记录异常到监控系统 在 handleGenericException 中集成 Sentry、SkyWalking 等
区分开发/生产环境 开发环境可返回 e.getMessage(),生产环境固定提示
配合 Validator 使用 @Valid + BindingResult 或全局捕获 MethodArgumentNotValidException

8. 总结

通过本篇学习,你已掌握:

  • ✅ 为什么需要全局异常处理;
  • ✅ 如何定义 BusinessException 和 JsonResult 配合使用;
  • ✅ 使用 @RestControllerAdvice 统一拦截异常;
  • ✅ 在业务层主动抛出语义化异常;
  • ✅ 保证所有 API 响应格式一致、安全、友好。


相关文章
|
Java 开发者 UED
Spring Boot的全局异常处理机制
【2月更文挑战第13天】
1409 0
|
11月前
|
JSON Java 数据格式
Spring Boot中的全局异常处理
本文介绍了Spring Boot项目中如何实现全局异常处理。通过@ControllerAdvice和@ExceptionHandler统一捕获系统异常与自定义业务异常,结合统一JSON返回结构,避免代码耦合,提升可维护性。同时利用枚举管理异常码,实现异常信息的集中管理和友好提示,适用于前后端分离及微服务架构,保障接口返回一致性,降低维护成本。
|
11月前
|
JSON 前端开发 Java
Spring Boot 封装统一返回的数据结构
本课讲解如何设计统一的JSON响应结构,通过泛型类`JsonResult&lt;T&gt;`封装返回数据,规范包含code、msg、data的标准格式,提升前后端协作效率与API可维护性。
|
11月前
|
SQL Java 数据库连接
Spring Boot 使用 SLF4J 进行日志记录
本课讲解Java开发中日志的最佳实践,摒弃System.out.println(),采用SLF4J+Logback方案。涵盖日志级别、配置文件编写、格式化输出与滚动策略,提升系统可观测性与维护效率。
|
11月前
|
JSON 前端开发 Java
Spring Boot 中的 @RequestMapping 与快捷映射注解
`@RequestMapping` 是 Spring MVC 中用于映射 HTTP 请求路径与处理方法的核心注解,可标注在类或方法上。类上使用定义公共前缀,方法上指定具体路径和请求方式。常用属性包括 `value`(路径)、`method`(请求类型)、`produces`(响应类型)。Spring 还提供了 `@GetMapping`、`@PostMapping` 等快捷注解,语义更清晰,推荐优先使用。
|
11月前
|
安全 Java jenkins
Spring Boot 多环境配置与 Profile 实战
Spring Boot通过Profile实现多环境配置,支持dev、test、prod等环境的独立配置。通过application-{profile}.yml分离配置,结合spring.profiles.active动态激活,实现一套代码适配多套环境,提升部署效率与安全性。
|
11月前
|
Java Spring
Spring Boot 中的 @RequestParam:获取查询参数与表单数据
`@RequestParam` 用于提取 HTTP 请求中的查询参数或表单数据,支持设置参数名、是否必填及默认值。适用于 `?key=value` 形式或 POST 表单,字段多时推荐封装为实体类自动绑定,与 `@PathVariable` 按路径取值不同,用途明确,是处理 Web 请求的常用方式。
|
11月前
|
XML Java 数据库连接
Spring Boot集成MyBatis
MyBatis 是一款优秀的持久层框架,支持SQL映射与注解两种方式,简化数据库操作。本文详解Spring Boot集成MyBatis的配置方法,涵盖依赖引入、YAML配置、XML与注解模式整合,并重点讲解@MapperScan、@Param、@Results等注解使用技巧,助力开发者高效实现数据访问。
|
11月前
|
JSON 前端开发 Java
Spring Boot 返回 JSON 数据及数据封装
本课讲解Spring Boot中JSON处理:通过@RestController返回JSON,利用内置Jackson实现对象、List、Map自动序列化,并自定义配置优雅处理null值,提升前后端交互体验。
|
Java 测试技术 数据安全/隐私保护
Spring Boot | 一种优雅的参数校验方案(个人总结)
一种优雅的参数校验方案(个人总结)
2473 1
Spring Boot | 一种优雅的参数校验方案(个人总结)

热门文章

最新文章