C语言 assert

assert 是 C 语言标准库 <assert.h> 中提供的诊断宏 ，用于在开发阶段捕获"不应该发生"的逻辑错误。它的核心设计理念是：如果断言失败，说明程序存在 Bug，应立即终止并报告位置。

1. 基本用法

#include <assert.h>

void process(int *data, int len) {
    assert(data != NULL);      // 指针不能为空
    assert(len > 0);           // 长度必须为正
    assert(len <= MAX_SIZE);   // 长度不能超过上限
    
    // 正常业务逻辑...
}

当断言条件为 false（0） 时，程序会：

1. 向 stderr 输出错误信息（包含表达式、文件名、行号）
2. 调用 abort() 终止程序

输出示例：

Assertion failed: (len > 0), function process, file main.c, line 42.
Abort trap: 6

2. ⚠️ 黄金法则：断言不是运行时检查

这是使用 assert 最重要的原则：

✅ 应该用 assert	❌ 绝不能用 assert
函数前置条件（参数合法性）	用户输入验证
内部不变量（数据结构一致性）	文件打开/网络请求等外部操作结果
算法中间状态的正确性	内存分配失败（malloc返回NULL）
"理论上不可能到达"的代码路径	任何在生产环境中需要处理的错误
开发阶段的文档化约束	可恢复的错误

原因 ：assert 在定义 NDEBUG 宏后会被完全移除，不产生任何代码。如果你用它检查了必须处理的错误，发布版本中该检查将消失，导致未定义行为。

// ❌ 致命错误！发布版中 fopen 的结果不会被检查
assert((fp = fopen("config.txt", "r")) != NULL);

// ✅ 正确做法
fp = fopen("config.txt", "r");
if (fp == NULL) {
    perror("fopen");
    return ERROR_CODE;
}
// 如果后续逻辑依赖 fp 非空作为内部不变量，可以加断言
assert(fp != NULL);  // 仅用于确认上面的错误处理没有遗漏

3. NDEBUG 宏：控制断言的开关

// 调试构建（默认）：断言生效
gcc -g -O0 main.c -o debug_app

// 发布构建：断言被完全移除
gcc -DNDEBUG -O2 main.c -o release_app

💡 注意 ：NDEBUG 影响的是预处理阶段，不是运行时。一旦编译完成，断言的行为就固定了。

4. C23 增强：带消息的断言

C23 标准引入了带自定义消息的断言语法（部分编译器已支持）：

// C23 新语法
static_assert(sizeof(int) >= 4, "int must be at least 32 bits");

// 传统方式（所有C标准兼容）
#define ASSERT_MSG(cond, msg) \
    do { if (!(cond)) { fprintf(stderr, "ASSERT FAILED: %s (%s:%d): %s\n", \
        #cond, __FILE__, __LINE__, msg); abort(); } } while(0)

5. 静态断言：_Static_assert / static_assert

与运行时 assert 不同，静态断言在编译期求值，零开销：

#include <assert.h>

// C11 原生语法
_Static_assert(sizeof(void*) == 8, "This code requires 64-bit pointers");

// C23 / C11+<assert.h> 可用更简洁的形式
static_assert(CHAR_BIT == 8, "Non-8-bit chars not supported");

适用场景：结构体大小/对齐检查、平台兼容性验证、模板/泛型编程中的类型约束。

6. 常见陷阱与最佳实践

避免副作用

// ❌ 危险！NDEBUG 下 x++ 不会执行
assert(x++ > 0);

// ✅ 安全
assert(x > 0);
x++;

不要断言常量表达式

// ❌ 无意义，应该用 static_assert
assert(sizeof(int) == 4);

// ✅
static_assert(sizeof(int) == 4, "Requires 32-bit int");

复杂条件的可读性

// ❌ 失败时看不出哪个子条件出了问题
assert(ptr && len > 0 && len <= MAX && aligned(ptr, 16));

// ✅ 拆分为多个断言，精确定位
assert(ptr != NULL);
assert(len > 0);
assert(len <= MAX_SIZE);
assert(((uintptr_t)ptr & 15) == 0);

自定义断言框架（生产级项目推荐）

对于大型项目，建议封装自己的断言宏，支持日志记录、堆栈追踪、分级处理等：

#ifdef DEBUG_BUILD
#define MY_ASSERT(cond) do { \
    if (!(cond)) { \
        log_error("Assertion failed: %s at %s:%d", #cond, __FILE__, __LINE__); \
        dump_stack_trace(); \
        abort(); \
    } \
} while(0)
#else
#define MY_ASSERT(cond) ((void)0)
#endif

📌 总结

维度	要点
本质	开发期诊断工具，不是错误处理机制
启用/禁用	通过 -DNDEBUG 在编译时控制
核心原则	只断言"Bugs"，不断言"Errors"
安全性	断言表达式绝不能有副作用
编译期检查	用 static_assert 替代运行时断言常量
生产环境	考虑封装自定义断言框架，保留关键诊断能力

assert 的价值不在于"防止崩溃"，而在于让 Bug 在最接近根因的位置以最明确的方式暴露出来。正确使用它，能让调试时间从数小时缩短到数秒。