【C语言】assert.h——断言

文章目录

断言是一种用于在程序执行过程中进行调试的工具，能够帮助开发者验证程序的某些假设是否为真。如果断言失败，程序会终止，并输出一个错误消息，通常包含出错的文件名和行号。这对于调试和测试非常有帮助。

主要内容

assert是一个宏，并不是函数。assert 宏接受一个表达式作为参数，如果该表达式的值为假（0），它会：

打印一条错误信息，指出断言失败的表达式，以及出错的文件名和行号。
调用 abort 函数终止程序执行。

具体的实现可以简单概括如下：

c 复制代码

#define assert(expression) ((expression) ? (void)0 : __assert_fail(#expression, __FILE__, __LINE__))

void __assert_fail(const char *expr, const char *file, int line) {
    fprintf(stderr, "Assertion failed: (%s), file %s, line %d.\\n", expr, file, line);
    abort();
}
/*
    助于理解 assert 功能
*/

调试和发布模式

在调试模式下，断言可以帮助捕捉程序中的错误。而在发布模式下，通常会禁用断言，以提高程序性能。可以通过定义 NDEBUG 宏来禁用断言：

c 复制代码

#define NDEBUG    // 使用时一定要在包含assert库函数前定义
#include <assert.h>

一旦定义了 NDEBUG，assert 宏将被定义为空操作，不会进行任何检查或中断程序：

c 复制代码

#ifdef NDEBUG
#define assert(expression) ((void)0)
#else
#define assert(expression) ((expression) ? (void)0 : __assert_fail(#expression, __FILE__, __LINE__))
#endif

使用示例

c 复制代码

#include <stdio.h>
#include <assert.h>

int main() {
    int x = 5;
    assert(x == 5);  // 断言成功，不会中断程序
    printf("x is 5\n");

    x = 3;
    assert(x == 5);  // 断言失败，程序终止
    printf("This line will not be executed.\n");

    return 0;
}

/*
    在这个示例中，第一次断言 x == 5 是成功的，程序继续执行并输出 "x is 5"。第二次断言 x == 5 失败，程序会终止并输出错误信息。
*/

用法总结与注意事项

每个assert只检验一个条件：同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败
有的地方,assert不能代替条件过滤
只用于调试：断言主要用于调试阶段，确保代码逻辑的正确性。在发布版本中，通常会禁用断言，因此不要依赖断言来处理运行时错误或进行关键性检查。

不要在断言中有副作用：断言表达式中不应包含会改变程序状态的操作。

c 复制代码

// 错误示例
assert(free(ptr) == 0);  // 这样写会导致发布版本中 free 函数不执行

/* 例如，不要在断言中进行函数调用或修改变量的操作，因为在发布版本中这些操作可能不会执行。 */

条件表达式要简单明确：断言的条件表达式应简单明了，确保容易理解和调试。复杂的表达式可能会导致调试困难。
不要在生产代码中依赖断言 ：断言不应替代常规的错误处理机制。对于需要在生产环境中处理的错误，应使用适当的错误处理代码（如 if 语句和错误码）。
正确使用 NDEBUG 宏 ：在发布版本中，通过定义 NDEBUG 宏来禁用断言。这可以在编译选项中定义，或在源代码中定义：
c 复制代码
```
#define NDEBUG
#include <assert.h>
```
避免在性能关键的代码中使用断言：虽然断言在调试阶段很有帮助，但在性能关键的代码路径中使用断言可能会影响调试阶段的性能。可以在调试阶段临时移除或减少这些断言，以进行性能测试。
保证断言条件的重要性：断言条件应当是真正的重要检查，而不是无关紧要的小检查。这些条件应反映代码的关键假设或不变量。
文档化断言：在复杂或关键的代码中，记录断言的目的和含义，帮助其他开发者理解断言的意图和背景。