C语言——assert()函数

简介

assert 是 C 标准库中提供的一个宏，用于在运行时进行条件检查，以帮助程序员捕捉程序中的逻辑错误。它在 assert.h 头文件中定义。

用法

assert 宏的基本用法是检查一个表达式，如果该表达式的值为假（0），则会打印一条错误信息并终止程序执行。它通常用于调试阶段，以确保程序在开发过程中按预期工作。

语法

#include <assert.h>

void assert(expression);

使用场景

• 参数验证：在函数中使用 assert 来验证输入参数是否满足预期条件。
• 不变量检查：在程序执行过程中检查某些条件始终为真，以捕捉逻辑错误。
• 防御性编程：用 assert 来捕捉不可预见的状态或错误，以便在调试时尽早发现问题。

禁用 assert

在发布版本中，可以通过定义 NDEBUG 来禁用 assert，这可以避免运行时开销。

#define NDEBUG
#include <assert.h>

在定义 NDEBUG 的情况下，所有的 assert 语句都不会执行。

注意事项

• 不可用于生产环境：assert 通常用于开发和测试阶段，不建议在生产环境中使用，因为它会终止程序。
• 不进行副作用操作：不要在 assert 中使用带有副作用的表达式，因为在禁用 assert 时，这些副作用不会执行。
• 确保条件：assert 用于验证程序中的假设条件，如果条件可能在正常操作中失败，不应该使用 assert。

示例

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

int main() {
    int x = 5;
    int y = 0;

    // 检查 y 是否为非零
    assert(y != 0);

    // 如果 y 为 0，上面的断言将失败，程序将终止
    int z = x / y;

    printf("Result: %d\n", z);

    return 0;
}

在上面的示例中，如果 y 为 0，assert(y != 0) 将失败，程序会打印错误信息并终止。错误信息包含文件名、行号和失败的表达式，类似于以下输出：

a.c:9: y != 0: Assertion failed.

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

void foo(int a) {
    // 验证参数 a 是否大于 0
    assert(a > 0);

    printf("a is %d\n", a);
}

int main() {
    foo(10);  // 正常
    foo(-1);  // 断言失败，程序终止

    return 0;
}

在这个示例中，foo 函数使用 assert 验证参数 a 是否大于 0。如果 a 小于等于 0，程序将打印错误信息并终止。