Java Assert断言最佳实践

在 Java 中使用 Assert（断言） 时，核心原则是：断言只用于“程序内部逻辑正确性”的检查，而不是用来处理“可预期的运行时错误”。下面从适用场景、最佳实践、常见误区、与异常的区别、示例几个方面系统说明。

一、断言是什么（快速回顾）

assert condition;
assert condition : "错误信息";

• 默认 关闭
• 启用方式：

java -ea MyApp
# 或
java -enableassertions MyApp

二、断言的最佳实践 ✅

✅ 1. 只用于“永远不应该发生”的情况

断言用于表达：

“如果这个条件不成立，说明程序有 bug。”

✅ 正确示例：

int divide(int a, int b) {
    assert b != 0 : "除数不能为 0";
    return a / b;
}

❌ 错误示例：

// 外部输入不可信，不能用断言
assert userInput >= 0;

✅ 2. 不要用于参数校验（对外 API）

对外方法参数校验应使用异常，而不是断言

✅ 正确：

public void setAge(int age) {
    if (age < 0) {
        throw new IllegalArgumentException("age 不能为负数");
    }
}

❌ 错误：

public void setAge(int age) {
    assert age >= 0;
}

原因：

• 断言可能被关闭
• 外部输入不可信

✅ 3. 断言不应产生副作用

❌ 错误示例：

assert list.remove(x);

✅ 正确：

boolean removed = list.remove(x);
assert removed : "x 应该存在于 list 中";

断言表达式可能在生产环境不执行

✅ 4. 用于“内部不变式（invariant）”检查

非常适合用于：

• 类内部状态一致性
• 循环不变量
• 私有方法前置/后置条件

示例：

private void process() {
    assert state == State.READY : "状态异常";
    // ...
}

✅ 5. 用于开发和测试阶段，而不是生产逻辑

断言是：

• ✅ 调试工具
• ❌ 不是业务逻辑的一部分

生产环境通常 不启用断言

✅ 6. 提供有意义的错误信息

assert index >= 0 && index < size :
    "index=" + index + ", size=" + size;

有助于快速定位问题。

✅ 7. 不要捕获 AssertionError

try {
    assert false;
} catch (AssertionError e) {
    // ❌ 错误做法
}

AssertionError 表示严重错误，不应被捕获或恢复。

三、断言 vs 异常（重点）

四、典型使用场景总结

✅ 适合用断言：

• 私有方法前置条件
• 内部状态一致性检查
• 不可能走到的代码分支

default:
    assert false : "不可能到达的分支";

❌ 不适合用断言：

• 参数校验
• 业务规则
• 外部系统错误
• 可恢复错误

五、推荐的断言使用模板

// 前置条件
assert param != null : "param 不应为 null";

// 状态检查
assert this.state == EXPECTED : "状态异常";

// 不可能情况
assert false : "非法状态";

六、一句话总结

断言是给程序员看的，不是给用户看的；
异常处理的是“可能发生的错误”，断言处理的是“不该发生的错误”。

如果你愿意，我也可以：

• 对比 assert vs JUnit assertThat
• 讲 Spring / 生产环境如何替代断言
• 给你一份“断言使用规范”团队文档模板