在Spring框架（尤其是Spring Web模塊）中，org.springframework.http.HttpStatus和org.springframework.http.ResponseEntity是處理HTTP響應(yīng)的核心類，二者配合使用可靈活控制HTTP響應(yīng)的狀態(tài)、頭部和體內(nèi)容。

以下是詳細(xì)解析：

一、HttpStatus：HTTP狀態(tài)碼的枚舉封裝

1. 定義與作用

HttpStatus是一個(gè)枚舉類，封裝了所有標(biāo)準(zhǔn)的HTTP狀態(tài)碼（如200、404、500等），每個(gè)枚舉常量對應(yīng)一個(gè)具體的HTTP狀態(tài)，包含狀態(tài)碼的數(shù)字值、原因短語（Reason Phrase）等信息。

其核心作用是：提供標(biāo)準(zhǔn)化的HTTP狀態(tài)碼定義，避免硬編碼數(shù)字（如200），提高代碼的可讀性、可維護(hù)性和規(guī)范性。

2. 核心屬性與方法

每個(gè)HttpStatus枚舉常量都包含以下關(guān)鍵信息（可通過方法獲?。?/p>

• 狀態(tài)碼數(shù)值：如200、404等，通過int value()方法獲取。
• 原因短語：狀態(tài)碼的文字描述（如OK、Not Found），通過String getReasonPhrase()方法獲取。
• 狀態(tài)碼系列：HTTP狀態(tài)碼分為5類（1xx~5xx），通過Series series()方法獲取所屬系列（Series是HttpStatus的內(nèi)部枚舉，包含INFORMATIONAL(1xx)、SUCCESSFUL(2xx)、REDIRECTION(3xx)、CLIENT_ERROR(4xx)、SERVER_ERROR(5xx)）。

3. 常用枚舉常量

2xx成功類：

• OK：200，請求成功（常用）。
• CREATED：201，資源創(chuàng)建成功（如POST新增資源）。
• NO_CONTENT：204，請求成功但無響應(yīng)體（如DELETE刪除資源）。

4xx客戶端錯(cuò)誤類：

• BAD_REQUEST：400，請求參數(shù)錯(cuò)誤。
• UNAUTHORIZED：401，未認(rèn)證（如未登錄）。
• FORBIDDEN：403，權(quán)限不足。
• NOT_FOUND：404，資源不存在。

5xx服務(wù)器錯(cuò)誤類：

• INTERNAL_SERVER_ERROR：500，服務(wù)器內(nèi)部錯(cuò)誤。
• SERVICE_UNAVAILABLE：503，服務(wù)不可用。

4. 實(shí)用方法

系列判斷：如is2xxSuccessful()（是否為2xx成功狀態(tài)）、is4xxClientError()（是否為4xx客戶端錯(cuò)誤）等，簡化狀態(tài)碼類型的判斷。

boolean isSuccess = HttpStatus.OK.is2xxSuccessful(); // true

狀態(tài)碼匹配：matches(int statusCode)判斷當(dāng)前枚舉是否匹配指定的數(shù)字狀態(tài)碼。

boolean isOk = HttpStatus.OK.matches(200); // true

5. 枚舉常量詳解

以下是HTTP狀態(tài)碼的作用和應(yīng)用場景說明，按狀態(tài)碼類別整理為表格：

二、ResponseEntity：HTTP響應(yīng)的完整封裝

1. 定義與作用

ResponseEntity<T>是一個(gè)泛型類，用于封裝HTTP響應(yīng)的完整信息，包括：

• 響應(yīng)狀態(tài)碼（通過HttpStatus指定）；
• 響應(yīng)頭（HttpHeaders）；
• 響應(yīng)體（泛型T，即返回給客戶端的數(shù)據(jù)）。

其核心作用是：在Spring MVC/WebFlux控制器中，作為方法返回值，精細(xì)化控制HTTP響應(yīng)的各個(gè)部分（相比@ResponseBody僅能控制響應(yīng)體，ResponseEntity更靈活）。

