1. 程式人生 > >[轉載]Linux C 字符串函數 sprintf()、snprintf() 詳解

[轉載]Linux C 字符串函數 sprintf()、snprintf() 詳解

數組 test 不足 同時 逗號 itoa 表示 成了 nat

一、sprintf() 函數詳解

在將各種類 型的數據構造成字符串時,sprintf 的強大功能很少會讓你失望。

由於 sprintf 跟 printf 在用法上幾乎一樣,只是打印的目的地不同而已,前者打印到字符串中,後者則直接在命令行上輸出。這也導致 sprintf 比 printf 有用得多。所以本文著重介紹 sprintf,有時也穿插著用用 pritnf。

sprintf是個變參函數,定義如下:

int sprintf( char *buffer, const char *format [, argument] … );

除了前兩個參數類型固定外,後面可以接任意多個參數。而它的精華,顯然就在第二個參數:格式化字符串上。

printf 和 sprintf 都使用格式化字符串來指 定串的格式,在格式串內部使用一些以“%”開頭的格式說明符(format specifications)來占據一個位置,在後邊的變參列表中提供相應的變量,最終函數就會用相應位置的變量來替代那個說明符,產生一個調用者想要 的字符串。

1、格式化數字字符串

sprintf最常見的應用之一莫過於把整數打印到字符串中,所以,spritnf 在大多數場合可以替代itoa。如:

// 把整數123打印成一個字符串保存在s中。

sprintf(s, "%d", 123); // 產生"123"

可以指定寬度,不足的左邊補空格:

