[[384892]]

一、前言

在嵌入式項(xiàng)目開(kāi)發(fā)中，字符串格式化是很常見(jiàn)的操作，我們一般都會(huì)使用 C 庫(kù)中的 sprintf 系列函數(shù)來(lái)完成格式化。

從功能上來(lái)說(shuō)，這是沒(méi)有問(wèn)題的，但是在一些時(shí)間關(guān)鍵場(chǎng)合，字符串的格式化效率會(huì)對(duì)整個(gè)系統(tǒng)產(chǎn)生顯著的影響。

例如：在一個(gè)日志系統(tǒng)中，吞吐率是一個(gè)重要的性能指標(biāo)。每個(gè)功能模塊都產(chǎn)生了大量的日志信息，日志系統(tǒng)需要把時(shí)間戳添加到每條日志的頭部，此時(shí)字符串的格式化效率就比較關(guān)鍵了。

天下武功，唯快不破!

這篇文章就專門來(lái)聊一聊把數(shù)字格式化成字符串，可以有什么更好的方法。也許技術(shù)含量不高，但是很實(shí)用!

二、最簡(jiǎn)單的格式化

#include <stdio.h> 
#include <string.h> 
#include <limits.h> 
#include <sys/time.h> 
 
int main() 
{ 
    char buff[32] = { 0 }; 
    sprintf(buff, "%ld", LONG_MAX); 
    printf("buff = %s \n", buff); 
} 

其中，LONG_MAX 表示 long 型數(shù)值的最大值。代碼在眨眼功夫之間就執(zhí)行結(jié)束了，但是如果是一百萬(wàn)、一千萬(wàn)次呢?

三、測(cè)試1：手動(dòng)格式化數(shù)字

1. 獲取系統(tǒng)時(shí)間戳函數(shù)

我的測(cè)試環(huán)境是：在 Win10 中通過(guò) VirtualBox，安裝了 Ubuntu16.04 虛擬機(jī)，使用系統(tǒng)自帶的 gcc 編譯器。

為了測(cè)試代碼執(zhí)行的耗時(shí)，我們寫一個(gè)簡(jiǎn)單的函數(shù)：獲取系統(tǒng)的時(shí)間戳，通過(guò)計(jì)算時(shí)間差值來(lái)看一下代碼的執(zhí)行速度。

// 獲取系統(tǒng)時(shí)間戳 
long long getSysTimestamp() 
{ 
    struct timeval tv;   
    gettimeofday(&tv, 0); 
    long long ts = (long long)tv.tv_sec * 1000000 + tv.tv_usec; 
    return ts;  
} 

2. 實(shí)現(xiàn)格式化數(shù)字的函數(shù)

// buff: 格式化之后字符串存儲(chǔ)地址； 
// value: 待格式化的數(shù)字 
void Long2String(char *buff, long value) 
{ 
    long tmp; 
    char tmpBuf[32] = { 0 }; 
    // p 指向臨時(shí)數(shù)組的最后一個(gè)位置 
    char *p = &tmpBuf[sizeof(tmpBuf) - 1]; 
     
    while (value != 0) 
    { 
        tmp  = value / 10; 
        // 把一個(gè)數(shù)字轉(zhuǎn)成 ASCII 碼，放到 p 指向的位置。 
        // 然后 p 往前移動(dòng)一個(gè)位置。 
        *--p = (char)('0' + (value - tmp * 10)); 
        value = tmp; 
    } 
 
    // 把臨時(shí)數(shù)組中的每個(gè)字符，復(fù)制到 buff 中。 
    while (*p) *buff++ = *p++; 
}     

這個(gè)函數(shù)的過(guò)程很簡(jiǎn)單，從數(shù)字的后面開(kāi)始，把每一個(gè)數(shù)字轉(zhuǎn)成 ASCII 碼，放到一個(gè)臨時(shí)數(shù)組中(也是從后往前放)，最后統(tǒng)一復(fù)制到形參指針 buff 指向的空間。

3. 測(cè)試代碼

