C++之assert推荐用法及注意事项_开发_开发者

1.引言

assert在 <assert.h> 头文件编程客栈中定义，其作用是如果它的提交呢返回错误，则终止执行。

原型定义：

    #include <assert.h>
    void assert(int expression);

assert的作用是先计算表达式expression,如果其ShROjv值为假(即为0)，那么它向stderr打印一条错误信息，然后通过调佣abort来终止程序运行。

通常，它用于检查在程序执行过程中应始终为真的条件。即当违反真理时, 触发断言. 比如1+1=2，当1+1≠2时触发断言。比如，

    assert(false); // 中断程序；
    assert(0 && "the code is error!"); // 中断并打印信息

2.简单示例

#include <assert.h> // header

int divide(int numerator, int denominator) {
    assert(denominator != 0); // 确保分母不为零
    return numerator / denominator;
}

int main() {
    int result = divide(10, 2);
    // ...
    return 0;
}

在上面的示例中，assert 宏确保分母永远不为零。如果分母为零，程序将以指示文件名、行号和失败的表达式的错误消息终止。

3.推荐使用方法

经常在C++程序中，以便于在开发过程中进行断言检查，而在发布版本中则禁用这些检查。

推荐写成如下方式，编写一个assert_utils.h文件，内容如下：

#pragma once

#ifndef RELEASE
#include <cassert>
#define ASSERT(f) assert(f) 
#else
#define ASSERT(f) ((void)0)
#endif

下面是对这段代码的解释：

1) #pandroidragma once：这是一个预处理指令，用于确保头文件只被包含一次。它的效果取决于编译器，但大多数现代编译器都支持它。

2) #ifndef RELEASE：这是一个预处理指令，用于检查是否定义了RELEASE宏。如果没有定义，编译器将继续执行下面的代码块。

3) #include <cassert>：如果RELEASE宏没有定义，编译器将包含cassert头文件，这是标准C++库的一部分，提供了assert宏。

4) #define ASSERT(f) assert(f)：定义了一个宏ASSERT，它接受一个表达式f作为参数。当ASSERT被调用时，它将执行assert(f)，如果f为假（即表达式结果为0），程序将终止运行，并显示一个断言失败的消息。

5) #else：如果RELEASE宏被定义，编译器将跳过上面的代码块，执行下面的代码。

6) #define ASSERT(f) ((void)0)：在发布版本中，ASSERT宏被定义为一个空操作，即什么都不做。这样，在发布版本的程序中，所有ASSERT调用都不会执行任何操作，从而避免了性能损耗和潜在的程序中断。

7) #endif：结束#ifndef RELEASE条件编译块。

4.常见使用场景和注意事项

4.1.检查参数的合法性

示例如下：

int  sendData(const char* pData, int len)
{
    //[1] 校验参数的合法性
    assert(pData);
    assert(len > 0)

    //[2]
    //...
}

每个assert只检验一个条件，因为同时检验多个条件时，如果断言失败，无法直观的判断是哪个条件失败，如：

assert(pData && len > 0);  //这样不好

4.2.assert不能使用改变环境的语句

因为assert只在DEBUG环境中生效，如果这么做，会导致DEBUG和RELEASE的逻辑不一致。如：

assert(i++ <python; 100);

在DEUG环境下，每次都会执行i++，而在RELEASE环境中不会执行i++，这样就会导致两种环境下的执行结果不一样，正确的写法是：

assert(i < 100);
i++;

4.3.在未知的逻辑中添加assert(false)

如：

//根据业务类型处理业务
void  dealPro(int type)
{
    if (type == 0){
        // 文本业务
    }else if (type == 1){
        // 地图业务
    }else if (type == 2){
        // 测试业务
    }else{
        assert(false);
    }
}

上述代码，我们的业务逻辑只涉及到文本、地图、测试业务，其它的都是非法业务，添加assert(false)，一旦type不等与1、2、3，就会出现断言错误，查看程序堆栈，这样就非常快速的定位程序是哪个地方出现逻辑错误了，这个也是一个非常好的调试技巧。