對格式化字串的一些思考

xshlife2發表於2020-12-22

字串

在最近工作中，在拼接sql語句時，用到格式化字串，經過和同事討論後，有了新的思考。這個點在之前都是參照已有來使用，沒有深入去追究，本次全面瞭解下。

格式化字串
在實際工程中，格式化字串一般用在列印日誌、拼接字串等，目前在工程中常見的是這樣用的：

char szbuf[128] = {0};
snprintf(szbuf, sizeof(szbuf) - 1, “log:%d %s”, 1,“XXXX”);

按照上述格式化完後，對緩衝區szBuf進行各種操作。這裡面有幾點疑問：

這裡沒有判斷snprintf的返回值，需不需要判斷？
snprintf的第二個引數為什麼要減1？
沒有考慮格式化完整性
下面依次分析。

snprintf的返回值代表什麼含義
在linux環境上，snprintf的函式原型如下。

int snprintf(char* str, size_t size, const char* format, …);
查閱snprintf的man手冊，對返回值有如下說明：

snprintf返回值說明.jpg

該函式的返回值表示待格式化字串的長度，不包括結束分隔符。這是什麼意思呢？舉個例子：

格式化 abcd 字串，返回值是4，表示待格式化的字元個數為4。
格式化 01234567890 字串，返回值為10。
這個返回值和傳入的緩衝區長度size沒有任何關係的，它只與待格式化字串的長度有關。

另一個需要注意的點是，這個函式在格式化時，不會往緩衝區str中寫入多於size大小的資料，包括\0在內。這就是說，外部傳入size大小的緩衝區，該函式能夠保證在size大小內，填充包含\0，至於有沒有截斷，需要使用者來進一步判斷。

至此，可解答上面兩個問題：

snprintf的返回值表示待格式化字串的長度
snprintf的第二個引數沒必要減1，按照輸入緩衝區長度傳入即可。
第三個問題，判斷格式化後是否被截斷。從上述說明來看，如果返回值大於等於入參size時，表明格式化輸出被截斷。另外一種情況，如果遇到輸出錯誤，會返回一個負值。

因此，可總結出如下程式碼：

const int nBufSize = 256;
char szBuf[nBufSize] = {0};
int nRet = snprintf(szBbuf, nBufSize, “XXXX”, “XXXX”);
if (nRet >= nBufSize || nRet < 0)
{
// 格式化被截斷或者格式化失敗
}
else
{
// 正常格式化，走正常流程
}

截斷後的處理
一般來說，我們在格式化字串時，提供的緩衝區都足夠大，保證不會發生截斷。當有些格式化資料由外部傳入，當這些資料含有異常、超長資料時，比如一個無效的double值，同時此時緩衝區較小，就可能會被截斷。

截斷後要如何處理呢？這裡不好一概而論，得區分格式化字串的上下文場景

如果是執行sql，這種情況下，無論被截斷的是哪部分，這個sql都不安全l，不允許後續使用。發生此種情況的截斷，需要記錄錯誤日誌後退出。

如果是記錄日誌，日誌是為了檢查系統狀態，即使被截斷，前面資訊也是有效的，這種場景也要記錄為錯誤日誌，但後續邏輯可繼續執行。

以上是我目前想到的兩種場景，可能還有其他場景。就比如執行sql來說，如果是很簡單，很顯而易見的sql，例如根據UserId從資料庫中查詢相關資訊，這種很簡單的sql語句，要不要判斷截斷呢？如果這種簡單的不判斷，那複雜到什麼程度才判斷呢？感覺這樣判斷，會讓邏輯依賴於資料，這是不好的做法。筆者在這裡無法給出絕對的結論，不同場景下不同的處理，能夠達成團隊一致即可。

這裡說一句，即使使用儲存過程，縮短sql的長度，但只能緩解拼接截斷髮生的概覽，對於有動態資料的查詢，還是要小心。

總結
本文總結了在格式化字串時的一些注意事項，給出自認為比較正確的做法，並就格式化截斷後的處理進行了簡短討論。

【Go】高效擷取字串的一些思考
2019-10-31
Go字串
對ThreadLocal的一些思考
2018-08-08
thread
對於人生的一些思考
2015-07-30
對React setState的一些思考與心得
2021-09-09
React
對提高HBase寫效能的一些思考
2017-03-19
對於最近的一些理解和思考
2016-06-20
對自己目前狀況的一些思考
2016-04-06
Python中對字串格式化的方法:%、format()、以及f+字串詳解
2020-11-13
Python字串格式化ORM
對於封裝react元件的一些思考
2019-01-15
封裝React元件
我對SLG遊戲製作的一些思考
2022-02-24
遊戲
string.Format對C#字串格式化
2016-06-14
ORMC#字串格式化
Python中的字串與字串格式化
2021-02-04
Python字串格式化
對App應用架構搭建的一些思考
2020-11-19
APP應用架構
對CROS OPTIONS預檢請求的一些思考
2021-01-03
ROS
python字串的格式化
2021-05-16
Python字串
Python 字串的格式化
2016-04-18
Python字串
Golang字串格式化
2018-09-13
Golang字串格式化
Golang 字串格式化
2020-10-10
Golang字串
專案開發中對成長的一些思考
2022-03-24
我對軟體架構的一些看法和思考
2010-04-24
架構
再聊對架構決策記錄的一些思考
2024-03-11
架構
生活的一些思考
2019-02-18
我的一些思考
2009-09-03
經驗篇：對商業分析的一些思考和感悟
2022-08-04
對設計與設計師“價值”的一些思考
2015-09-12
對2D遊戲引擎設計的一些思考(轉)
2007-08-12
遊戲引擎
【java初探】——格式化字串
2019-03-27
Java字串
Python：字串格式化
2018-09-19
Python字串格式化
js 字串格式化方法
2016-11-18
JS字串格式化
Python 字串格式化
2016-06-09
Python字串格式化
一些思考
2017-09-22
Python中的字串格式化方法
2022-01-30
Python字串格式化
python字串格式化的方法整理
2021-09-11
Python字串格式化
學習憤怒的小鳥：對Android遊戲的一些思考
2014-04-02
Android遊戲
由作業題引發對C++引用的一些思考
2017-03-23
C++
【設計模式總結】對常用設計模式的一些思考
2017-02-23
設計模式
Java IO的一些思考
2019-01-19
Java
最近招人的一些思考... ...
2018-07-24

對格式化字串的一些思考

相關文章