【C語言進階】sprintf和snprintf的區(qū)別

C語言上總有些非常相近的接口函數(shù)，比如sprintf和snprintf就是其中的一對。以筆者多年的工作經(jīng)驗，這對接口函數(shù)在平時的編程中，使用的頻度是非常高，只是你真的了解它們倆的區(qū)別嗎？

帶著這個問題，請跟隨筆者的思路梳理一遍sprintf和snprintf。通過閱讀本文，你將了解到以下內(nèi)容：

sprintf和snpintf分別是什么？

sprintf和snprintf的區(qū)別與聯(lián)系

sprintf和snprintf的使用秘訣

sprintf和snpintf分別是什么？

【sprintf】的函數(shù)原型如下所示：

/**
功能: 把格式化的數(shù)據(jù)寫入某個字符串緩沖區(qū)
入?yún)ⅲ篺ormat，輸出字符串的格式化列表，比如"%s %d %c"等
入?yún)? [argument]，format對應(yīng)的不定參數(shù)列表，與printf的不定入?yún)㈩愃?出參：buffer，指向一段存儲空間，用于存儲格式化之后的字符串
返回值：返回寫入buffer 的字符數(shù)，出錯則返回-1. 如果 buffer 或 format 是空指針，
且不出錯而繼續(xù)，函數(shù)將返回-1，并且 errno 會被設(shè)置為 EINVAL。
備注：它是個變參函數(shù)
*/
int sprintf( char *buffer, const char *format, [ argument] … );

【snprintf】的函數(shù)原型如下所示：

/**
功能: 有長度限制地，把格式化的數(shù)據(jù)寫入某個字符串緩沖區(qū)
入?yún)ⅲ篺ormat，輸出字符串的格式化列表，比如"%s %d %c"等
入?yún)? [argument]，format對應(yīng)的不定參數(shù)列表，與printf的不定入?yún)㈩愃?入?yún)ⅲ簊ize，表示buffer指向存儲空間的大小
出參：buffer，指向一段存儲空間，用于存儲格式化之后的字符串
返回值：返回寫入buffer 的字符數(shù)，出錯則返回-1. 如果 buffer 或 format 是空指針，
且不出錯而繼續(xù)，函數(shù)將返回-1，并且 errno 會被設(shè)置為 EINVAL。
備注：它是個變參函數(shù)
*/
int snprintf( char *buffer, size_t size, const char *format, [ argument] … );

sprintf和snprintf的區(qū)別與聯(lián)系

通過對比sprintf和snprintf的函數(shù)原型，我們可以發(fā)現(xiàn)兩者其實完成相同功能的接口，都是將一段數(shù)據(jù)經(jīng)格式化操作之后，轉(zhuǎn)換成一段字符串，通過接口傳入的buffer指針將格式化的字符串內(nèi)容輸出。

我們細(xì)細(xì)比對兩個函數(shù)原型，我們會發(fā)現(xiàn)snprintf比sprintf多了一個表示buffer指針指向存儲空間的大小的入?yún)ize，那么它到底有什么作用呢？我們先來分析下snprintf接口的內(nèi)部行為與size的關(guān)系：

如果格式化后的字符串長度 < size，則將此字符串全部復(fù)制到str中，并給其后添加一個字符串結(jié)束符('\0')；

如果格式化后的字符串長度 >= size，則只將其中的(size-1)個字符復(fù)制到str中，并給其后添加一個字符串結(jié)束符('\0')，返回值為欲寫入的字符串長度。

看完這一段解釋之后，大概你就明白了，原來snprintf就是sprintf的安全版本，因為單從sprintf的內(nèi)部行為來看，它是沒有辦法保證對buffer指針的賦值操作是沒有越界的，因為它壓根就不知道buffer的存儲空間多少有多大，所以它只能認(rèn)為是【無窮大】。但是snprintf通過入?yún)ize，恰好可以很好的解決這個問題，它可以很明確的告知snprintf的內(nèi)部操作，以size作為界線，當(dāng)輸出的字符串長度要超過size時，應(yīng)做出裁剪輸出。在很多的編程寶典中，都是推薦使用snprintf，而要求編程者盡可能地避免使用sprintf這種不安全接口。

