Spring Boot 使用断言让你的代码在上线前就通过“体检”(最新整理)
作者：码熔burning
一、什么是断言？
想象一下，你在做菜。你心里想的是：“我加盐的时候，盐的量一定要是 5 克，不能多也不能少！🧂” 如果盐的量不是 5 克，那这道菜可能就毁了。
断言，就像你做菜时的这个“心里想的”。 它是一种检查机制，用来确保你的代码在运行过程中，某些条件必须为真。 ✅ 如果条件不为真，就说明代码出了问题，应该立即停止运行，并告诉你哪里出错了。
更正式的说法：
断言是一种编程技巧，用于在代码中插入一些检查点，验证程序的状态是否符合预期。 如果断言失败（即条件为假），程序会抛出一个错误（通常是 AssertionError），帮助你快速发现和修复 bug。
断言的优点：
- 尽早发现错误： 在问题发生的地方立即报错，而不是等到问题蔓延到其他地方才发现。
- 提高代码可靠性： 通过断言，你可以确保代码在各种情况下都能正常工作。
- 简化调试： 断言失败时，会提供详细的错误信息，帮助你快速定位问题。
- 文档作用： 断言可以看作是一种代码级别的文档，说明了代码的预期行为。
二、Java 中的断言
Java 提供了 assert 关键字来实现断言。 它的基本语法是：
assert condition; // 简单断言：如果 condition 为 false，则抛出 AssertionError assert condition : message; // 带消息的断言：如果 condition 为 false，则抛出 AssertionError，并显示 message
condition：一个布尔表达式，表示你期望为真的条件。message：一个可选的字符串，用于提供更详细的错误信息。
重要提示：
- 默认情况下，Java 中的断言是禁用的。 你需要在运行程序时显式地启用它们。
- ⚙️断言不应该用于处理程序正常运行所必需的错误。 例如，不应该用断言来检查用户输入是否有效。 应该使用异常处理机制来处理这些错误。
- 断言主要用于开发和测试阶段。 在生产环境中，通常会禁用断言，因为它们可能会影响性能。
如何启用断言：
在运行 Java 程序时，使用 -ea 或 -enableassertions 选项来启用断言。
例如：
java -ea MyClass // 启用所有断言
java -ea:com.example... MyClass // 启用 com.example 包及其子包中的断言
java -da MyClass // 禁用所有断言
三、在 Spring Boot 中使用断言
虽然 Java 提供了 assert 关键字，但在 Spring Boot 项目中，更常见的做法是使用 org.springframework.util.Assert 类。 这个类提供了一组静态方法，用于执行各种断言。
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)：断言数组不为 null 且不包含 null 元素。Assert.isInstanceOf(Class<?> type, Object obj, String message)：断言对象是指定类型的实例。Assert.state(boolean expression, String message)：断言对象的状态是有效的。
四、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, "姓名不能为空或空字符串");
// 如果断言通过，则执行正常的业务逻辑
return "你好, " + name + "!";
}
@GetMapping("/calculate")
public int calculate(@RequestParam int num1, @RequestParam int num2) {
// 使用断言来确保 num2 不为 0，防止除以 0 错误
Assert.isTrue(num2 != 0, "除数不能为零");
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参数，使用Assert.hasText()断言name不为 null 或空字符串。 如果name为 null 或空字符串，则会抛出一个IllegalArgumentException异常，并显示错误消息 “姓名不能为空或空字符串”。/calculate接口： 接收两个整数num1和num2，使用Assert.isTrue()断言num2不为 0。 如果num2为 0，则会抛出一个IllegalArgumentException异常，并显示错误消息 “除数不能为零”。/processList接口： 接收一个逗号分隔的字符串列表，使用Assert.hasText()确保字符串不为空，然后使用Assert.noNullElements()确保分割后的数组不包含 null 元素。
如何运行示例：
- 将代码保存为
AssertionExampleApplication.java。 - 使用 Maven 或 Gradle 构建项目。
- 运行 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, (正常情况)
你会在控制台或浏览器中看到以下结果：
- 正常情况： 返回 “你好, John!” 或计算结果。
- 断言失败： 会看到一个
IllegalArgumentException异常，其中包含断言失败的消息。 Spring Boot 默认会将异常转换为 HTTP 500 错误。
异常信息将会是中文的，例如：“java.lang.IllegalArgumentException: 姓名不能为空或空字符串”
五、断言的注意事项
- 不要用断言来验证用户输入： 用户输入是不可信的，应该使用专门的验证机制（例如，JSR-303 Bean Validation）。
- 不要在断言中执行有副作用的操作： 断言应该只用于检查状态，而不应该修改状态。 ⚠️ 否则，在禁用断言时，程序的行为可能会发生改变。
- 保持断言简洁明了： 断言应该易于理解，能够清晰地表达代码的预期行为。
- 考虑使用单元测试代替复杂的断言： 对于复杂的逻辑，使用单元测试通常比使用断言更有效。
六、总结
断言是一种强大的工具，可以帮助你提高代码的可靠性和可维护性。 在 Spring Boot 项目中，可以使用 org.springframework.util.Assert 类来方便地进行断言。 记住，断言主要用于开发和测试阶段，不应该用于处理程序正常运行所必需的错误。
希望篇文章能够帮助你理解断言的概念和用法！
到此这篇关于Spring Boot 断言：让你的代码在上线前就通过“体检”！的文章就介绍到这了,更多相关Spring Boot 使用断言内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！