萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

C/C++ snprintf 安全格式化字串完整指南:緩衝區防溢出、返回值陷阱與最佳實踐

函數原型

int snprintf(char *restrict buf, size_t n, const char *restrict format, ...);
  • n:目的緩衝區總大小 (含結尾 \0)。
  • 行為:最多寫入 n-1 字元,最後強制加 \0。永不溢位 (前提是 n 正確)。
  • 返回值:「本欲寫入的字元數」 (不含結尾 \0),若 ≥ n 發生截斷;負值表示編碼錯誤。

常見誤區與正確用法

✅ 推薦:傳入 sizeof(buf)

char str[10] = {0};
snprintf(str, sizeof(str), "0123456789012345678");
// 結果: str="012345678" (9 字元 + \0), 返回 18 (原字串長度)

❌ 不推薦:手寫長度常數

char str[10] = {0};
snprintf(str, 18, "0123456789012345678"); // 緩衝區只有 10,卻說 18 → 未定義行為 (緩衝區溢出風險)

返回值語意實測

char str1[10] = {0}, str2[10] = {0};
int ret1 = snprintf(str1, sizeof(str1), "%s", "abc");        // 3 字元
int ret2 = snprintf(str2, 4, "%s", "aaabbbccc");              // 緩衝區 4,來源 9 字元

printf("str1=%s, ret1=%d\n", str1, ret1); // str1=abc, ret1=3
printf("str2=%s, ret2=%d\n", str2, ret2); // str2=aaa, ret2=9  ← 返回「想寫 9」,實際只寫 3+1

關鍵:返回值反映格式化後完整長度,而非實際寫入長度。常用於「先查長度 → 分配記憶體 → 再格式化」雙階段模式。

雙階段安全格式化模式


// 階段 1: 查詢所需長度 (buf=NULL, n=0)
int needed = snprintf(NULL, 0, fmt, args...);
if (needed < 0) handle_error();

// 階段 2: 分配並格式化
char *buf = malloc(needed + 1);
snprintf(buf, needed + 1, fmt, args...);
// 使用 buf...
free(buf);

C99 保證 snprintf(NULL, 0, ...) 返回所需長度 (不寫入),可安全查詢。

進階:格式化到固定前綴緩衝區


char dst[10] = {0};
char src[] = "aaabbbcccddd";
int ret = snprintf(dst, sizeof(dst), "str :%s", src);
// dst = "str :aaab" (9 字元 + \0 = 10 滿)
// ret = 17 ("str :aaabbbcccddd" 完整長度)

跨平台注意事項

平台/標準snprintf 返回值語意備註
C99 / POSIX.1-2001 / Linux / macOS / Modern Windows (VS2015+)「欲寫入長度」 (不含 \0)標準行為
舊版 Windows (VS2013 及之前)截斷時返回 -1_snprintf 為舊版;VS2015+ 修正為標準
Windows 安全版snprintf_s / _snprintf_s需 _TRUNCATE 參數,行為不同

總結

  • 永遠用 sizeof(buf) 作為 n 參數。
  • 返回值 = 格式化後完整長度,可用於預分配檢查截斷 (ret >= n)。
  • 雙階段模式 (NULL/0 → malloc → 實寫) 是動態字串構建的標準範式。
  • 嚴禁使用 sprintf (無長度檢查);strncpy 不保證以 \0 結尾,snprintf 才是正解。
copyright © 萬盛學電腦網 all rights reserved