首页 > 编程笔记

C语言assert()：断言程序中的错误

断言是一种检查程序在某个特定点上是否符合预期的方法。如果某个条件不满足，则断言会生成一个错误，通常伴随着程序的终止。

C语言的 assert() 就是一个用于实现断言的强有力工具。很多初学者将 assert() 误认为是一个函数，它本质是一个宏，定义在<assert.h>头文件中。

assert() 用于检查程序中的某个条件（表达式）是否成立，如果成立，程序继续运行；如果不成立，程序将打印一条错误消息并中止执行。

不同的编译环境下，assert() 打印的错误消息可能不一样，但至少包括断言失败的表达式、失败发生的行号以及源文件名称。

assert() 的基本用法如下：

assert(expression);

expression 就是要检测的表达式，如果表达式为假（即值为 0），则程序会打印一条错误消息并调用 abort() 终止执行。

以下是一个简单的示例，演示了 assert() 的用法。
#include <assert.h>
#include <stdio.h>

int main() {
  int x = 10;
  printf("Before the assert\n");
  assert(x == 10);
  printf("After the assert\n");

  printf("Before the failing assert\n");
  assert(x == 5); // 这将失败，因为x不等于5
  printf("After the failing assert\n"); // 这行代码永远不会执行

  return 0;
}
在这个示例中，第一个 assert() 调用成功，因为表达式x==10成立。第二个 assert() 调用会失败，因为表达式x==5不成立，所以程序会打印错误消息并中止执行。

assert()实际应用场景

上面的例子主要是给读取演示 assert() 的基本用法。在实际开发中，assert() 的常见应用场景有以下几种：

1) 验证函数的先决条件

在开发中，经常有一些明确的先决条件，比如函数需要一个非空指针。使用 assert() 确保这些条件得到满足可以在开发和测试阶段快速捕获问题。 
void processArray(int* array, size_t size) {
  assert(array != NULL); // 断言数组不为空
  // ...
}

2) 检查算法的不变性

算法中有时有一些不变性，即某些条件始终为真。例如，某个值始终应该是正的，某个指针不应为空等。assert() 可以用来在开发时捕捉这些不变性的违反。 
for(int i = 0; i < n; i++) {
  // ...
  assert(x > 0); // x应始终大于0
}

3) 用于单元测试

虽然不是最常用的单元测试方法，但 assert() 可以用于基本的单元测试，验证函数的输出和预期一致。 
void testAddition() {
  assert(add(3, 4) == 7);
}

4) 验证后置条件

与先决条件类似，函数有时还有一些明确的后置条件，如返回值始终在特定范围内等。assert() 可以用于验证这些后置条件。

禁用assert()

assert() 旨在帮助程序员找到程序中的错误，而不是处理用户错误或者可预期的运行时错误。通常情况下，程序调试完成之后会禁用所有的 assert()。

发布程序时禁用 assert() 的原因是多方面的，比如：
在 C语言中，可以通过定义宏 NDEBUG 来禁用 assert()：

1) 在源代码中禁用

在包含<assert.h>之前定义 NDEBUG 宏，就可以禁用所有的 assert()： 
#define NDEBUG
#include <assert.h>

2) 在编译时禁用

在编译命令行中定义 NDEBUG 宏。例如，使用 GCC 编译器时：

gcc -DNDEBUG myfile.c

总结

断言是 C语言中一个强大的调试工具，允许开发人员确保程序中的某些条件一定为真。通过灵活地使用 assert()，你可以更容易地识别潜在的问题，并在早期阶段捕获它们，从而提高代码质量和可靠性。

注意，断言主要用于开发和调试阶段，帮助我们及时捕获程序中隐藏的 bug，它不能代替生产环境中的错误处理机制。在生产环境中，我们应该实施健壮的错误检测和处理策略，以确保软件的稳定和可靠运行。

推荐阅读