2. 核心結(jié)構(gòu)

ResponseEntity的核心組成：

• private final T body：響應(yīng)體（可為null，如204狀態(tài)無體）；
• private final HttpHeaders headers：響應(yīng)頭（如Content-Type、Authorization等）；
• private final HttpStatus statusCode：響應(yīng)狀態(tài)碼（HttpStatus枚舉）。

3. 常用創(chuàng)建方式

ResponseEntity提供了多種靜態(tài)工廠方法和構(gòu)造器，簡化創(chuàng)建過程：

直接指定狀態(tài)碼和響應(yīng)體：

// 返回200 OK + 響應(yīng)體
return ResponseEntity.ok(user); // 等價(jià)于 ResponseEntity.status(HttpStatus.OK).body(user)

// 返回201 Created + 響應(yīng)體
return ResponseEntity.status(HttpStatus.CREATED).body(newUser);

帶響應(yīng)頭的響應(yīng)：

HttpHeaders headers = new HttpHeaders();
headers.add("Location", "/users/123"); // 新增資源的URL
return new ResponseEntity<>(user, headers, HttpStatus.CREATED);

無響應(yīng)體的響應(yīng)：

// 返回204 No Content（無響應(yīng)體）
return ResponseEntity.noContent().build();

// 返回404 Not Found（無響應(yīng)體）
return ResponseEntity.notFound().build();

自定義響應(yīng)頭和狀態(tài)：

return ResponseEntity.status(HttpStatus.FORBIDDEN)
                     .header("X-Error", "Permission denied")
                     .body("無權(quán)訪問");

4. 核心方法

• T getBody()：獲取響應(yīng)體（可能為null）；
• HttpHeaders getHeaders()：獲取響應(yīng)頭；
• HttpStatus getStatusCode()：獲取響應(yīng)狀態(tài)碼（HttpStatus枚舉）；
• int getStatusCodeValue()：獲取狀態(tài)碼的數(shù)字值（如200）。

三、二者的關(guān)系與使用場景

1. 配合關(guān)系

HttpStatus是ResponseEntity的“狀態(tài)碼工具”：ResponseEntity通過HttpStatus枚舉來指定響應(yīng)的狀態(tài)碼，避免直接使用數(shù)字，保證規(guī)范性。

2. 典型使用場景

在Spring控制器中，當(dāng)需要：

• 不僅返回?cái)?shù)據(jù)（響應(yīng)體），還需指定狀態(tài)碼（如創(chuàng)建資源返回201）；
• 自定義響應(yīng)頭（如設(shè)置Cache-Control、Location）；
• 返回?zé)o響應(yīng)體的狀態(tài)（如204、404）；

此時(shí)必須使用ResponseEntity，并結(jié)合HttpStatus指定狀態(tài)。

示例：

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {
        User savedUser = userService.save(user); // 保存用戶
        HttpHeaders headers = new HttpHeaders();
        headers.setLocation(URI.create("/users/" + savedUser.getId())); // 資源位置
        // 返回201狀態(tài) + 響應(yīng)體 + 自定義頭
        return new ResponseEntity<>(savedUser, headers, HttpStatus.CREATED);
    }

    @GetMapping("/{id}")
    public ResponseEntity<User> getUser(@PathVariable Long id) {
        return userService.findById(id)
                .map(ResponseEntity::ok) // 存在則返回200 + 數(shù)據(jù)
                .orElseGet(() -> ResponseEntity.notFound().build()); // 不存在返回404
    }
}

總結(jié)

• HttpStatus：標(biāo)準(zhǔn)化HTTP狀態(tài)碼的枚舉，提供狀態(tài)碼、原因短語及系列判斷，避免硬編碼。
• ResponseEntity：封裝HTTP響應(yīng)的完整信息（狀態(tài)碼、頭、體），是Spring控制器中精細(xì)化控制響應(yīng)的核心類。

二者配合使用，可優(yōu)雅地處理各種HTTP響應(yīng)場景，是Spring Web開發(fā)的基礎(chǔ)工具。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評論