SpringBoot結(jié)果封裝和異常攔截的實現(xiàn)示例

更新時間：2023年08月17日 08:57:37 作者：小虎哥的技術(shù)博客

SpringBoot 項目中，我們通常需要將結(jié)果數(shù)據(jù)封裝成特定的格式，以方便客戶端進行處理,本文主要介紹了SpringBoot?優(yōu)雅的結(jié)果封裝和異常攔截，感興趣的可以了解一下

在 SpringBoot 項目中，我們通常需要將結(jié)果數(shù)據(jù)封裝成特定的格式，以方便客戶端進行處理。我們可以將封裝結(jié)果的代碼封裝成一個工具類或統(tǒng)一的響應類型，以簡化代碼的編寫工作，并且方便統(tǒng)一管理。下面介紹一個簡單的例子，說明如何對 SpringBoot 返回結(jié)果進行封裝。

1. 定義 CommonResult 類

我們可以定義一個名為 CommonResult<T> 的類，用于封裝接口的響應結(jié)果。它包含三個字段，分別對應了狀態(tài)碼 code、響應消息 msg 和響應數(shù)據(jù) data，其中數(shù)據(jù)類型為泛型 T。code 字段是 int 類型的。

public class CommonResult<T> {
? ? private int code; ?// 響應狀態(tài)碼
? ? private String msg; ?// 響應消息
? ? private T data; ?// 響應數(shù)據(jù)
? ? // 構(gòu)造器
? ? public CommonResult() {}
? ? public CommonResult(int code, String msg, T data) {
? ? ? ? this.code = code;
? ? ? ? this.msg = msg;
? ? ? ? this.data = data;
? ? }
? ? // 省略 Getter 和 Setter 方法
}

2. 定義響應碼 ResponseCode

為了方便管理和調(diào)用響應狀態(tài)碼，我們可以定義一個名為 ResponseCode 的類，用來統(tǒng)一管理響應狀態(tài)碼。

public enum ResponseCode {
? ? SUCCESS(200, "操作成功"),
? ? FAIL(500, "操作失敗");
? ? // 狀態(tài)碼和狀態(tài)信息
? ? private final int code;
? ? private final String message;
? ? // 構(gòu)造器
? ? private ResponseCode(int code, String message) {
? ? ? ? this.code = code;
? ? ? ? this.message = message;
? ? }
? ? // Getter 方法
? ? public int getCode() {
? ? ? ? return code;
? ? }
? ? public String getMessage() {
? ? ? ? return message;
? ? }
}

在這里我們只定義了兩種響應狀態(tài)碼，分別是成功和失敗，對應的狀態(tài)碼分別為 200 和 500。在實際項目中，我們可以根據(jù)實際業(yè)務場景定義更多的響應狀態(tài)碼。

3. 自定義異常 BizException

我們還可以定義一個自定義異常類 BizException，用于處理自定義異常場景，并在 GlobalExceptionHandler 中進行攔截與處理。

public class BizException extends RuntimeException {
? ? private int code;
? ? public BizException(ResponseCode responseCode) {
? ? ? ? super(responseCode.getMessage());
? ? ? ? this.code = responseCode.getCode();
? ? }
? ? // Getter 方法
? ? public int getCode() {
? ? ? ? return code;
? ? }
}

Biz是英文Business的縮寫，表示業(yè)務中發(fā)生的異常。

在該類中，我們定義了響應狀態(tài)碼對應的異常，并在構(gòu)造方法中傳入對應的 ResponseCode 來初始化異常的 code 字段。

4. 統(tǒng)一處理異常情況

在實際項目中，我們需要對異常情況進行處理，以保證系統(tǒng)的穩(wěn)定性和可控性。因此，我們可以在對外暴露的 API 接口中添加異常處理機制，以統(tǒng)一處理系統(tǒng)拋出的異常情況，并防止系統(tǒng)掛掉。
在 SpringBoot 中，我們可以通過使用 @RestControllerAdvice 和 @ExceptionHandler 注解來進行異常處理。具體實現(xiàn)方式如下：

@RestControllerAdvice
public class GlobalExceptionHandler {
? ? @ExceptionHandler(Exception.class)
? ? public CommonResult<String> handleException(Exception e) {
? ? ? ? log.error("系統(tǒng)異常：{}", e.getMessage());
? ? ? ? return new CommonResult<>(ResponseCode.FAIL.getCode(), "系統(tǒng)錯誤，請聯(lián)系管理員", null);
? ? }
? ? @ExceptionHandler(BizException.class)
? ? public CommonResult<String> handleBizException(BizException e) {
? ? ? ? log.error("業(yè)務異常：{}", e.getMessage());
? ? ? ? return new CommonResult<>(e.getCode(), e.getMessage(), null);
? ? }
}

在上面的例子中，我們使用了 @RestControllerAdvice 注解來定義一個全局的異常處理類，使用 @ExceptionHandler(Exception.class) 和 @ExceptionHandler(BizException.class) 注解來分別處理全局異常和自定義的業(yè)務異常。

當系統(tǒng)發(fā)生異常時，會被 handleException 方法所捕獲，輸出異常日志，并返回一個業(yè)務失敗的結(jié)果。而當業(yè)務異常發(fā)生時，會被 handleBizException 方法所捕獲，返回該業(yè)務異常對應的狀態(tài)碼、響應消息和響應數(shù)據(jù)。

5. 使用結(jié)果封裝類和模擬異常攔截

@RestController
@RequestMapping("/api")
public class UserController {
? ? // 省略注入代碼
? ? @GetMapping("/users/{id}")
? ? public CommonResult<User> getUserById(@PathVariable("id") Long id) {
? ? ? ? User user = userService.getUserById(id);
? ? ? ? if (null != user) {
? ? ? ? ? ? return new CommonResult<>(ResponseCode.SUCCESS.getCode(), ResponseCode.SUCCESS.getMessage(), user);
? ? ? ? } else {
? ? ? ? ? ? throw new BizException(ResponseCode.FAIL);
? ? ? ? }
? ? }
}

使用CommonResult<User>來返回數(shù)據(jù)給前端
throw new BizException(ResponseCode.FAIL);拋出異常后會在異常攔截器那里攔截統(tǒng)一進行處理

6. 總結(jié)

在本篇教程中，我們介紹了如何使用 SpringBoot 來封裝返回結(jié)果。我們定義了 CommonResult 類、ResponseCode 類和 BizException 自定義業(yè)務異常類，用于封裝響應結(jié)果、統(tǒng)一管理響應狀態(tài)碼和處理自定義業(yè)務異常。我們也介紹了如何使用 @RestControllerAdvice 和 @ExceptionHandler 注解來統(tǒng)一處理異常情況，避免因為異常情況導致系統(tǒng)不穩(wěn)定。在實際項目中，我們可以根據(jù)實際情況對以上代碼進行修改和調(diào)整，以適應不同的業(yè)務場景。

到此這篇關(guān)于SpringBoot結(jié)果封裝和異常攔截的實現(xiàn)示例的文章就介紹到這了,更多相關(guān)SpringBoot 結(jié)果封裝和異常攔截內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: