snprintf和sprintf区别分析

今天在项目中使用snprintf时遇到一个比较迷惑的问题，追根溯源了一下，在此对sprintf和snprintf进行一下对比分析。

因为sprintf可能导致缓冲区溢出问题而不被推荐使用，所以在项目中我一直优先选择使用snprintf函数，虽然会稍微麻烦那么一点点。这里就是sprintf和snprintf最主要的区别：snprintf通过提供缓冲区的可用大小传入参数来保证缓冲区的不溢出，如果超出缓冲区大小则进行截断。但是对于snprintf函数，还有一些细微的差别需要注意。

snprintf函数的返回值

sprintf函数返回的是实际输出到字符串缓冲中的字符个数，包括null结束符。而snprintf函数返回的是应该输出到字符串缓冲的字符个数(也包括null结束符)，所以snprintf的返回值可能大于给定的可用缓冲大小以及最终得到的字符串长度。

所以在使用snprintf函数的返回值时，需要小心慎重，避免人为造成的缓冲区溢出，不然得不偿失。

#include <stdio.h>
int main(){
    char tlist_1[1024] = {0},tlist_2[1024]={0};
    char fname[7][8] = {"a1","b1","c1","d1","e1","f1","g1"};
    int i = 0, len_1,len_2 = 0;
 
    len_1 = snprintf(tlist_1,1024,"%s;",fname[0]);
    len_2 = sprintf(tlist_2,"%s;",fname[0]);
    printf("len1=%d, len2=%d \n", len_1, len_2);
    printf("tlist_1: %s\n",tlist_1);
    printf("tlist_2: %s\n",tlist_2);


    len_1 = snprintf(tlist_1,1024,"%s%s;",tlist_1,fname[1]);
    len_2 = sprintf(tlist_2,"%s%s;",tlist_2,fname[1]);
    printf("len1=%d, len2=%d \n", len_1, len_2);
    printf("tlist_1: %s\n",tlist_1);
    printf("tlist_2: %s\n",tlist_2);


    len_1 = snprintf(tlist_1,1024,"%s%s;",tlist_1,fname[2]);
    len_2 = sprintf(tlist_2,"%s%s;",tlist_2,fname[2]);
    printf("len1=%d, len2=%d \n", len_1, len_2);
    printf("tlist_1: %s\n",tlist_1);
    printf("tlist_2: %s\n",tlist_2);
}

len1=3, len2=3 
tlist_1: a1;
tlist_2: a1;
len1=3, len2=6 
tlist_1: b1;
tlist_2: a1;b1;
len1=3, len2=9 
tlist_1: c1;
tlist_2: a1;b1;c1;

知其然就应该知其所以然，这是良好的求知态度，所以果断翻glibc的源代码去，不凭空想当然。下面用代码说话，这就是开源的好处之一。首先看snprintf的实现：

int snprintf(char *str, size_t size, const char *format, ...)。

将可变个参数(...)按照format格式化成字符串，然后将其复制到str中

(1) 如果格式化后的字符串长度 < size，则将此字符串全部复制到str中，并给其后添加一个字符串结束符('\0')；

(2) 如果格式化后的字符串长度 >= size，则只将其中的(size-1)个字符复制到str中，并给其后添加一个字符串结束符('\0')，返回值为欲写入的字符串长度。

函数返回值:若成功则返回欲写入的字符串长度，若出错则返回负值。

snprintf在格式化字符缓冲区之前会将str清空，而sprintf不会有清空操作。