[导读] 大家好，我是逸珺。

今天来分享整理如何正确的使用断言。

何为断言

断言一般是用于检测在某个程序位置程序必须满足某些条件的宏。一般用的多的可以分两种种情况：

• 前置条件：在某个程度点开始的地方

• 后置条件：在某段程序执行结束后，一般用于检测执行结果

断言发生表示程序中存在错误。因此，断言是提高程序可靠性的有效手段。也是开发阶段快速定位问题的一种很好防御式编程方法。

在C语言中，断言是一些条件判断的宏。比如C语言内置断言是用标准的 assert 宏实现的。当宏执行时，assert 的参数必须为真，否则程序中止并打印错误消息。

比如，在IAR中：

#define assert(test) ((test) ? (void) 0 : abort())
也可以编程者自己定义，比如：

#define assert(arg) { if( !(arg) ) { printf("assert in File="__FILE__" Line=%d ",__LINE__); return; } }


该怎么用

前置条件

比如某一个函数代码：

#define ALLOWED_SIZE  (1024)
int func(int size, char *buffer ) 
{
  assert( size <= ALLOWED_SIZE );
  assert( format != NULL );
  ...
}
这个函数里，使用了两次断言判断函数执行的前置条件：

• size必须要不大于ALLOWED_SIZE，func函数才真正执行其任务。因此，如果输入的size超过1024，func不会做任何处理。
• buffer传入的地址必须不是NULL，否则func函数不会执行。

具体断言判断失败了，断言宏干了什么，需要看看这个宏的实现，有可能是直接返回，有可能整个程序直接终止执行。所以看看其实现就知道了。

后置条件

后置条件断言一般是指判断函数的执行结果。比如：

int func(int size, char *buffer ) 
{
 int result;
 
 /*中间处理部分更新这个返回值*/
  ...
  
  assert( result <= ALLOWED_SIZE );
  return result;
}
这样写表示这个函数的返回值永远不会大于ALLOWED_SIZE。如果大于了，就证明产生错误了。

什么时候用

断言的最常用和最有效的用途是检查前置条件——即指定和检查函数的输入条件。两个非常常见的用途：

• 指针不是 NULL。
• 索引和边界范围值是在设计的合理范围之类。

尤其如果写一个代码包给其他的人调用的时候，这样处理会使代码提高健壮性，易用性。

当代码调用带有前置条件的断言时，必须要确保满足该函数的前置条件。但这并不意味着必须断言检查调用的每个函数的参数！

调试的便利：

• 如果在程序测试和调试期间违反了前置条件，也就是说断言异常了，则调用包含前置条件的函数的代码中存在bug。

• 如果在程序测试和调试期间违反了后置条件，则该断言前面部分代码可能有bug。

这样利用断言的打印，或者检测到断言指定的行为，就可以很快速的发现bug，而避免要在后期反复测试才能识别出bug。

那么什么时候用？首先，区分程序错误和运行时错误很重要：

• 程序错误是一个bug，永远不应该发生。
• 运行时错误可能在程序执行期间的任何时间发生。

断言不是处理运行时错误的机制。例如，由于用户在预期为正数时无意中输入了负数而导致的断言异常就是程序设计不合理。像这样的情况必须通过适当的错误检查和恢复代码（比如弹出一个提示输入合理范围）来处理，而不是通过断言来处置。

当然，实际是程序都可能会有bug，这些bug会在运行时出现。确切地说，断言要检查什么条件以及运行时错误检查代码要检查什么是设计问题。

如前所说，断言在可重用库中非常有效。比如在QT中：

int main(int argc, char *argv[])
{
    QVector <int> list;
    list.append(0);
    list.append(1);
    qDebug() << list.at(2);
    
    return 0;
}
一运行，就会有这样的结果：

ASSERT failure in QVector::at: "index out of range", file C:\Qt\Qt5.7.1\5.7\mingw53_32\include/QtCore/qvector.h, line 429
assert in File=..\src\main.cpp Line=4
因为list只有两个元素，list.at(2)则是去访问第3个，显然访问的元素不存在，所以就断言了。

—— The End ——