代码安全性和健壮性:如何在if和assert中做选择?

嵌入式ARM 2022-03-21 12:01


  • 一、前言

  • 二、assert 断言

  • 三、if VS assert

  • 五、总结

一、前言

我们在撸代码的时候,经常需要对代码的安全性进行检查,例如:

1. 指针是否为空?
2. 被除数是否为 0?
3. 函数调用的返回结果是否有效?

4. 打开一个文件是否成功?

对这一类的边界条件进行检查的手段,一般都是使用 if 或者 assert 断言,无论使用哪一个,都可以达到检查的目的。那么是否就意味着:这两者可以随便使用,想起来哪个就用哪个?

这篇小短文我们就来掰扯掰扯:在不同的场景下,到底是应该用 if,还是应该使用 assert 断言?

写这篇文章的时候,我想起了孔乙己老先生的那个问题:茴香豆的“茴”字有几种写法?

似乎我们没有必要来纠结应该怎么选择,因为都能够实现想要的功能。以前我也是这么想的,但是,现在我不这么认为

成为技术大牛、拿到更好的offer,也许就在这些细微之间就分出了胜负。

二、assert 断言

刚才,我问了下旁边的一位工作 5 年多的嵌入式开发者:if 和 assert 如何选择?他说:assert 是干什么的?!

看来,有必要先简单说一下 assert 断言。

assert() 的原型是:

void assert(int expression);

1. 如果宏的参数求值结果为非零值,则不做任何操作(no action);
2. 如果宏的参数是零值,就打印诊断消息,然后调用abort()。

例如下面的代码:

#include int my_div(int a, int b){    assert(0 != b);    return a / b;}

1. 当 b 不为 0 时,assert 断言什么都不做,程序往下执行;
2. 当 b 为 0 时,assert 断言就打印错误信息,然后终止程序;

从功能上来说,assert(0 != b); 与下面的代码等价:

if (0 == b){    fprintf(stderr, "b is zero...");    abort();}

assert 是一个宏,不是一个函数

在 assert.h 头文件中,有如下定义:

#ifdef NDEBUG    #define assert(condition) ((void)0)#else    #define assert(condition) /*implementation defined*/#endif

既然是宏定义,说明是在预处理的时候进行宏替换。(关于宏的更多内容,可以看一下这篇文章:提高代码逼格的利器:宏定义-从入门到放弃)。

从上面的定义中可以看到:

  1. 如果定义了宏 NDEBUG,那么 assert() 宏将不做什么动作,也就是相当于一条空语句:(void)0;,当在 release 阶段编译代码的时候,都会在编译选项中(Makefile)定义这个宏。
  2. 如果没有定义宏 NDEBUG,那么 assert() 宏将会把一些检查代码进行替换,我们在开发阶段执行 debug 模式编译时,一般都会屏蔽掉这 NDEBUG 这个宏。

三、if VS assert

还是以一个代码片段来描述问题,以场景化来讨论比较容易理解。

// brief: 把两个短字符串拼接成一个字符串char *my_concat(char *str1, char *str2){    int len1 = strlen(str1);    int len2 = strlen(str2);    int len3 = len1 + len2;    char *new_str = (char *)malloc(len3 + 1);    memset(new_str, 0 len3 + 1);    sprintf(new_str, "%s%s", str1, str2);    return new_str;}

如果一个开发人员写出上面的代码,一定会被领导约谈的!它存在下面这些问题:

  1. 没有对输入参数进行有效性检查;
  2. 没有对 malloc 的结果进行检查;
  3. sprintf 的效率很低;
  4. ...

1. 使用 if 语句来检查

