Java Spring Boot框架下RESTful API的异常处理

原创素颜马尾好姑娘i 2024-11-08 08:27 38阅读 0赞

在Java Spring Boot框架中，处理RESTful API的异常是一个重要的部分，因为它可以帮助你提供更清晰的错误信息给客户端，并且能够统一异常处理逻辑。以下是一些常见的异常处理方法：

###1. 使用`@ControllerAdvice`或`@RestControllerAdvice`

`@ControllerAdvice`或`@RestControllerAdvice`注解可以帮助你创建一个全局的异常处理器。你可以定义一个类，在这个类中使用`@ExceptionHandler`方法来捕获和处理特定的异常。

```java@RestControllerAdvicepublic class GlobalExceptionHandler {

@ExceptionHandler(value = Exception.class)
 public ResponseEntity<Object> handleAllExceptions(Exception ex, WebRequest request) {
ErrorDetails errorDetails = new ErrorDetails(new Date(), ex.getMessage(),
 request.getDescription(false));
 return new ResponseEntity<>(errorDetails, HttpStatus.INTERNAL_SERVER_ERROR);
 }

@ExceptionHandler(value = CustomException.class)
 public ResponseEntity<Object> handleCustomException(CustomException ex, WebRequest request) {
ErrorDetails errorDetails = new ErrorDetails(new Date(), ex.getMessage(),
 request.getDescription(false));
 return new ResponseEntity<>(errorDetails, HttpStatus.BAD_REQUEST);
 }
}
```###2. 使用`@ExceptionHandler`注解如果你只想在特定的控制器中处理异常，可以在控制器类中使用`@ExceptionHandler`注解。

```java@RestController@RequestMapping("/api")
public class MyController {

@ExceptionHandler(CustomException.class)
 public ResponseEntity<String> handleCustomException(CustomException ex) {
 return new ResponseEntity<>(ex.getMessage(), HttpStatus.BAD_REQUEST);
 }
}
```###3. 使用`ResponseEntityExceptionHandler`

Spring Boot提供了`ResponseEntityExceptionHandler`类，你可以扩展这个类来自定义异常处理。

```java@ControllerAdvicepublic class CustomResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {

@Override protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body,
 HttpHeaders headers, HttpStatus status, WebRequest request) {
ErrorDetails errorDetails = new ErrorDetails(new Date(), ex.getMessage(),
 request.getDescription(false));
 return new ResponseEntity<>(errorDetails, status);
 }
}
```###4. 使用`@ResponseStatus`注解你可以在异常类上使用`@ResponseStatus`注解来指定异常的HTTP状态码。

```java@ResponseStatus(value = HttpStatus.BAD_REQUEST)
public class CustomException extends RuntimeException {
 public CustomException(String message) {
 super(message);
 }
}
```###5. 自定义错误响应体通常，你会想要自定义错误响应体，以提供更详细的错误信息。你可以创建一个`ErrorDetails`类来封装这些信息。

```javapublic class ErrorDetails {
 private Date timestamp;
 private String message;
 private String details;

//构造函数、getter和setter省略}
```###6.异常处理的优先级- `@ExceptionHandler`方法的优先级高于`@ControllerAdvice`。
- `@ControllerAdvice`的优先级高于`ResponseEntityExceptionHandler`。

通过这些方法，你可以有效地管理和响应RESTful API中的异常，提高API的健壮性和用户体验。