int main() 
{ 
    printf("long size = %d, LONG_MAX = %ld\n", sizeof(long), LONG_MAX); 
     
    // 測(cè)試 1000 萬(wàn)次 
    int  total = 1000 * 10000; 
    char buff1[32] = { 0 }; 
    char buff2[32] = { 0 }; 
 
    // 測(cè)試 sprintf 
    long long start1 = getSysTimestamp(); 
    for (int i = 0; i < total; ++i) 
        sprintf(buff1, "%ld", LONG_MAX); 
    printf("sprintf    ellapse:  %lld us \n", getSysTimestamp() - start1); 
 
    // 測(cè)試 Long2String 
    long long start2 = getSysTimestamp(); 
    for (int i = 0; i < total; ++i) 
        Long2String(buff2, LONG_MAX); 
    printf("Long2String ellapse: %lld us \n", getSysTimestamp() - start2); 
     
    return 0; 
} 

4. 執(zhí)行結(jié)果對(duì)比

long size = 4, LONG_MAX = 2147483647 
sprintf    ellapse:  1675761 us  
Long2String ellapse: 527728 us 

也就是說(shuō)：把一個(gè) long 型數(shù)字格式化成字符串:

1. 使用 sprintf 庫(kù)函數(shù)，耗時(shí) 1675761 us;
2. 使用自己寫的 Long2String 函數(shù)，耗時(shí) 527728 us;

大概是 3 倍左右的差距。當(dāng)然，在你的電腦上可能會(huì)得到不同的結(jié)果，這與系統(tǒng)的負(fù)載等有關(guān)系，可以多測(cè)試幾次。

四、測(cè)試2：混合格式化字符串和數(shù)字

看起來(lái)使用自己寫的 Long2String 函數(shù)執(zhí)行速度更快一些，但是它有一個(gè)弊端，就是只能格式化數(shù)字。

如果我們需要把字符串和數(shù)字一起格式化成一個(gè)字符串，應(yīng)該如何處理?

如果使用 sprintf 庫(kù)函數(shù)，那非常方便：

sprintf(buff, "%s%d", "hello", 123456); 

如果繼續(xù)使用 Long2String 函數(shù)，那么就要分步來(lái)格式化，例如：

// 拆成 2 個(gè)步驟 
sprintf(buff, "%s", "hello"); 
Long2String(buff + strlen(buff), 123456); 

以上兩種方式都能達(dá)到目的，那執(zhí)行效率如何呢?繼續(xù)測(cè)試：

int main() 
{ 
    printf("long size = %d, LONG_MAX = %ld\n", sizeof(long), LONG_MAX); 
     
    // 測(cè)試 1000 萬(wàn) 次 
    const char *prefix = "ZhangSan has money: "; 
    int  total = 1000 * 10000; 
    char buff1[32] = { 0 }; 
    char buff2[32] = { 0 }; 
 
    // 測(cè)試 sprintf 
    long long start1 = getSysTimestamp(); 
    for (int i = 0; i < total; ++i) 
        sprintf(buff1, "%s%ld", prefix, LONG_MAX); 
    printf("sprintf     ellapse: %lld us \n", getSysTimestamp() - start1); 
 
    // 測(cè)試 Long2String 
    long long start2 = getSysTimestamp(); 
    for (int i = 0; i < total; ++i) 
    { 
        sprintf(buff2, "%s", prefix); 
        Long2String(buff2 + strlen(prefix), LONG_MAX); 
    } 
    printf("Long2String ellapse: %lld us \n", getSysTimestamp() - start2); 
     
    return 0; 
} 

執(zhí)行結(jié)果對(duì)比:

long size = 4, LONG_MAX = 2147483647 
sprintf     ellapse: 2477686 us  
Long2String ellapse: 816119 us 

執(zhí)行速度仍然是 3 倍左右的差距。就是說(shuō)，即使拆分成多個(gè)步驟來(lái)執(zhí)行，使用 Long2String 函數(shù)也會(huì)更快一些!

五、sprintf 的實(shí)現(xiàn)機(jī)制

sprintf 函數(shù)家族中，存在著一系列的函數(shù)，其底層是通過(guò)可變參數(shù)來(lái)實(shí)現(xiàn)的。之前寫過(guò)一篇文章一個(gè)printf(結(jié)構(gòu)體指針)引發(fā)的血案，其中的第四部分，使用圖片詳細(xì)描述了可變參數(shù)的實(shí)現(xiàn)原理，摘抄如下。

1. 可變參數(shù)的幾個(gè)宏定義

typedef char *    va_list; 
 
