断言

前置知识

在阅读本章前，你需要了解：基础的 Java 语法、异常处理机制和基本的调试概念。

为什么需要断言？

程序员的日常工作中，经常要验证程序某处的逻辑是否成立。比如你写了一个方法，希望输入的数据符合某些前提条件，否则结果可能是错的。你可能会写很多if-else判断来报错或者抛异常，但这样不仅代码臃肿，有时也不方便关闭验证逻辑，让程序在生产环境更高效运行。

这里，Java 的断言（assert）就像一个“哨兵”，帮我们在开发和测试阶段确认程序状态是否符合预期。一旦断言失败，程序会马上抛出错误提醒你“有人不按铁则来！”但当正式发布时，你还能选择关闭断言，让代码跑得更快。

让我们来看看如何用 Java 的断言，既保持代码整洁，又能提高开发效率。

断言基础

• 什么是断言？
  断言就是程序运行时自检的“信念表”。它帮你判定某个条件是否成立，若不成立，就抛出错误（AssertionError）。

• 为什么需要断言？
  它是一种开发时调试辅助：提醒我们“这里的逻辑按预期走没错”，通过自动检测防止潜在的问题。这比写大量 if 语句简单又安全。

• 如何写一个简单的断言？
  关键字是 assert，语法简单：

  assert 条件表达式 : 错误信息;

  如果条件为 false，抛出 AssertionError，附带错误信息。

代码示例 1：最简单的断言用法

public class SimpleAssertionDemo {
    public static void main(String[] args) {
        int number = 10;

        // 断言number应该是正数
        assert number > 0 : "number 必须是正数";

        System.out.println("断言通过，number是：" + number);
    }
}

这段代码做了什么：
当执行到断言时，它会检查 number > 0 条件。如果为 true，程序正常继续；若 false，抛 AssertionError 并输出信息 "number 必须是正数"。

注意：如果你直接运行这段代码，默认情况下断言是不启用的，断言判断会被忽略。要激活断言，需要用 -ea （enable assertions）参数启动 Java。

---

启用和禁用断言

默认情况下，Java 是关闭断言的。这意味着 assert 语句不会执行，程序会忽略它。这是为什么呢？因为断言设计用来辅助开发和测试，而不是替代正常的错误处理。

启用断言的两种方式

• 针对所有类启用断言
  启动程序时加参数：

  java -ea SimpleAssertionDemo

• 针对指定包或类启用断言
  只启用某几个类的断言，比如包 com.example

  java -ea:com.example... MyApp

• 禁用断言
  即使已启用，也可以用 -da 禁用：

  java -da MyApp

---

代码示例 2：复杂点的断言应用

假设你有一个方法计算数组中所有元素的平均值，你想确保数组不为空，并且所有值都合理。

import java.util.Arrays;

public class AverageCalculator {
    public static double calculateAverage(int[] numbers) {
        // 断言数组不为空
        assert numbers != null : "输入数组不能为null";

        // 断言数组长度大于0
        assert numbers.length > 0 : "数组不能为空";

        int sum = 0;

        for (int number : numbers) {
            // 断言各元素不能为负数
            assert number >= 0 : "数组元素不能为负数，发现了: " + number;
            sum += number;
        }

        return (double) sum / numbers.length;
    }

    public static void main(String[] args) {
        int[] data = {10, 20, 30};
        System.out.println("平均值是：" + calculateAverage(data));
    }
}

这段代码做了什么：

1. 断言传入数组不为空，避免空指针异常。
2. 断言数组长度不为0，确保计算有意义。
3. 断言数组元素不能是负数，符合业务逻辑约束。

借助断言，我们在开发阶段就能快速发现异常情况，防止不合理输入破坏计算过程。

---

断言的使用场景

断言最适合用于内部逻辑的自检，比如：

• 方法的前置条件（输入参数约束）
• 程序状态不变式（状态变量必须满足某些条件）
• 资源初始化后的验证
• 开发调试阶段排查逻辑错误

不建议使用断言来替代正常的异常处理，例如用户输入校验或外部错误应使用异常机制处理。

---

常见陷阱