sprintf(s, "
%8d%8d", 123, 4567); // 產生:" 123 4567"

當然也可以左對齊:

sprintf(s, "%-8d%8d", 123, 4567); // 產生:"123         4567"

也可以按照16進制打印:

sprintf(s, "%8x", 4567); // 小寫16進制,寬度占8個位置,右對齊
sprintf(s, "%-8X", 4568); // 大寫16進制,寬度占8個位置,左對齊

這樣,一個整數的16進制字符串就很容易得到,但我們在打印16進制內容時,通常想要一種左邊補0的等寬格式,那該怎麽做呢?很簡單,在表示寬度的數字前面加個0就可以了。

sprintf(s, "%08X", 4567); // 產生:"000011D7"

上面以 "%d" 進行的10進制打印同樣也可以使用這種左邊補0的方式。

這裏要註意一個符號擴展的問題:比如,假如我們想打印短整數(short)-1的內存16進制表示形式,在Win32平臺上,一個 short 型占2個字節,所以我們自然希望用4個16進制數字來打印它:

short si = -1;
sprintf(s, "%04X", si);

產生 "FFFFFFFF",怎麽回事?因為 spritnf 是個變參函數,除了前面兩個參數之外,後面的參數都不是類型安全的,函數更沒有辦法僅僅通過一個“%X”就能得知當初函數調用前參數壓棧時 被壓進來的到底是個4字節的整數還是個2字節的短整數,所以采取了統一4字節的處理方式,導致參數壓棧時做了符號擴展,擴展成了32位的整數-1,打印時 4個位置不夠了,就把32位整數-1的8位16進制都打印出來了。如果你想看si的本來面目,那麽就應該讓編譯器做0擴展而不是符號擴展(擴展時二進制左 邊補0而不是補符號位):

sprintf(s, "%04X", (unsigned short)si);

就可以了。或者:

unsigned short si = -1;
sprintf(s, "%04X", si);

sprintf 和 printf 還可以按8進制打印整數字符串,使用“%o”。註意8進制和16進制都不會打印出負數,都是無符號的,實際上也就是變量的內部編碼的直接的16進制或8進制表示。

字符/Ascii碼對照

我們知道,在C/C++語言中,char也是一種普通 的scalable類型,除了字長之外,它與short,int,long這些類型沒有本質區別,只不過被大家習慣用來表示字符和字符串而已。

(或許當年 該把這個類型叫做“byte”,然後現在就可以根據實際情況,使用 byte 或 short 來把 char 通過 typedef 定義出來,這樣更合適些)

於是,使用“%d”或者“%x”打印一個字符,便能得 出它的10進制或16進制的ASCII碼;反過來,使用“%c”打印一個整數,便可以看到它所對應的ASCII字符。以下程序段把所有可見字符的 ASCII碼對照表打印到屏幕上(這裏采用printf,註意“#”與“%X”合用時自動為16進制數增加“0X”前綴):

for (int i = 32; i < 127; i++)
{
    printf("[ %c ]: %3d 0x%#04X/n", i, i, i);
}

3、連接字符串

sprintf的格式控制串中既然可以插入各種東西,並最終把它們“連成一串”,自然也就能夠連接字符串,從而在許多場合可以替代 strcat,但 sprintf 能夠一次連接多個字符串(自然也可以同時在它們中間插入別的內容,總之非常靈活)。比如:

char *who = "I";
char *whom = "52PHP";
 
sprintf(s, "%s love %s.", who, whom); // 產生:"I love 52PHP. "

strcat 只能連接字符串(一段以 ‘\0‘ 結尾的字 符數組或叫做字符緩沖,null-terminated-string),但有時我們有兩段字符緩沖區,他們並不是以 ‘\0‘ 結尾。比如許多從第三方庫函 數中返回的字符數組,從硬件或者網絡傳輸中讀進來的字符流,它們未必每一段字符序列後面都有個相應的 ‘\0‘ 來結尾。如果直接連接,不管是 sprintf 還是 strcat 肯定會導致非法內存操作,而 strncat 也至少要求第一個參數是個 null-terminated-string,那該怎麽辦呢?我們 自然會想起前面介紹打印整數和浮點數時可以指定寬度,字符串也一樣的。比如:

char a1[] = {A, B, C, D, E, F, G};
char a2[] = {H, I, J, K, L, M, N};

如果:

sprintf(s, "%s%s", a1, a2); // Don’t do that!

十有八九要出問題了。是否可以改成:

sprintf(s, "%7s%7s", a1, a2);

也沒好到哪兒去,正確的應該是:

sprintf(s, "%.7s%.7s", a1, a2); // 產生:"ABCDEFGHIJKLMN"

這可以類比打印浮點數的“%m.nf”,在“%m.ns”中,m表示占用寬度(字符串長度不足時補空格,超出了則按照實際寬度打印),n才表示從相應的字符串中最多取用的字符數。通常在打印字符串時m沒什麽大用,還是點號後面的n用的多。自然,也可以前後都只取部分字符:

sprintf(s, "%.6s%.5s", a1, a2); // 產生:"ABCDEFHIJKL"

在許多時候,我們或許還希望這些格式控制符中用以指定 長度信息的數字是動態的,而不是靜態指定的,因為許多時候,程序要到運行時才會清楚到底需要取字符數組中的幾個字符,這種動態的寬度/精度設置功能在 sprintf 的實現中也被考慮到了,sprintf 采用“*”來占用一個本來需要一個指定寬度或精度的常數數字的位置,同樣,而實際的寬度或精度就可以 和其它被打印的變量一樣被提供出來,於是,上面的例子可以變成:

sprintf(s, "%.*s%.*s", 7, a1, 7, a2);

或者:

sprintf(s, "%.*s%.*s", sizeof(a1), a1, sizeof(a2), a2);

實際上,前面介紹的打印字符、整數、浮點數等都可以動態指定那些常量值,比如:

sprintf(s, "%-*d", 4, A);             // 產生 "65 "
sprintf(s, "%#0*X", 8, 128);            // 產生 "0X000080″,"#"產生0X
sprintf(s, "%*.*f", 10, 2, 3.1415926);  // 產生"      3.14″

4、打印地址信息

有時調試程序時,我們可能想查看某些變量或者成員的地址,由於地址或者指針也不過是個32位的數,你完全可以使用打印無符號整數的“%u”把他們打印出來:

sprintf(s, "%u", &i);

不過通常人們還是喜歡使用16進制而不是10進制來顯示一個地址:

sprintf(s, "%08X", &i);

然而,這些都是間接的方法,對於地址打印,sprintf 提供了專門的“%p”:

sprintf(s, "%p", &i);

我覺得它實際上就相當於:

sprintf(s, "%0*x", 2 * sizeof(void *), &i);

5、利用sprintf的返回值

較少有人註意 printf/sprintf 函數的返回值,但有時它卻是有用的,spritnf 返回了本次函數調用最終打印到字符緩沖區中的字符數目。也就是說每當一次 sprinf 調用結束以後,你無須再調用一次strlen 便已經知道了結果字符串的長度。如:

int len = sprintf(s, "%d", i);

對於正整數來說,len便等於整數i的10進制位數。

下面的是個完整的例子,產生10個[0, 100)之間的隨機數,並將他們打印到一個字符數組s中,以逗號分隔開。

#include <stdio.h>
#include <stdlib.h>
#include <time.h>
 
int main(int argc, char **argv)
{
    srand(time(0));
    char s[64];
    int offset = 0;
 
    for (int i = 0; i < 10; i++)
    {
        offset += sprintf(s + offset, "%d, ", rand() % 100);
    }
 
    s[offset - 1] = \n; // 將最後一個逗號換成換行符。
    printf(s);
 
    return 0;
}

設想當你從數據庫中取出一條記錄,然後希望把他們的各 個字段按照某種規則連接成一個字符串時,就可以使用這種方法,從理論上講,他應該比不斷的 strcat 效率高,因為 strcat 每次調用都需要先找到最後 的那個 ‘\0‘ 的位置,而在上面給出的例子中,我們每次都利用 sprintf 返回值把這個位置直接記下來了。

6、使用 sprintf 的常見問題

sprintf是個變參函數,使用時經常出問題,而且只要出問題通常就是能導致程序崩潰的內存訪問錯誤,但好在由sprintf誤用導致的問題雖然嚴重,卻很容易找出,無非就是那麽幾種情況,通常用眼睛再把出錯的代碼多看幾眼就看出來了。

緩沖區溢出

第一個參數的長度太短了,沒的說,給個大點的地方吧。當然也可能是後面的參數的問題,建議變參對應一定要細心,而打印字符串時,盡量使用“%.ns”的形式指定最大字符數。

忘記了第一個參數

低級得不能再低級問題,用 printf 用得太慣了。// 偶就常犯。

變參對應出問題

通常是忘記了提供對應某個格式符的變參,導致以後的參數統統錯位,檢查檢查吧。尤其是對應“*”的那些參數,都提供了嗎?不要把一個整數對應一個“%s”,編譯器會覺得你欺她太甚了。


二、snprintf() 詳解

函數原型:

int snprintf(char *restrict buf, size_t n, const char * restrict  format, ...);

函數說明:最多從源串中拷貝 n-1 個字符到目標串中,然後再在後面加一個 ‘\0‘。所以如果目標串的大小為 n 的話,將不會溢出。

函數返回值:若成功則返回欲寫入的字符串長度,若出錯則返回負值。

1、推薦的用法

#include <stdio.h>
 
int main(int argc, char **argv)
{
    char str[10] = {0,};
    snprintf(str, sizeof(str), "0123456789012345678");
    printf("str=%s\n", str);
 
    return 0;
}

輸出:

str=012345678

2、不推薦的用法

#include <stdio.h>
 
int main(int argc, char **argv)
{
    char str[10] = {0,};
    snprintf(str, 18, "0123456789012345678");
    printf("str=%s/n", str);
 
    return 0;
}

輸出:

str=01234567890123456

3、snprintf() 函數返回值的測試:

#include <stdio.h>
#include <string.h>
 
int main(int argc, char **argv)
{
    char str1[10] = {0,};
    char str2[10] = {0,};
    int ret1 = 0, ret2 = 0;
 
    ret1 = snprintf(str1, sizeof(str1), "%s", "abc");
    ret2 = snprintf(str2, 4, "%s", "aaabbbccc");
 
    printf("aaabbbccc length=%d\n", strlen("aaabbbccc"));
    printf("str1=%s,ret1=%d\n", str1, ret1);
    printf("str2=%s,ret2=%d\n", str2, ret2);
 
    return 0;
}

輸出:

aaabbbccc length=9
str1=abc,ret1=3
str2=aaa,ret2=9

特別註意:

snprintf() 的返回值是欲寫入的字符串長度,而不是實際寫入的字符串度。如:

#include <stdio.h>
 
int main(int argc, char **argv)
{
    char test[8];
    int ret = snprintf(test, 5, "1234567890");
    printf("%d|%s\n", ret, test);
 
    return 0;
}

輸出:

10|1234

[轉載]Linux C 字符串函數 sprintf()、snprintf() 詳解