Java 中的 assert 关键字

assert 是 Java 中用于断言（assertion） 的关键字，主要用于测试代码中的假设是否为真。如果断言失败，程序会抛出一个 AssertionError，用于指示程序中的逻辑错误。

---

使用场景

assert 通常用于：

1. 开发和调试阶段：验证代码是否按照预期工作，发现潜在的逻辑错误。
2. 运行时检查：用于检查不应该发生的情况，例如方法前置条件和后置条件。
3. 防御性编程：确保某些关键假设不会被违反。

---

语法

基本语法

assert condition;

• condition 是一个布尔表达式，如果为 false，则断言失败。

带消息的语法

assert condition : message;

assert condition : message;

• message 是一个错误信息，用于说明断言失败时的原因。这个消息通常是一个字符串或能被转换为字符串的对象。

---

启用断言

默认情况下，Java 的断言是禁用的（即便你写了 assert 语句，也不会执行检查）。要启用断言，必须在运行时使用 -ea（--enableassertions）标志：

java -ea MainClass

• 禁用断言：使用 -da 或 --disableassertions（默认行为）。
• 针对特定包或类启用断言：

java -ea:com.mycompany... MainClass
java -ea:com.mycompany.MyClass MainClass

---

示例

1. 简单断言

public class Main {
    public static void main(String[] args) {
        int x = 10;
        assert x > 5; // 断言成功，程序继续运行
        assert x > 15; // 断言失败，抛出 AssertionError
    }
}

运行结果（启用断言时，使用 -ea）：

Exception in thread "main" java.lang.AssertionError
	at Main.main(Main.java:6)

---

2. 带消息的断言

public class Main {
    public static void main(String[] args) {
        int x = 10;
        assert x > 15 : "x 应该大于 15，但实际值为 " + x;
    }
}

运行结果：

Exception in thread "main" java.lang.AssertionError: x 应该大于 15，但实际值为 10
	at Main.main(Main.java:4)

---

3. 验证方法参数

断言可以用于检查方法的输入参数是否满足特定条件：

public class Main {
    public static int divide(int numerator, int denominator) {
        assert denominator != 0 : "分母不能为 0";
        return numerator / denominator;
    }

    public static void main(String[] args) {
        divide(10, 0); // 断言失败
    }
}

---

4. 循环中的断言

public class Main {
    public static void main(String[] args) {
        int[] array = {1, 2, 3, 4, 5};
        for (int i = 0; i < array.length; i++) {
            assert array[i] > 0 : "数组中有非正数，位置：" + i;
        }
    }
}

---

断言与异常的区别

特性	断言 (assert)	异常 (Exception)
用途	开发和调试阶段的逻辑验证	运行时错误处理
启用/禁用	默认禁用，需用 -ea 手动启用	默认启用，无法禁用
错误类型	抛出 AssertionError	抛出 Exception 或其子类
适用范围	不应该发生的程序逻辑错误	可预期的运行时错误
处理机制	通常不捕获	通常用 try-catch 捕获并处理

---

使用注意事项

1. 生产环境禁用断言：

   • 断言一般用于开发阶段的检查。
   • 在生产环境中运行程序时，通常会禁用断言，因此不能依赖断言来执行关键检查。

2. 不要用于替代异常处理：

   • 如果程序需要对某些输入参数或运行时条件进行强制验证，应使用异常（如 IllegalArgumentException），而非断言。
   • 例如：

public void setAge(int age) {
    if (age < 0 || age > 150) {
        throw new IllegalArgumentException("年龄必须在 0 到 150 之间");
    }
}

3. 只适用于测试开发中的假设：

   • 断言适合检查“理论上永远不会出错”的代码路径或状态，例如数学公式的前后条件验证。

4. 避免副作用：

   • 断言语句中不要包含会改变程序状态的代码：

assert list.remove(0) != null; // 不建议这样做

---

适合断言的场景

1. 方法的前置条件和后置条件：

   • 确保方法的参数和返回值符合预期。

2. 检查不可能发生的情况：

   • 例如：

switch (status) {
    case "ACTIVE":
    case "INACTIVE":
        break;
    default:
        assert false : "未知的状态值：" + status;
}

3. 算法的中间验证：

   • 在复杂算法中，断言某些变量或数据结构的状态是正确的。

---

总结

• assert 是 Java 中的断言机制，适用于开发和调试阶段，用于验证代码逻辑的正确性。
• 默认情况下，断言是禁用的，需要通过 -ea 启用。
• 不要依赖断言来处理生产环境的关键逻辑，应该将其视为调试工具，而非正式的错误处理机制。

通过合理使用 assert，可以在开发阶段捕获潜在的逻辑错误，提高代码的可靠性和可维护性。