RESTful API 中如何处理全局异常-JavaScript中文网-JavaScript教程资源分享门户

什么是 RESTful API

RESTful，全称 Representational State Transfer，是一种架构风格和设计风格，提供了一种使用 HTTP 协议进行通信的标准化方法。RESTful API 进行网络通信时，通常使用 GET、POST、PUT、DELETE 等 HTTP 方法，并遵循 RESTful 架构的一些原则，如资源的唯一标识、无状态等。

在实际开发中，我们常常会遇到各种异常情况，例如网络错误、请求参数错误、权限不足等。在处理这些异常时，如何保证 API 的稳定性和可靠性，成为了一个极其重要的问题。本文将介绍在 RESTful API 中如何处理全局异常，保障 API 的稳定性和可靠性。

如何处理全局异常

在一些 web 框架中，通常会提供全局异常处理机制。全局异常处理机制会截获系统中抛出的异常，并统一处理。在 RESTful API 中，我们可以通过编写全局异常处理器来处理异常。

第一步：定义异常类

在 Java 中，我们可以通过继承 Exception 类或 RuntimeException 类来定义我们自己的异常类。在 RESTful API 中，我们可以根据具体业务，自定义异常类，例如：

public class BadRequestException extends RuntimeException {
    public BadRequestException(String message) {
        super(message);
    }
}

上述代码中，我们自定义了一个 BadRequestException 异常类，继承自 RuntimeException。BadRequestException 表示请求参数错误导致的异常，重写了 RuntimeException 的构造函数。

第二步：编写全局异常处理器

在 web 框架中，通常会提供全局异常处理器机制。在 Spring Boot 中，我们可以通过编写一个实现了 ErrorController 接口的类来自定义全局异常处理器。

全局异常处理器的代码一般会包含对各类异常的捕获与处理，例如：

// javascriptcn.com 代码示例
@RestControllerAdvice
public class GlobalExceptionHandler implements ErrorController {

    @ExceptionHandler(BadRequestException.class)
    public ResponseEntity<String> handleBadRequestException(BadRequestException e) {
        return ResponseEntity.badRequest().body(e.getMessage());
    }

    @ExceptionHandler(AccessDeniedException.class)
    public ResponseEntity<String> handleAccessDeniedException(AccessDeniedException e) {
        return ResponseEntity.status(HttpStatus.FORBIDDEN).body("无权限访问");
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
    }

    @Override
    public String getErrorPath() {
        return null;
    }
}

上述代码中，我们给出了三种异常的处理方式：

BadRequestException：表示请求参数错误。当捕获到 BadRequestException 异常时，我们可以返回一个 400（Bad Request）的状态码，并将异常信息放在响应体中。
AccessDeniedException：表示权限不足。当捕获到 AccessDeniedException 异常时，我们可以返回一个 403（Forbidden）的状态码，并将异常信息放在响应体中。
Exception：表示其他各类异常。当捕获到 Exception 异常时，我们可以返回一个 500（Internal Server Error）的状态码，并将异常信息放在响应体中。

值得注意的是，在编写全局异常处理器时，我们需要使用 @RestControllerAdvice 注解，声明该类为全局异常处理器。除此之外，我们还需实现 ErrorController 接口，并重写 getErrorPath 方法。

第三步：抛出自定义异常

当需要在 RESTful API 中抛出异常时，我们可以使用我们编写的自定义异常，例如：

@GetMapping("/books/{id}")
public Book getById(@PathVariable Long id) {
    Book book = bookService.getById(id);
    if (book == null) {
        throw new NotFoundException(String.format("未找到 ID 为 %d 的书籍", id));
    }
    return book;
}

上述代码中，当查找 ID 为 id 的书籍不存在时，我们抛出了一个 NotFoundException 异常。

代码示例

上述内容已经详细介绍了在 RESTful API 中如何处理全局异常。最后，给出一个完整的代码示例，帮助读者更好地理解。

// javascriptcn.com 代码示例
@RestControllerAdvice
public class GlobalExceptionHandler implements ErrorController {

    @ExceptionHandler(BadRequestException.class)
    public ResponseEntity<String> handleBadRequestException(BadRequestException e) {
        return ResponseEntity.badRequest().body(e.getMessage());
    }

    @ExceptionHandler(NotFoundException.class)
    public ResponseEntity<String> handleNotFoundException(NotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(e.getMessage());
    }

    @ExceptionHandler(AccessDeniedException.class)
    public ResponseEntity<String> handleAccessDeniedException(AccessDeniedException e) {
        return ResponseEntity.status(HttpStatus.FORBIDDEN).body("无权限访问");
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
    }

    @Override
    public String getErrorPath() {
        return null;
    }
}

@RestController
@RequestMapping("/books")
public class BookController {

    private final BookService bookService;

    public BookController(BookService bookService) {
        this.bookService = bookService;
    }

    @GetMapping("")
    public List<Book> list() {
        return bookService.list();
    }

    @GetMapping("/{id}")
    public Book getById(@PathVariable Long id) {
        Book book = bookService.getById(id);
        if (book == null) {
            throw new NotFoundException(String.format("未找到 ID 为 %d 的书籍", id));
        }
        return book;
    }

    @PostMapping("")
    public Book add(@RequestBody Book book) {
        bookService.add(book);
        return book;
    }

    @DeleteMapping("/{id}")
    public void delete(@PathVariable Long id) {
        bookService.delete(id);
    }

}

上述代码中，我们定义了一个 BookController，包含 books 的增删查操作。当查找 ID 为 id 的书籍不存在时，我们抛出了一个 NotFoundException 异常。在 GlobalExceptionHandler 中，我们定义了 NotFoundException 的处理方式，返回 404 的状态码和异常信息。

总结

在 RESTful API 开发中，异常处理是一个必不可少的部分。通过自定义异常类和全局异常处理器，我们可以轻松地处理各种异常，并保证 API 的稳定性和可靠性。希望本文能为读者在 RESTful API 开发中解决异常问题提供帮助。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/654fb6f47d4982a6eb8abe34