#define va_start  _crt_va_start 
#define va_arg    _crt_va_arg   
#define va_end    _crt_va_end   
 
#define _crt_va_start(ap,v)  ( ap = (va_list)_ADDRESSOF(v) + _INTSIZEOF(v) )   
#define _crt_va_arg(ap,t)    ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )   
#define _crt_va_end(ap)      ( ap = (va_list)0 ) 

注意：va_list 就是一個(gè) char* 型指針。

2. 可變參數(shù)的處理過(guò)程

我們以剛才的示例 my_printf_int 函數(shù)為例，重新貼一下：

void my_printf_int(int num, ...) // step1 
{ 
    int i, val; 
    va_list arg; 
    va_start(arg, num);         // step2 
    for(i = 0; i < num; i++) 
    { 
        val = va_arg(arg, int); // step3 
        printf("%d ", val); 
    } 
    va_end(arg);                // step4 
    printf("\n"); 
} 
 
int main() 
{ 
    int a = 1, b = 2, c = 3; 
    my_printf_int(3, a, b, c); 
} 

Step1: 函數(shù)調(diào)用時(shí)

C語(yǔ)言中函數(shù)調(diào)用時(shí)，參數(shù)是從右到左、逐個(gè)壓入到棧中的，因此在進(jìn)入 my_printf_int的函數(shù)體中時(shí)，棧中的布局如下:

Step2: 執(zhí)行 va_start

va_start(arg, num); 

把上面這語(yǔ)句，帶入下面這宏定義：

#define _crt_va_start(ap,v)  ( ap = (va_list)_ADDRESSOF(v) + _INTSIZEOF(v) ) 

宏擴(kuò)展之后得到：

arg = (char *)num + sizeof(num); 

結(jié)合下面的圖來(lái)分析一下：首先通過(guò) _ADDRESSOF 得到 num 的地址 0x01020300，然后強(qiáng)轉(zhuǎn)成 char* 類型，再然后加上 num 占據(jù)的字節(jié)數(shù)(4個(gè)字節(jié))，得到地址 0x01020304，最后把這個(gè)地址賦值給 arg，因此 arg 這個(gè)指針就指向了棧中數(shù)字 1 的那個(gè)地址，也就是第一個(gè)參數(shù)，如下圖所示： 

Step3: 執(zhí)行 va_arg

val = va_arg(arg, int); 

把上面這語(yǔ)句，帶入下面這宏定義：

#define _crt_va_arg(ap,t)    ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) ) 

宏擴(kuò)展之后得到：

val = ( *(int *)((arg += _INTSIZEOF(int)) - _INTSIZEOF(int)) ) 

結(jié)合下面的圖來(lái)分析一下：先把 arg 自增 int 型數(shù)據(jù)的大小(4個(gè)字節(jié))，使得 arg = 0x01020308;然后再把這個(gè)地址(0x01020308)減去4個(gè)字節(jié)，得到的地址(0x01020304)里的這個(gè)值，強(qiáng)轉(zhuǎn)成 int 型，賦值給 val，如下圖所示：

簡(jiǎn)單理解，其實(shí)也就是：得到當(dāng)前 arg 指向的 int 數(shù)據(jù)，然后把 arg 指向位于高地址處的下一個(gè)參數(shù)位置。

va_arg 可以反復(fù)調(diào)用，直到獲取棧中所有的函數(shù)傳入的參數(shù)。

Step4: 執(zhí)行 va_end

va_end(arg); 

把上面這語(yǔ)句，帶入下面這宏定義：

#define _crt_va_end(ap)      ( ap = (va_list)0 ) 

宏擴(kuò)展之后得到：

arg = (char *)0; 

這就好理解了，直接把指針 arg 設(shè)置為空。因?yàn)闂Ｖ械乃袆?dòng)態(tài)參數(shù)被提取后，arg 的值為 0x01020310(最后一個(gè)參數(shù)的上一個(gè)地址)，如果不設(shè)置為 NULL 的話，下面使用的話就得到未知的結(jié)果，為了防止誤操作，需要設(shè)置為NULL。

六、總結(jié)

這篇文章描述的格式化方法靈活性不太好，也許存在一定的局限性。但是在一些關(guān)鍵場(chǎng)景下，能明顯提高執(zhí)行效率。