在spring boot与前端分离的架构中，高效的异常处理至关重要。本文探讨了不进行服务器端页面重定向，而是通过统一的`@controlleradvice`机制，返回结构化的`apierror` json响应的策略。这种方法使前端应用能灵活地解析错误信息并进行相应的用户界面处理，从而提升系统的健壮性和用户体验。
引言：前后端分离下的异常处理挑战
在传统的服务器端渲染（SSR）应用中，当后端发生异常时，通常会通过重定向到预定义的错误页面（如error.html）来向用户展示错误信息。然而，在现代前后端分离的架构中，例如使用Spring Boot作为后端API服务，配合Angular、React或Vue等前端框架时，这种处理方式不再适用。
RESTful API的核心原则是无状态和资源导向。当API调用失败时，后端应该返回一个清晰、结构化的错误响应，而不是执行页面重定向。前端应用会消费这些API响应，并根据响应内容（包括错误信息）来决定如何在用户界面上展示错误、执行导航或采取其他用户体验优化措施。因此，后端API的异常处理策略需要适应这种分离式架构的特点，即提供可被前端程序化解析的错误信息。
统一的API错误响应格式
为了确保前端能够一致且有效地处理后端异常，定义一个统一的错误响应格式至关重要。一个良好的错误响应通常包含错误消息和可选的错误码，以便前端进行更细粒度的判断和展示。
我们可以定义一个简单的Java类 ApiError 来封装这些信息：
public class ApiError {
private String message; // 错误消息，供用户或开发者阅读
private String code; // 错误码，供前端程序化判断
public ApiError() {
}
public ApiError(String message, String code) {
this.message = message;
this.code = code;
}
// Getters and Setters
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
}
当后端发生异常时，我们将不再返回简单的字符串消息，而是返回一个ApiError对象的JSON表示。
使用 @ControllerAdvice 实现全局异常处理
Spring Boot提供了强大的@ControllerAdvice注解，允许我们定义一个全局的异常处理器。通过在一个类上添加@ControllerAdvice注解，并结合@ExceptionHandler，我们可以集中管理所有控制器（或特定控制器）抛出的异常，从而避免在每个控制器方法中重复编写异常处理逻辑。
以下是一个实现全局异常处理器的示例：
审查 React Router 代码，确保数据加载、变更、错误处理和导航模式符合规范，适用于 React Router v6.4+ 代码、加载器及其他特性。
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice
public class GlobalExceptionHandler {
// 假设这是您的自定义业务异常
public static class CursaNotFoundException extends RuntimeException {
private String errorCode;
public CursaNotFoundException(String message) {
super(message);
this.errorCode = "CURSA_NOT_FOUND"; // 默认错误码
}
public CursaNotFoundException(String message, String errorCode) {
super(message);
this.errorCode = errorCode;
}
public String getErrorCode() {
return errorCode;
}
}
/**
* 处理 CursaNotFoundException 异常
* 当课程未找到时，返回 404 NOT_FOUND 状态码和结构化错误信息
*/
@ExceptionHandler(value = CursaNotFoundException.class)
public ResponseEntity<apierror> handleCursaNotFoundException(CursaNotFoundException ex) {
ApiError error = new ApiError();
error.setMessage(ex.getMessage());
error.setCode(ex.getErrorCode()); // 使用自定义异常中的错误码
return new ResponseEntity(error, HttpStatus.NOT_FOUND);
}
/**
* 处理所有未被特定 @ExceptionHandler 捕获的通用 Exception
* 作为回退机制，返回 500 INTERNAL_SERVER_ERROR 状态码和通用错误信息
*/
@ExceptionHandler(value = Exception.class)
public ResponseEntity<apierror> handleGenericException(Exception ex) {
ApiError error = new ApiError();
error.setMessage("服务器内部错误，请稍后重试。"); // 避免泄露敏感信息
error.setCode("GENERIC_ERROR");
// 生产环境中，此处应记录详细日志
System.err.println("发生未知异常: " + ex.getMessage());
ex.printStackTrace();
return new ResponseEntity(error, HttpStatus.INTERNAL_SERVER_ERROR);
}
}</apierror></apierror>
在上述示例中：
- @ControllerAdvice 确保这个类能够“监听”所有控制器抛出的异常。
- handleCursaNotFoundException 方法专门处理 CursaNotFoundException。它构建一个ApiError对象，并以HttpStatus.NOT_FOUND（HTTP 404）返回。
- handleGenericException 方法作为捕获所有其他未明确处理的Exception的通用处理器。它返回一个通用的错误消息和HttpStatus.INTERNAL_SERVER_ERROR（HTTP 500），以防止敏感的后端信息泄露给前端。
现在，您的控制器方法可以更专注于业务逻辑，而无需担心异常处理：
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class CurseController {
private final CurseService curseService; // 假设有一个CurseService
public CurseController(CurseService curseService) {
this.curseService = curseService;
}
@GetMapping("/curses/{id}")
public ResponseEntity<curse> getCursaById(@PathVariable("id") Long id) {
// findCurseById() 方法可能会抛出 CursaNotFoundException
Curse c = curseService.findCurseById(id);
return new ResponseEntity(c, HttpStatus.OK);
}
}
// 假设 CurseService 及其方法
interface CurseService {
Curse findCurseById(Long id);
}
// 假设 Curse 类
class Curse {
private Long id;
private String name;
// ... getters and setters
}</curse>
前端应用如何消费错误响应
当前端（如Angular）发起API请求并收到错误响应时，它将接收到一个HTTP状态码非2xx的响应，并且响应体中包含我们定义的ApiError JSON对象。
例如，一个Angular应用可以通过HTTP客户端拦截器或在每个请求的回调中捕获错误：
// Angular service example
import { HttpClient, HttpErrorResponse } from '@angular/common/http';
import { Observable, throwError } from 'rxjs';
import { catchError } from 'rxjs/operators';
interface ApiError {
message: string;
code: string;
}
interface Curse {
id: number;
name: string;
}
// ...
export class CurseService {
constructor(private http: HttpClient) {}
getCurseById(id: number): Observable<curse> {
return this.http.get<curse>(`/api/curses/${id}`).pipe(
catchError(this.handleError)
);
}
private handleError(error: HttpErrorResponse) {
let errorMessage = '未知错误！';
if (error.error instanceof ErrorEvent) {
// 客户端或网络错误
errorMessage = `客户端错误: ${error.error.message}`;
} else {
// 后端返回的错误响应
const apiError: ApiError = error.error;
if (apiError && apiError.message) {
errorMessage = `后端错误: ${apiError.message} (Code: ${apiError.code || 'N/A'})`;
} else {
errorMessage = `后端返回错误状态码: ${error.status}, 错误信息: ${error.message}`;
}
}
console.error(errorMessage);
// 可以在这里根据错误码进行路由跳转，例如：
// if (error.status === 404 && error.error.code === 'CURSA_NOT_FOUND') {
// this.router.navigate(['/not-found']);
// }
return throwError(() => new Error(errorMessage));
}
}</curse></curse>
前端可以根据error.status（HTTP状态码）和error.error.code（后端定义的错误码）来：
- 在UI上显示友好的错误消息。
- 根据错误类型重定向到特定的错误页面（例如，404页面）。
- 执行其他业务逻辑，如重新加载数据、显示提示等。
最佳实践与注意事项
- 错误码的规范化： 建议在项目中定义一套统一的错误码体系，清晰地表示不同类型的业务错误和系统错误。这有助于前端和后端更好地协同，并简化错误处理逻辑。
- 日志记录： 在@ControllerAdvice中处理异常时，务必详细记录异常信息（包括堆栈跟踪）。这对于问题排查和系统监控至关重要。生产环境中，可以使用日志框架（如Logback/Log4j2）进行异步和结构化日志记录。
- 避免敏感信息泄露： 错误响应体中不应包含敏感信息，如数据库连接字符串、内部堆栈跟踪等。对于通用异常，返回一个友好的、非技术性的错误消息即可。
- HTTP状态码的正确使用： 结合业务含义选择合适的HTTP状态码。例如，资源未找到使用404 Not Found，参数校验失败使用400 Bad Request，认证失败使用401 Unauthorized，授权失败使用403 Forbidden，服务器内部错误使用500 Internal Server Error。
- 自定义异常： 对于业务逻辑中可能出现的特定错误，定义自定义异常（如CursaNotFoundException）。这使得异常处理更具针对性，代码可读性更高。
- 测试： 对异常处理逻辑进行充分的单元测试和集成测试，确保在各种异常场景下系统行为符合预期。
总结
在Spring Boot与前端分离的架构中，采用@ControllerAdvice结合自定义ApiError响应的策略是处理API异常的最佳实践。这种方法不仅实现了异常处理的集中化和标准化，提高了代码的可维护性，也为前端应用提供了清晰、可编程的错误信息，从而极大地提升了整个系统的健壮性和用户体验。通过规范错误码、正确使用HTTP状态码以及注意信息安全，我们可以构建出更专业、更可靠的RESTful API服务。
大量免费API接口：立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游，为数据API应用能力赋能！
