单片机技术网|技术阅读
登录|注册

您现在的位置是:单片机技术网 > 技术阅读 > 嵌入式开发打印,我放弃了printf

嵌入式开发打印,我放弃了printf


2、正文部分


对于printf相信不用我过多介绍,它算是初学C语言时用得最多的信息输出接口函数了,对于玩MCU、Linux等嵌入式的朋友,基本上都会用其进行串口日志打印。printf是将字符串到标准输出stdout,比如标准输出是屏幕、串口终端等等,由于用户需求不一样都会进行输出的重定向,从而打印信息到想要的输出设备上。而今天的主角sprintf是字符串格式化命令,与printf相比我觉得其更多的是一个转换函数,类似于大写转化为小写。sprintf可以按照用户定义的格式转为对应的字符串并填充到缓冲buff中。所以printf其实相当于" sprintf+把字符串输出到标准输出 ",有些平台printf函数其实就是这两种的封装。因此printf的重定向就可以认为仅仅只是改变了标准的输出接口。不知曾几何时,接触到了sprintf以后,在实际的项目中就很少再去使用printf,因为sprintf的强大完全可以替代printf,并且在有些应用中显得非常灵活。

1

体验sprintf 


首先了解一下sprintf :Fuction :int sprintf(char *string, char *format [,argument,...]);Param1 : 最终格式化字符串所存储的buff。Param2 : 可变参数,类似于printf中的”%d”格式。return最终打印到字符缓冲区中的字符数目,结束字符‘\0’不计入内。
参考示例:#include <stdio.h>

char strBuff[40] ={'\n'};

/********************************************
 * Fuction : UartString
 * Descri  : 进行sprintfDemo演示 
 * Author  : bug菌 
 *******************************************/
 
void UartString(char * strBuff) 
{   //模拟串口输出 
 printf("%s\r\n",strBuff);
}

/********************************************
 * Fuction : main
 * Descri  : 进行sprintfDemo演示 
 * Author  : bug菌 
 *******************************************/
 
int main(void)
{
 int strIndex = 0;
  
 //打印整形 
 sprintf(strBuff,"bugNum = %d",1000);
 UartString(strBuff); 
 
 //打印浮点 
 sprintf(strBuff,"PI = %.4f",3.1415926);
 UartString(strBuff); 
 
 //打印地址
 sprintf(strBuff,"address = %p",&strIndex);
 UartString(strBuff); 
 
 //字符串拼接
 strIndex = sprintf(strBuff,"PI = %.4f",3.1415926);
  strIndex = sprintf(strBuff+strIndex,"926");
 UartString(strBuff); 
 
  //简单输出
  strIndex = sprintf(strBuff,"欢迎大家关注公众号:最后一个bug");
  UartString(strBuff); 
  return 0;
}

结果输出:

说明一下:

从上面的演示了解到printf与sprintf仅仅只是其前面增加了一个buff缓冲,其可变参数格式部分用法与printf几乎相同。

而且通过利用sprintf返回值还可以方便、灵活的进行多个字符串的拼接, 相比strcat进行两个字符串拼接确实要方便多了。


2

sprintf注意事项 


1

buff溢出 


sprintf最大的问题是容易缓存区溢出,一旦可变部分所拼接的字符串长度超过buff的大小,便会造成数据溢出,从而危及程序运行。特别是在进行浮点操作的时候尤为要注意,比如把上面的Demo浮点数打印不进行格式处理。

 //打印浮点 
 //sprintf(strBuff,"PI = %.4f",3.14);
 sprintf(strBuff,"PI = %f",3.14);
 UartString(strBuff); 


相比预期的输3.14 后面增加了0000,如果strbuff定义的过小就会导致数据溢出。

2

snprintf 


由于使用sprintf开发者容易导致缓冲区溢出,然而这样的bug有时候隐藏得比较深,导致难以排查,所以就有了一个安全性稍微高一点的snprintf函数,该函数在sprintf函数的基础上增加了一个缓冲区长度的参数,通过该参数函数内部用来避免sprintf()存在的溢出风险。


Fuction :int snprintf(char *str, size_t size, const char *format, ...);

Param1 最终格式化字符串所存储的buff。

Param2 buff缓存区的长度。

Param3 : 可变参数,类似于printf中的”%d”格式。

return : 若成功则返回预写入的字符串长度,若出错则返回负数。


参考示例:#include <stdio.h>

#define BUFF_SIZE 11
char strBuff[BUFF_SIZE] ={'\n'};

/********************************************
 * Fuction : UartString
 * Descri  : 进行sprintfDemo演示 
 * Author  : bug菌 
 *******************************************/
 
void UartString(char * strBuff) 
{   //模拟串口输出 
 printf("%s\r\n",strBuff);
}

/********************************************
 * Fuction : main
 * Descri  : 进行snprintfDemo演示 
 * Author  : bug菌 
 *******************************************/
 
int main(void)
{
 int strIndex = 0;
  
    //打印浮点 
 printf("return :%d\n",snprintf(strBuff,BUFF_SIZE,"PI = %f\r\n",3.14)) ;
 UartString(strBuff); 
 
 return 0;
}

输出结果:

说明一下:
注意一点snprintf返回的是预写字符串长度,而非最终写入到strbuff中的字符个数,当然当缓存区足够的时候预写长度=最终写入到strbuff中的字符串长度。

3

简化版snprintf 


 一个功能全面的printf、sprintf、snprintf等等都会有较大的代码量,同样标准C库的也是一样的,对于一些资源比较紧张的MCU等可能一个标准函数就占用了一大半的Flash等ROM区,一个库函数实现比主体代码还耗资源,这样在嵌入式中是不应该的。

然而,对于这些printf函数其实我们并不需要其全部的功能,可能只需要个打印整形、浮点等数据即可满足需求,其他格式的代码实现完全可以去除,从而可以大大缩减其占用的ROM资源,所以就有了精简版的snprintf,对于snprintf可以在标准库源码上进行相关功能的删减即可,bug菌在这里就不过多介绍了,网络上资源也一大把。


3、结束语


今天的知识就跟大家分享到这里,sprintf还有很多巧妙的格式等你去挖掘,相信这是一段美妙的学习之旅!
原文来源于: 最后一个bug,已获得转载权限,版权归原作者或平台所有,仅供学习参考与学术研究,如有侵权,麻烦联系删除~感谢

   最     后   

小哥搜集了一些嵌入式学习资料,公众号内回复【1024】即可找到下载链接!

推荐好文  点击蓝色字体即可跳转

 ☞ ☞ 
☞ ☞ ☞ ☞ 

☞   

☞   

☞  经验分享