java Assert断言怎样写才规范

在 Java 中，assert 是一种调试期断言机制，用得好可以尽早暴露问题，但用得不规范也容易造成误解或生产问题。下面从语法、使用场景、规范写法、常见坑几个方面说明。

一、Java 断言的基本语法

assert condition;

或带错误信息：

assert condition : "错误信息";

示例：

assert list != null;
assert age > 0 : "age must be positive, but was " + age;

⚠️ 注意：
Java 的 assert 默认是关闭的，必须在运行时开启：

java -ea MyApp
# 或
java -enableassertions MyApp

关闭则用：

java -da MyApp

二、Assert 的正确使用场景（规范核心）

✅ 适合用 assert 的情况

1. 内部不变量（Invariants）

assert x >= 0 && x < size;

2. 方法前置条件（仅限 private / 内部方法）

private void process(int index) {
    assert index >= 0 && index < data.length;
}

3. 方法后置条件

Result r = compute();
assert r != null;

4. “不可能发生”的逻辑

default:
    assert false : "unreachable code";

❌ 不适合用 assert 的情况（非常重要）

1. 不要用 assert 做参数校验（public 方法）

// 错误示例
public void setAge(int age) {
    assert age > 0;
}

✅ 正确做法：

public void setAge(int age) {
    if (age <= 0) {
        throw new IllegalArgumentException("age must be > 0");
    }
}

原因：assert 可能被关闭，参数校验必须始终生效。

2. 不要用 assert 替代异常处理

// 错误
assert file.exists();

3. 不要在 assert 中写有副作用的代码

// 错误
assert list.add(item);

三、规范写法总结（推荐标准）

✅ 推荐的 assert 写法模板

assert condition : "描述信息 + 关键变量";

示例：

assert objects != null : "objects should not be null here";
assert count >= 0 : "count = " + count;

四、与 JUnit / 测试框架的区别

五、实际开发建议

✅ 规范建议

• assert 只用于“开发期帮助发现问题”
• public API 一律用异常
• 不依赖 assert 保证程序正确性
• 错误信息要可定位

✅ 一句话总结

Assert 是给程序员看的，不是给用户看的；是调试工具，不是业务防护。

如果你愿意，我也可以帮你写一个**“assert vs 异常”对照示例或代码评审清单**。