char *my_concat(char *str1, char *str2){    if (!str1 || !str2)  // 参数错误        return NULL;            int len1 = strlen(str1);    int len2 = strlen(str2);    int len3 = len1 + len2;    char *new_str = (char *)malloc(len3 + 1);        if (!new_str)   // 申请堆空间失败        return NULL;        memset(new_str, 0 len3 + 1);    sprintf(new_str, "%s%s", str1, str2);    return new_str;}

2. 使用 assert 断言来检查

char *my_concat(char *str1, char *str2){    // 确保参数正确    assert(NULL != str1);    assert(NULL != str2);        int len1 = strlen(str1);    int len2 = strlen(str2);    int len3 = len1 + len2;    char *new_str = (char *)malloc(len3 + 1);        // 确保申请堆空间成功    assert(NULL != new_str);        memset(new_str, 0 len3 + 1);    sprintf(new_str, "%s%s", str1, str2);    return new_str;}

3. 你喜欢哪一个?

首先声明一点:以上这 2 种检查方式,在实际的代码中都很常见,从功能上来说似乎也没有什么影响。因此,没有严格的错与对之分,很多都是依赖于每个人的偏好习惯不同而已。

(1) assert 支持者

我作为 my_concat() 函数的实现者,目的是拼接字符串,那么传入的参数必须是合法有效的,调用者需要负责这件事。如果传入的参数无效,我会表示十分的惊讶!怎么办:崩溃给你看!

(2)if 支持者

我写的 my_concat() 函数十分的健壮,我就预料到调用者会乱搞,故意的传入一些无效参数,来测试我的编码水平。没事,来吧,我可以处理任何情况

这两个派别的理由似乎都很充足!那究竟该如何选择?难道真的的跟着感觉走吗?

假设我们严格按照常规的流程去开发一个项目:

1. 在开发阶段,编译选项中不定义 NDEBUG 这个宏,那么 assert 就发挥作用;
2. 项目发布时,编译选项中定义了 NDEBUG 换个宏,那么 assert 就相当于空语句;

也就是说,只有在 debug 开发阶段,用 assert 断言才能够正确的检查到参数无效。而到了 release 阶段,assert 不起作用,如果调用者传递了无效参数,那么程序只有崩溃的命运了。

这说明什么问题?是代码中存在 bug?还是代码写的不够健壮?

从我个人的理解上看,这压根就是单元测试没有写好,没有测出来参数无效的这个 case!

4. assert 的本质

assert 就是为了验证有效性,它最大作用就是:在开发阶段,让我们的程序尽可能地 crash。每一次的 crash,都意味着代码中存在着 bug,需要我们去修正。

当我们写下一个 assert 断言的时候,就说明:断言失败的这种情况是不可以的,是不被允许的。必须保证断言成功,程序才能继续往下执行。

5. if-else 的本质

if-else 语句用于逻辑处理,它是为了处理各种可能出现的情况。就是说:每一个分支都是合理的,是允许出现的,我们都要对这些分支进行处理。

6. 我喜欢的版本

char *my_concat(char *str1, char *str2){    // 参数必须有效    assert(NULL != str1);    assert(NULL != str2);        int len1 = strlen(str1);    int len2 = strlen(str2);    int len3 = len1 + len2;    char *new_str = (char *)malloc(len3 + 1);        // 申请堆空间失败的情况,是可能的,是允许出现的情况。    if (!new_str)        return NULL;        memset(new_str, 0 len3 + 1);    sprintf(new_str, "%s%s", str1, str2);    return new_str;}

对于参数而言:我认为传入的参数必须是有效的,如果出现了无效参数,说明代码中存在 bug,不允许出现这样的情况,必须解决掉。

对于资源分配结果(malloc 函数)而言:我认为资源分配失败是合理的,是有可能的,是允许出现的,而且我也对这个情况进行了处理。

当然了,并不是说对参数检查就要使用 assert,主要是根据不同的场景、语义来判断。例如下面的这个例子:

int g_state;void get_error_str(bool flag){    if (TRUE == flag)    {        g_state = 1;        assert(1 == g_state); // 确保赋值成功    }    else    {        g_state = 0;        assert(0 == g_state); // 确保赋值成功    }}

flag 参数代表不同的分支情况,而赋值给 g_state 之后,必须保证赋值结果的正确性,因此使用 assert 断言。

五、总结

这篇文章分析了 C 语言中比较晦涩、模糊的一个概念,似乎有点虚无缥缈,但是的确又需要我们停下来仔细考虑一下

如果有些场景,实在拿捏不好,我就会问自己一个问题

这种情况是否被允许出现?

不允许:就用 assert 断言,在开发阶段就尽量找出所有的错误情况;

允许:就用 if-else,说明这是一个合理的逻辑,需要进行下一步处理。


END

来源:IOT物联网小镇

版权归原作者所有,如有侵权,请联系删除。

推荐阅读
居然还有高校给大一上C语言课?
俄罗斯导弹采用了温州产电路板?
华为“天才少年”自制硬萌机器人:GitHub收获317星!

→点关注,不迷路←
嵌入式ARM 关注这个时代最火的嵌入式ARM,你想知道的都在这里。
评论 (0)
  • 前言本文主要演示基于TL3576-MiniEVM评估板HDMI OUT、DP 1.4和MIPI的多屏同显、异显方案,适用开发环境如下。Windows开发环境:Windows 7 64bit、Windows 10 64bitLinux开发环境:VMware16.2.5、Ubuntu22.04.5 64bitU-Boot:U-Boot-2017.09Kernel:Linux-6.1.115LinuxSDK:LinuxSDK-[版本号](基于rk3576_linux6.1_release_v
    Tronlong 2025-04-23 13:59 126浏览
  •   陆地边防事件紧急处置系统平台解析   北京华盛恒辉陆地边防事件紧急处置系统平台是整合监测、预警、指挥等功能的智能化综合系统,致力于增强边防安全管控能力,快速响应各类突发事件。以下从系统架构、核心功能、技术支撑、应用场景及发展趋势展开全面解读。   应用案例   目前,已有多个陆地边防事件紧急处置系统在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润陆地边防事件紧急处置系统。这些成功案例为陆地边防事件紧急处置系统的推广和应用提供了有力支持。   一、系统架构   感知层:部
    华盛恒辉l58ll334744 2025-04-23 11:22 121浏览
  •   有效样本分析决策系统平台全面解析   一、引言   北京华盛恒辉有效样本分析决策系统在当今数据驱动的时代,企业、科研机构等面临着海量数据的处理与分析挑战。有效样本分析决策系统平台应运而生,它通过对样本数据的精准分析,为决策提供有力支持,成为提升决策质量和效率的关键工具。   应用案例   目前,已有多个有效样本分析决策系统在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润有效样本分析决策系统。这些成功案例为有效样本分析决策系统的推广和应用提供了有力支持。   二、平台概述
    华盛恒辉l58ll334744 2025-04-24 11:13 69浏览
  • 故障现象一辆2016款奔驰C200L车,搭载274 920发动机,累计行驶里程约为13万km。该车组合仪表上的防侧滑故障灯、转向助力故障灯、安全气囊故障灯等偶尔异常点亮,且此时将挡位置于R挡,中控显示屏提示“后视摄像头不可用”,无法显示倒车影像。 故障诊断用故障检测仪检测,发现多个控制单元中均存储有通信类故障代码(图1),其中故障代码“U015587 与仪表盘的通信存在故障。信息缺失”出现的频次较高。 图1 存储的故障代码1而组合仪表中存储有故障代码“U006488 与用户界
    虹科Pico汽车示波器 2025-04-23 11:22 91浏览
  •   海上训练与保障调度指挥平台系统解析   北京华盛恒辉海上训练与保障调度指挥平台系统是现代海上作战训练的核心枢纽,融合信息技术、GIS、大数据及 AI 等前沿技术,旨在实现海上训练高效组织、作战保障科学决策。以下从架构功能、应用场景、系统优势及发展挑战展开解读。   应用案例   目前,已有多个海上训练与保障调度指挥平台在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润海上训练与保障调度指挥平台。这些成功案例为海上训练与保障调度指挥平台的推广和应用提供了有力支持。   一
    华盛恒辉l58ll334744 2025-04-24 15:26 48浏览
  •   电磁频谱数据综合管理平台系统解析   一、系统定义与目标   北京华盛恒辉电磁频谱数据综合管理平台融合无线传感器、软件定义电台等前沿技术,是实现无线电频谱资源全流程管理的复杂系统。其核心目标包括:优化频谱资源配置,满足多元通信需求;运用动态管理与频谱共享技术,提升资源利用效率;强化频谱安全监管,杜绝非法占用与干扰;为电子战提供频谱监测分析支持,辅助作战决策。   应用案例   目前,已有多个电磁频谱数据综合管理平台在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润电磁频谱数
    华盛恒辉l58ll334744 2025-04-23 16:27 181浏览
  •   复杂电磁环境模拟系统平台解析   一、系统概述   北京华盛恒辉复杂电磁环境模拟系统平台是用于还原真实战场或特定场景电磁环境的综合性技术平台。该平台借助软硬件协同运作,能够产生多源、多频段、多体制的电磁信号,并融合空间、时间、频谱等参数,构建高逼真度的电磁环境,为电子对抗、通信、雷达等系统的研发、测试、训练及评估工作提供重要支持。   应用案例   目前,已有多个复杂电磁环境模拟系统在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润复杂电磁环境模拟系统。这些成功案例为复杂电
    华盛恒辉l58ll334744 2025-04-23 10:29 180浏览
  • 一、技术背景与市场机遇在智能家居高速发展的今天,用户对家电设备的安全性、智能化及能效表现提出更高要求。传统取暖器因缺乏智能感知功能,存在能源浪费、安全隐患等痛点。WTL580-C01微波雷达感应模块的诞生,为取暖设备智能化升级提供了创新解决方案。该模块凭借微波雷达技术优势,在精准测距、环境适应、能耗控制等方面实现突破,成为智能取暖器领域的核心技术组件。二、核心技术原理本模块采用多普勒效应微波雷达技术,通过24GHz高频微波信号的发射-接收机制,实现毫米级动作识别和精准测距。当人体进入4-5米有效
    广州唯创电子 2025-04-23 08:41 152浏览
  • 一、行业背景与市场需求高血压作为全球发病率最高的慢性病之一,其早期监测与管理已成为公共卫生领域的重要课题。世界卫生组织数据显示,全球超13亿人受高血压困扰,且患者群体呈现年轻化趋势。传统血压计因功能单一、数据孤立等缺陷,难以满足现代健康管理的需求。在此背景下,集语音播报、蓝牙传输、电量检测于一体的智能血压计应运而生,通过技术创新实现“测量-分析-管理”全流程智能化,成为慢性病管理的核心终端设备。二、技术架构与核心功能智能血压计以电子血压测量技术为基础,融合物联网、AI算法及语音交互技术,构建起多
    广州唯创电子 2025-04-23 09:06 158浏览
  •   无人机结构仿真与部件拆解分析系统平台解析   北京华盛恒辉无人机结构仿真与部件拆解分析系统无人机技术快速发展的当下,结构仿真与部件拆解分析系统平台成为无人机研发测试的核心工具,在优化设计、提升性能、降低成本等方面发挥关键作用。以下从功能、架构、应用、优势及趋势展开解析。   应用案例   目前,已有多个无人机结构仿真与部件拆解分析系统在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润无人机结构仿真与部件拆解分析系统。这些成功案例为无人机结构仿真与部件拆解分析系统的推广和应用提
    华盛恒辉l58ll334744 2025-04-23 15:00 186浏览
  •   高海拔区域勤务与装备保障调度系统平台解析   北京华盛恒辉高海拔区域勤务与装备保障调度系统平台专为高海拔特殊地理环境打造,致力于攻克装备适应、人员健康保障、物资运输及应急响应等难题。以下从核心功能、技术特点、应用场景及发展趋势展开全面解读。   应用案例   目前,已有多个高海拔区域勤务与装备保障调度系统在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润高海拔区域勤务与装备保障调度系统。这些成功案例为高海拔区域勤务与装备保障调度系统的推广和应用提供了有力支持。   一、核心
    华盛恒辉l58ll334744 2025-04-24 10:13 66浏览
  •   陆地装备体系论证与评估综合平台系统解析   北京华盛恒辉陆地装备体系论证与评估综合平台系统是契合现代军事需求而生的专业系统,借助科学化、智能化手段,实现对陆地装备体系的全方位论证与评估,为军事决策和装备发展提供关键支撑。以下从功能、技术、应用及展望展开分析。   应用案例   目前,已有多个陆地装备体系论证与评估综合平台在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润陆地装备体系论证与评估综合平台。这些成功案例为陆地装备体系论证与评估综合平台的推广和应用提供了有力支持。
    华盛恒辉l58ll334744 2025-04-24 10:53 66浏览
  •   后勤实验仿真系统平台深度解析   北京华盛恒辉后勤实验仿真系统平台依托计算机仿真技术,是对后勤保障全流程进行模拟、分析与优化的综合性工具。通过搭建虚拟场景,模拟资源调配、物资运输等环节,为后勤决策提供数据支撑,广泛应用于军事、应急管理等领域。   应用案例   目前,已有多个后勤实验仿真系统平台在实际应用中取得了显著成效。例如,北京华盛恒辉和北京五木恒润后勤实验仿真系统平台。这些成功案例为后勤实验仿真系统平台的推广和应用提供了有力支持。   一、核心功能   (一)后勤资源模拟
    华盛恒辉l58ll334744 2025-04-23 15:39 152浏览
我要评论
0
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