Spring?Boot?使用斷言讓你的代碼在上線前就通過“體檢”(最新整理)

更新時間：2025年03月26日 14:30:20 作者：碼熔burning

斷言是一種編程技巧,用于在代碼中插入檢查點,驗證程序的狀態(tài)是否符合預期,如果斷言失敗,程序會拋出一個錯誤,幫助你快速發(fā)現(xiàn)和修復bug,本文給大家介紹Spring?Boot?斷言：讓你的代碼在上線前就通過“體檢”,感興趣的朋友一起看看吧

一、什么是斷言？

想象一下，你在做菜。你心里想的是：“我加鹽的時候，鹽的量一定要是 5 克，不能多也不能少！??” 如果鹽的量不是 5 克，那這道菜可能就毀了。

斷言，就像你做菜時的這個“心里想的”。它是一種檢查機制，用來確保你的代碼在運行過程中，某些條件必須為真。 ? 如果條件不為真，就說明代碼出了問題，應該立即停止運行，并告訴你哪里出錯了。

更正式的說法：

斷言是一種編程技巧，用于在代碼中插入一些檢查點，驗證程序的狀態(tài)是否符合預期。如果斷言失敗（即條件為假），程序會拋出一個錯誤（通常是 AssertionError），幫助你快速發(fā)現(xiàn)和修復 bug。

斷言的優(yōu)點：

盡早發(fā)現(xiàn)錯誤：在問題發(fā)生的地方立即報錯，而不是等到問題蔓延到其他地方才發(fā)現(xiàn)。
提高代碼可靠性：通過斷言，你可以確保代碼在各種情況下都能正常工作。
簡化調(diào)試：斷言失敗時，會提供詳細的錯誤信息，幫助你快速定位問題。
文檔作用：斷言可以看作是一種代碼級別的文檔，說明了代碼的預期行為。

二、Java 中的斷言

Java 提供了 assert 關(guān)鍵字來實現(xiàn)斷言。它的基本語法是：

assert condition;  // 簡單斷言：如果 condition 為 false，則拋出 AssertionError
assert condition : message; // 帶消息的斷言：如果 condition 為 false，則拋出 AssertionError，并顯示 message

condition：一個布爾表達式，表示你期望為真的條件。
message：一個可選的字符串，用于提供更詳細的錯誤信息。

重要提示：

默認情況下，Java 中的斷言是禁用的。 你需要在運行程序時顯式地啟用它們。
??斷言不應該用于處理程序正常運行所必需的錯誤。 例如，不應該用斷言來檢查用戶輸入是否有效。應該使用異常處理機制來處理這些錯誤。
斷言主要用于開發(fā)和測試階段。 在生產(chǎn)環(huán)境中，通常會禁用斷言，因為它們可能會影響性能。

如何啟用斷言：

在運行 Java 程序時，使用 -ea 或 -enableassertions 選項來啟用斷言。

例如：

java -ea MyClass // 啟用所有斷言
java -ea:com.example... MyClass // 啟用 com.example 包及其子包中的斷言
java -da MyClass // 禁用所有斷言

三、在 Spring Boot 中使用斷言

雖然 Java 提供了 assert 關(guān)鍵字，但在 Spring Boot 項目中，更常見的做法是使用 org.springframework.util.Assert 類。這個類提供了一組靜態(tài)方法，用于執(zhí)行各種斷言。

org.springframework.util.Assert 類的常用方法：

Assert.isTrue(boolean expression, String message)：斷言表達式為真。
Assert.isNull(Object object, String message)：斷言對象為 null。
Assert.notNull(Object object, String message)：斷言對象不為 null。
Assert.hasLength(String text, String message)：斷言字符串不為 null 且長度大于 0。
Assert.hasText(String text, String message)：斷言字符串不為 null 且包含非空白字符。
Assert.doesNotContain(String textToSearch, String substring, String message)：斷言字符串不包含指定的子字符串。
Assert.notEmpty(Collection<?> collection, String message)：斷言集合不為 null 且不為空。
Assert.noNullElements(Object[] array, String message)：斷言數(shù)組不為 null 且不包含 null 元素。
Assert.isInstanceOf(Class<?> type, Object obj, String message)：斷言對象是指定類型的實例。
Assert.state(boolean expression, String message)：斷言對象的狀態(tài)是有效的。

四、Spring Boot 代碼示例

下面是一個完整的 Spring Boot 代碼示例，演示了如何使用 org.springframework.util.Assert 類進行斷言。

// 引入必要的依賴
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.util.Assert;
@SpringBootApplication
public class AssertionExampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(AssertionExampleApplication.class, args);
    }
}
@RestController
class MyController {
    @GetMapping("/greet")
    public String greet(@RequestParam String name) {
        // 使用斷言來確保 name 不為 null 或空字符串
        Assert.hasText(name, "姓名不能為空或空字符串");
        // 如果斷言通過，則執(zhí)行正常的業(yè)務邏輯
        return "你好, " + name + "!";
    }
    @GetMapping("/calculate")
    public int calculate(@RequestParam int num1, @RequestParam int num2) {
        // 使用斷言來確保 num2 不為 0，防止除以 0 錯誤
        Assert.isTrue(num2 != 0, "除數(shù)不能為零");
        return num1 / num2;
    }
    @GetMapping("/processList")
    public String processList(@RequestParam(required = false) String listString) {
        // 使用斷言確保傳入的字符串不為空
        Assert.hasText(listString, "列表字符串不能為空或空字符串");
        String[] items = listString.split(",");
        Assert.noNullElements(items, "列表不能包含空元素");
        return "處理后的列表: " + String.join(" - ", items);
    }
}

代碼解釋：

AssertionExampleApplication 類：標準的 Spring Boot 啟動類。
MyController 類：一個簡單的 REST 控制器，包含三個接口：
- /greet 接口：接收一個 name 參數(shù)，使用 Assert.hasText() 斷言 name 不為 null 或空字符串。如果 name 為 null 或空字符串，則會拋出一個 IllegalArgumentException 異常，并顯示錯誤消息 “姓名不能為空或空字符串”。
- /calculate 接口：接收兩個整數(shù) num1 和 num2，使用 Assert.isTrue() 斷言 num2 不為 0。如果 num2 為 0，則會拋出一個 IllegalArgumentException 異常，并顯示錯誤消息 “除數(shù)不能為零”。
- /processList 接口：接收一個逗號分隔的字符串列表，使用 Assert.hasText() 確保字符串不為空，然后使用 Assert.noNullElements() 確保分割后的數(shù)組不包含 null 元素。

如何運行示例：

將代碼保存為 AssertionExampleApplication.java。
使用 Maven 或 Gradle 構(gòu)建項目。
運行 Spring Boot 應用程序。
在瀏覽器或使用 curl 命令訪問以下 URL：
- http://localhost:8080/greet?name=John （正常情況）
- http://localhost:8080/greet?name= （斷言失敗，拋出異常）

http://localhost:8080/calculate?num1=10&num2=2 （正常情況）

http://localhost:8080/calculate?num1=10&num2=0 （斷言失敗，拋出異常）

http://localhost:8080/processList?listString=apple,banana,cherry (正常情況)

http://localhost:8080/processList?listString= (斷言失敗，拋出異常)

http://localhost:8080/processList?listString=apple,banana, (正常情況)

你會在控制臺或瀏覽器中看到以下結(jié)果：

正常情況： 返回 “你好, John!” 或計算結(jié)果。
斷言失敗： 會看到一個 IllegalArgumentException 異常，其中包含斷言失敗的消息。 Spring Boot 默認會將異常轉(zhuǎn)換為 HTTP 500 錯誤。

異常信息將會是中文的，例如：“java.lang.IllegalArgumentException: 姓名不能為空或空字符串”

五、斷言的注意事項

不要用斷言來驗證用戶輸入：用戶輸入是不可信的，應該使用專門的驗證機制（例如，JSR-303 Bean Validation）。
不要在斷言中執(zhí)行有副作用的操作：斷言應該只用于檢查狀態(tài)，而不應該修改狀態(tài)。 ?? 否則，在禁用斷言時，程序的行為可能會發(fā)生改變。
保持斷言簡潔明了：斷言應該易于理解，能夠清晰地表達代碼的預期行為。
考慮使用單元測試代替復雜的斷言：對于復雜的邏輯，使用單元測試通常比使用斷言更有效。