sprintf和snprintf的使用秘訣

我們通過一段測試代碼來展示下兩者的使用方法，以及上一小結(jié)中提及的可能導(dǎo)致buffer溢出的嚴(yán)重問題：

//sprintf的用法
{
    char buffer[10]; //定義一個只有10個字節(jié)空間的buffer數(shù)組
    const int a = 12345; //定義一個int型的常量
    const char *msg = "012345678901234567890"; //定義一個長度為20字節(jié)的字符串常量

    sprintf(buffer, "%d", a); //將a變量按int類型打印成字符串，輸出到buffer中
    /*
    輸出分析：
    輸出結(jié)果: buffer="12345"
    因為最后輸出的buffer內(nèi)容長度不超過10字節(jié)，所以此時sprintf操作是沒有溢出風(fēng)險的
    */

    sprintf(buffer, "%d+%s", a, msg); //將a變量和msg字符串通過“+”連接成一個字符串
    /*
    輸出分析：
    由于buffer只有10個字節(jié)空間，而sprintf在執(zhí)行字符串格式化輸出的時，并不知道buffer的真實長度，
    所以它會將"12345+012345678901234567890"這整個字符串都拷貝到buffer空間上，這就導(dǎo)致了buffer存儲空間溢出了。
    從存儲位置上分析，我們知道buffer空間屬于一個棧空間，在它自己的10字節(jié)之外的空間很明顯是其他棧變量的存儲空間，
    一旦sprintf將10字節(jié)外的其他空間也操作了，這就有可能破壞了其他棧變量的內(nèi)容，這有可能是致命的。
    */
}

//snprintf的用法
{
    char buffer[10]; //定義一個只有10個字節(jié)空間的buffer數(shù)組
    const int a = 12345; //定義一個int型的常量
    const char *msg = "012345678901234567890"; //定義一個長度為20字節(jié)的字符串常量

    snprintf(buffer, sizeof(buffer), "%d", a); //將a變量按int類型打印成字符串，輸出到buffer中
    /*
    輸出分析：
    輸出結(jié)果: buffer="12345"
    因為最后輸出的buffer內(nèi)容長度不超過10字節(jié)，所以snprintf操作是沒有溢出風(fēng)險的；
    此種情況下，使用sprintf和snpintf都可以得到同樣的結(jié)果，且都不會產(chǎn)生數(shù)組溢出。
    */

    sprintf(buffer, sizeof(buffer), "%d+%s", a, msg); //將a變量和msg字符串通過“+”連接成一個字符串
    /*
    輸出分析：
    輸出結(jié)果是: buffer="12345+0123"，加上一個'\0'的字符串結(jié)束符，
    剛好占用了buffer的10字節(jié)的存儲空間，不存在任何的buffer溢出風(fēng)險。而"0123"后面的字符串都被snprintf內(nèi)部裁剪掉了，這就體現(xiàn)了snprintf操作安全的特性。
    */
}

通過以上分析，我們很好地認(rèn)識到了sprintf的操作是不安全的。在C語言的語法上，指針的靈活性也帶來可能導(dǎo)致的指針溢出風(fēng)險，而snprintf恰好就是解決了這個困惑的sprintf升級版本。

類似的，還有strcat和strncat、strcpy和strncpy等等。通過本文的方法，讀者也可以寫一小段測試代碼，好好捋一捋本文提及的這幾組函數(shù)，一起領(lǐng)悟下其他的奧秘和使用風(fēng)險吧。

以上總結(jié)，均來自筆者多年的實踐經(jīng)驗，如有發(fā)現(xiàn)不正確的陳述或錯誤的觀點，還望讀者指正，感激不盡。