SpringBoot中的@ResponseStatus注解處理異常狀態(tài)碼

更新時間：2023年08月07日 08:37:11 作者：硬件人某某某

這篇文章主要介紹了SpringBoot中的@ResponseStatus注解處理異常狀態(tài)碼,在?SpringBoot?應用程序中，異常處理是一個非常重要的話題。當應用程序出現(xiàn)異常時，我們需要對異常進行處理，以保證應用程序的穩(wěn)定性和可靠性,需要的朋友可以參考下

什么是 @ResponseStatus 注解？

@ResponseStatus 注解用于指定控制器方法拋出異常時的 HTTP 狀態(tài)碼和對應的錯誤信息。

當控制器方法拋出指定類型的異常時，SpringBoot 會自動將 @ResponseStatus 注解中定義的狀態(tài)碼和錯誤信息返回給客戶端。

該注解的語法如下：

@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Bad request")
public class BadRequestException extends RuntimeException {
}

在上面的代碼中， @ResponseStatus 注解定義了一個 BadRequestException 異常類，并指定了 HTTP 狀態(tài)碼為 400（Bad Request），錯誤信息為 “Bad request”。

當控制器方法拋出 BadRequestException 異常時，SpringBoot 會自動將 HTTP 狀態(tài)碼和錯誤信息返回給客戶端。

如何使用 @ResponseStatus 注解處理異常狀態(tài)碼

下面我們通過一個示例來演示如何使用 @ResponseStatus 注解處理異常狀態(tài)碼。

步驟 1：創(chuàng)建 SpringBoot 項目

首先，我們需要創(chuàng)建一個 SpringBoot 項目。可以使用 Spring Initializr 快速創(chuàng)建一個空的 SpringBoot 項目。在項目中添加以下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

其中， spring-boot-starter-web 依賴用于創(chuàng)建 Web 項目。

步驟 2：定義異常類

接下來，我們需要定義一個異常類，用于拋出異常。在異常類中，我們使用 @ResponseStatus 注解來定義 HTTP 狀態(tài)碼和錯誤信息。具體代碼如下：

@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Bad request")
public class BadRequestException extends RuntimeException {
}

在上面的代碼中， @ResponseStatus 注解定義了一個 BadRequestException 異常類，并指定了 HTTP 狀態(tài)碼為 400（Bad Request），錯誤信息為 “Bad request”。

步驟 3：創(chuàng)建控制器

接下來，我們需要創(chuàng)建一個控制器，用于處理請求。在控制器中，我們拋出 BadRequestException 異常。具體代碼如下：

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        if (id <= 0) {
            throw new BadRequestException();
        }
        User user = userRepository.findById(id).orElseThrow(() -> new ResourceNotFoundException("User", "id", id));
        return ResponseEntity.ok().body(user);
    }
}

在上面的代碼中，當 URL 中的 id 參數(shù)小于等于 0 時，我們拋出 BadRequestException 異常。

步驟 4：測試

最后，我們可以使用 Postman 或類似的工具來測試我們的控制器。例如，我們可以發(fā)送一個 GET 請求到 /users/0 ，這會導致控制器拋出 BadRequestException 異常，并返回 HTTP 狀態(tài)碼為 400 和錯誤信息為 “Bad request” 的響應。