通过@ControllerAdvice和@ExceptionHandler实现全局异常处理,定义统一响应格式与自定义异常类,结合日志记录和JSON返回,提升Spring Boot应用的健壮性与接口一致性。

在Java开发中,特别是使用Spring Boot框架时,全局异常处理是提升系统健壮性和接口一致性的关键环节。通过全局异常处理器,可以统一捕获未处理的异常,并返回格式化的错误响应,避免将原始错误暴露给前端。
Spring提供了一个注解 @ControllerAdvice,它可以配合 @ExceptionHandler 来定义一个全局的异常处理器。这个类会拦截所有控制器中抛出的异常。
示例:定义全局异常处理类
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org新春.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice
public class GlobalExceptionHandler {
// 处理空指针异常
@ExceptionHandler(NullPointerException.class)
public ResponseEntity<ErrorResponse> handleNullPointerException(NullPointerException e) {
ErrorResponse error = new ErrorResponse("空值异常", e.getMessage());
return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
}
// 处理数组越界
@ExceptionHandler(IndexOutOfBoundsException.class)
public ResponseEntity<ErrorResponse> handleIndexOutOfBoundsException(IndexOutOfBoundsException e) {
ErrorResponse error = new ErrorResponse("索引越界", e.getMessage());
return new ResponseEntity<>(error, HttpStatus.BAD_REQUEST);
}
// 处理自定义业务异常
@ExceptionHandler(BusinessException.class)
public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException e) {
ErrorResponse error = new ErrorResponse("业务异常", e.getMessage());
return new ResponseEntity<>(error, HttpStatus.BAD_REQUEST);
}
// 捕获其他未预期的异常
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGeneralException(Exception e) {
ErrorResponse error = new ErrorResponse("系统错误", "服务器内部错误,请稍后重试");
return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
}
}定义统一的错误响应结构
立即学习“Java免费学习笔记(深入)”;
public class ErrorResponse {
private String error;
private String message;
public ErrorResponse(String error, String message) {
this.error = error;
this.message = message;
}
// getter 和 setter 省略,实际项目中需要加上
}为了更清晰地区分不同类型的错误,建议定义自己的业务异常类,比如 BusinessException,这样可以在代码中主动抛出并被全局处理器捕获。
public class BusinessException extends RuntimeException {
public BusinessException(String message) {
super(message);
}
}在服务中使用:
```java if (user == null) { throw new BusinessException("用户不存在"); } ```全局异常处理不仅要返回友好提示,还应记录详细日志,方便后续排查。可在每个处理方法中加入日志输出。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@ControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGeneralException(Exception e) {
logger.error("未捕获异常:", e); // 记录堆栈信息
ErrorResponse error = new ErrorResponse("系统错误", "服务器内部错误,请联系管理员");
return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
}
}现代Web应用通常要求返回JSON格式的错误信息。@ControllerAdvice 默认支持返回对象,Spring会自动将其序列化为JSON(前提是引入了Jackson等依赖)。
确保 pom.xml 中有:
```xml该依赖已包含Jackson,因此返回的 ErrorResponse 会自动转为JSON。
基本上就这些。合理使用全局异常处理器能让系统更稳定、接口更规范。
java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号