⚠️ 常见陷阱

• 误以为断言是异常处理
  断言主要为调试设计，默认被禁用，不可靠用于运行时错误检测。别用它来处理用户输入或文件读取等业务异常。

• 忘记启用断言
  代码中写了断言没错，但如果启动时没用 -ea，断言代码不会被执行，无法帮助发现问题。

• 断言副作用大
  断言内的代码不应修改程序状态。由于断言可能不执行，断言中有重要状态变化可能导致不同环境行为不一致。

• 过度使用断言
  不要给所有条件都加断言，重点验证关键假设，避免代码可读性降低。

---

进阶特性：断言表达式与消息

断言允许两个形式的写法：

1. 只有条件：

assert x > 0;

2. 条件 + 失败时反馈信息：

assert x > 0 : "变量x必须大于0，当前值为：" + x;

后者方便定位问题，但要注意生成的提示字符串代码要简单，不要做太复杂的计算，避免无谓性能开销。

---

代码示例 3：利用断言保证状态不变式

下面这个示例展示如何用断言检查一个简单的栈（stack）类，在关键操作后保持栈的内部状态一致。

public class SimpleStack {
    private int[] elements;
    private int size;

    public SimpleStack(int capacity) {
        elements = new int[capacity];
        size = 0;
    }

    public void push(int element) {
        // 断言栈未满
        assert size < elements.length : "栈已满，无法再添加元素";

        elements[size++] = element;

        // 断言：添加元素后，栈大小应不超过容量
        assert size <= elements.length : "栈大小异常: " + size;
    }

    public int pop() {
        // 断言栈不为空
        assert size > 0 : "栈为空，无法弹出元素";

        int top = elements[--size];

        // 断言：弹出元素后，size不能为负
        assert size >= 0 : "栈大小异常: " + size;

        return top;
    }

    public int size() {
        return size;
    }

    public static void main(String[] args) {
        SimpleStack stack = new SimpleStack(3);

        stack.push(1);
        stack.push(2);

        System.out.println("弹出元素：" + stack.pop());
        System.out.println("当前栈大小：" + stack.size());
    }
}

这段代码做了什么：

• 在 push 和 pop 方法关键点加断言，维护栈不溢出、不空栈
• 通过断言保证 size 不超界或不越界，维持栈不变式

这种做法有助于捕获程序内部状态错误，避免隐藏的逻辑缺陷。

---

对比总结

方案	什么时机用	优缺点
断言（assert）	开发/测试时调试辅助	简洁，方便定位问题，默认关闭，无运行性能损失
传统异常	运行时错误处理	稳定可靠，必须写，代码较繁琐
日志 + 条件判断	记录运行时状态	无法直接阻止异常，辅助问题排查

断言更多用来“内部自检”，异常捕获用户层面和业务异常。

---

实战建议

💡 实战建议

• 启用断言的同时，规范代码覆盖测试，断言能快速捕获隐患，但测试保证逻辑正确。
• 断言用于验证方法内部关键假设或约束，但不要依赖断言进行业务流程控制。
• 生产环境关闭断言以提升性能，但务必确保代码足够健壮，无依赖断言保护。
• 养成检查断言是否开启的习惯，避免“断言谜题”让你排查问题越陷越深。
• 使用清晰的断言信息，方便快速定位失败点。
• 避免在断言中有副作用代码，确保无论断言开关如何，程序逻辑一致。

---

延伸思考

• 你会在什么情况下选择用断言而不是异常？试着找找你的项目代码中适合改为断言的写法。
• 怎样设计断言信息可以帮助团队成员更有效地调试和排错？
• 断言关闭后程序仍正常运行，这会带来哪些潜在风险？有没有办法缓解？

---

小结

• 断言（assert）是 Java 提供的开发调试辅助工具，用来确认程序状态假设。
• 断言默认关闭，需用 -ea 参数启动才能生效。
• 适合用于检查开发阶段的前置条件、不变式等，不代替异常处理。
• 断言使用简洁，但不得包含会改变程序状态的副作用代码。
• 养成正确启用和使用断言的习惯，可以大幅提高代码质量和调试效率。