[[349354]]

引言

編程習(xí)慣的培養(yǎng)需要的是一個(gè)長(zhǎng)期的過(guò)程，需要不斷地總結(jié)，積累，并且我們需要從意識(shí)上認(rèn)識(shí)其重要性，一個(gè)良好的編程習(xí)慣對(duì)于我們能力的提高也是有巨大的幫助的。下面是筆者在閱讀《專(zhuān)業(yè)嵌入式軟件開(kāi)發(fā)》這本書(shū)時(shí)所看到的一些關(guān)于編程好習(xí)慣的總結(jié)，特此記錄和分享一下、

判斷失敗而非成功

下面是一段簡(jiǎn)化過(guò)后的代碼片段：

if (physap_alarm_init() == RV_SUCC) 
{ 
    if (trx_alarm_init() == RV_SUCC) 
    { 
        if (bucket_init() == RV_SUCC) 
        { 
            if (main_bhp_init() == RV_SUCC) 
            { 
                /* 正常代碼 */ 
            } 
            else 
            { 
                /* 錯(cuò)誤代碼 */ 
            } 
        } 
        else 
        { 
            /* 錯(cuò)誤代碼 */ 
        } 
    } 
    else 
    { 
        /* 錯(cuò)誤代碼 */ 
    } 
} 
else 
{ 
    /* 錯(cuò)誤代碼 */ 
} 

可以看到上述代碼在采用了判斷成功策略后，代碼中 if 和 else 之間的嵌套非常的混亂，看著非常的不直觀，代碼閱讀比較困難，但是如果采用的是判斷失敗策略后，代碼就會(huì)看起來(lái)簡(jiǎn)潔不少，下面是通過(guò)采用判斷失敗策略后改進(jìn)的代碼：

if (physap_alarm_init() != RV_SUCC) 
{ 
    /* 錯(cuò)誤處理 */ 
    return; 
} 
 
if (trx_alarm_init() != RV_SUCC)  
{ 
    /* 錯(cuò)誤處理 */ 
    return; 
} 
 
if (bucket_init() != RV_SUCC) 
{ 
    /* 錯(cuò)誤處理 */ 
    return; 
} 
 
if (main_bhp_init() != RV_SUCC) 
{ 
    /* 錯(cuò)誤處理 */ 
    return; 
} 
 
/* 正常代碼 */ 

通過(guò)上述代碼可以知道，更改后的代碼消除了 if 嵌套語(yǔ)句，大大提高了代碼的可讀性。需要注意的一點(diǎn)是，并不是所有的情況通過(guò)判斷失敗策略就能夠優(yōu)于判斷成功策略，這需要視情況而定。

使用 sizeof 減少內(nèi)存操作失誤

在編寫(xiě)代碼的時(shí)候，我們經(jīng)常會(huì)涉及到使用 memset 函數(shù)對(duì)內(nèi)存進(jìn)行置 0 初始化，下面有幾種錯(cuò)誤示例：

// example1 
char *buf[MAX_LEN + 1]; 
memset (buf, 0, MAX_LEN + 1); 

上述代碼的錯(cuò)誤忘記了 buf 是一個(gè)字符指針數(shù)組，而非一個(gè)字符數(shù)組;

繼續(xù)看一段代碼：

// example2 
#define   DIGEST_LEN    17 
#define   DIGEST_MAX    16 
 
char digest [DIGEST_MAX]; 
memset (digest, 0, DIGEST_LEN); 

上述代碼的錯(cuò)誤是錯(cuò)用了宏，雖然錯(cuò)誤比較低級(jí)，但是也犯錯(cuò)的可能性卻挺高。

最后一個(gè)示例：

// example3 
dll_node_t *p_node = malloc (sizeof (dll_node_t)); 
if (p_node == 0) 
{ 
    return; 
} 
memset (p_node, 0, sizeof (dll_t)) 

上述代碼的錯(cuò)誤是在分配時(shí)是以 dll_node_t 類(lèi)型為大小，而后面的 memset() 時(shí)卻以 dll_t 類(lèi)型為大小，造成了錯(cuò)誤。

為了減少錯(cuò)誤，下面代碼使用了 sizeof 來(lái)避免了內(nèi)存操作失誤，首先來(lái)看例程 1 的改進(jìn)版本：

char *buf [MAX_LEN + 1]; 
memset (buf, 0, sizeof (buf)); 

緊接著來(lái)看示例2代碼的改進(jìn)版本：

#define   DIGEST_LEN    17 
#define   DIGEST_MAX    16 
 
char digest [DIGEST_MAX]; 
memset (digest, 0, sizeof (digest)); 

示例3的改進(jìn)版本：

dll_node_t *p_node = malloc (sizeof (*p_node)); 
if (0 == p_node) 
{ 
    return; 
} 
memset (p_node, 0, sizeof (*p_node)) 

小結(jié)

通過(guò)上述代碼可以得到這樣一個(gè)小結(jié)論，使用 sizeof 時(shí)，以需要被初始化的目標(biāo)變量名作為 sizeof() 的參數(shù)?？梢院?jiǎn)化為兩條規(guī)則：

當(dāng)目標(biāo)變量是一個(gè)數(shù)組時(shí)，則采用 sizeof (變量名) 的格式獲取內(nèi)存的大小

當(dāng)目標(biāo)變量是一個(gè)指針時(shí)，則采用 sizeof (*指針變量名) 的格式獲取內(nèi)存的大小。

雖然上述例子是使用 memset 函數(shù)來(lái)介紹 sizeof ，但是這種方法可以運(yùn)行到任何需要獲取變量?jī)?nèi)存大小的場(chǎng)合。

屏蔽編程語(yǔ)言特性

數(shù)組在編程中是經(jīng)常使用到的一個(gè)功能，下述是采用數(shù)組保存一個(gè)會(huì)話(huà) ID 的一段簡(jiǎn)化代碼：

#define    SESSION_ID_LEN_MIN    1 
#define    SESSION_ID_LEN_MAX    256 
 
char g_SessionId[SESSION_ID_LEN_MAX]; 
 
int save_session_id (char *_session_id, int _length) 
{ 
    if (_length < SESSION_ID_LEN_MIN || _length > SESSION_ID_LEN_MAX) 
    { 
        return ERROR; 
    } 
 
    memcpy (g_SessionId, session_id, _length); 
    g_SessionId [_length] = '\0'; 
 
    return SUCESS; 
} 

乍一看，可能覺(jué)得上述代碼也沒(méi)啥問(wèn)題，但是在第一個(gè) if 語(yǔ)句時(shí)，實(shí)際上當(dāng) _length 等于 SESSION_ID_LEN_MAX 時(shí)，數(shù)組實(shí)際上就已經(jīng)越界了，所以上述代碼實(shí)際上是存在問(wèn)題的，那在更改時(shí)，可能會(huì)采取如下的方式進(jìn)行更改。

if (_length < SESSION_ID_LEN_MIN || _length >= SESSION_ID_LEN_MAX) 
{ 
    return ERROR; 
} 

這樣進(jìn)行更改邏輯上是不存在問(wèn)題了， 但是代碼卻變得不是那么直觀了，SESSION_ID_LEN_MAX 字面意思是會(huì)話(huà) ID 的最大長(zhǎng)度，那么這個(gè)最大長(zhǎng)度按理來(lái)說(shuō)應(yīng)該是可以取到的才對(duì)，但是這里當(dāng) _length 等于SESSION_ID_LEN_MAX時(shí)，數(shù)組卻溢出了，當(dāng)看代碼時(shí)看到 >= 時(shí)基本需要停下來(lái)思考一下，想著為什么不能等于 SESSION_ID_LEN_MAX ，不能做到直觀的理解，因此，為了能夠更好的且通順的理解代碼，那么可以這樣來(lái)對(duì)代碼進(jìn)行修改：

#define    SESSION_ID_LEN_MIN    1 
#define    SESSION_ID_LEN_MAX    256 
 
/* 在此處進(jìn)行更改 */ 
char g_SessionId[SESSION_ID_LEN_MAX + 1]; 
 
int save_session_id (char *_session_id, int _length) 
{ 
    if (_length < SESSION_ID_LEN_MIN || _length > SESSION_ID_LEN_MAX) 
    { 
        return ERROR; 
    } 
 
    memcpy (g_SessionId, session_id, _length); 
    g_SessionId [_length] = '\0'; 
 
    return SUCESS; 
} 

通過(guò)上述的更改，也就是讓 SESSION_ID_LEN_MAX 的值減 一，那么這個(gè)時(shí)候 _length 的值也就可以取到 SESSION_ID_LEN_MAX 了，代碼閱讀起來(lái)也就更加地直觀了。

恰當(dāng)?shù)厥褂?goto 語(yǔ)句

我們?cè)诮佑| C 語(yǔ)言編程的時(shí)候，大多都被告知不要使用 goto 語(yǔ)句，以至于有時(shí)候一看到 goto 語(yǔ)句就覺(jué)得程序?qū)懙暮芾鎸?shí)情況是什么樣呢，在編程的時(shí)候 goto 語(yǔ)句并沒(méi)有被禁用，并且如果 goto 運(yùn)用的好的話(huà)，能夠大大簡(jiǎn)化程序，以及提高程序的可讀性和維護(hù)性，下面是沒(méi)有使用 goto 語(yǔ)句的一段代碼，其中存在多處錯(cuò)誤處理代碼，代碼如下所示：

int queue_init (queue ** _pp_queue, int _size) 
{ 
    pthread_mutexattr attr; 
    queue *queue; 
 
    queue = (queue_t *)malloc(sizeof(queue_t)); 
    if (0 == queue) 
    { 
        return -1; 
    } 
    *_pp_queue = queue; 
 
    memset (queue, 0, sizeof (*queue)); 
    queue->size_ = _size; 
    pthread_mutexattr_init (&attr); 
    if (0 != pthread_mutex_init(&queue->mutex_, &attr)) 
    { 
        pthread_mutexattr_destroy (&attr); 
        free (queue); 
        return -1; 
    } 
    queue->messages_ = (void**) malloc (queue->size_ * sizeof (void *)); 
 
    if (0 == queue->messages_) 
    { 
        pthread_mutexattr_destroy (&attr); 
        free (queue); 
        return -1; 
    } 
    if (0 != sem_init(&queue->sem_put_, 0, queue->size)) 
    { 
        free (queue->message_); 
        pthread_mutexattr_destroy (&attr); 
        free (queue); 
        return -1; 
    } 
    pthread_mutexattr_destroy (&attr); 
    return 0; 
} 

通過(guò)上述代碼可以看出在進(jìn)行錯(cuò)誤處理時(shí)，很容易出現(xiàn)遺漏，并且代碼看起來(lái)也比較臃腫，下面是用了 goto 語(yǔ)句之后的代碼：

int queue_init (queue ** _pp_queue, int _size) 
{ 
    pthread_mutexattr attr; 
    queue *queue; 
 
    queue = (queue_t *)malloc(sizeof(queue_t)); 
    if (0 == queue) 
    { 
        return -1; 
    } 
    *_pp_queue = queue; 
 
    memset (queue, 0, sizeof (*queue)); 
    queue->size_ = _size; 
    pthread_mutexattr_init (&attr); 
    if (0 != pthread_mutex_init(&queue->mutex_, &attr)) 
    { 
        goto error; 
    } 
    queue->messages_ = (void**) malloc (queue->size_ * sizeof (void *)); 
 
    if (0 == queue->messages_) 
    { 
        goto error; 
    } 
    if (0 != sem_init(&queue->sem_put_, 0, queue->size)) 
    { 
        goto error1; 
    } 
    pthread_mutexattr_destroy (&attr); 
    return 0; 
 
error1: 
    free (queue->messages_); 
error: 
    pthread_mutexattr_destory (&attr); 
    free (queue); 
    return -1; 
} 

可以看到使用 goto 之后，代碼的可讀性變高了。在使用 goto 的時(shí)候也需要注意以下兩點(diǎn)原則：

• 不能濫用
• 不要讓 goto 語(yǔ)句形成一個(gè)環(huán)。使用 goto 語(yǔ)句應(yīng)該形成一條線，

合理運(yùn)用數(shù)組在多任務(wù)的編程環(huán)境中，有些任務(wù)的生命周期與整個(gè)程序的生命周期是相同的，他們?cè)诔绦虺跏蓟瘯r(shí)被創(chuàng)建，然后運(yùn)行到程序結(jié)束，對(duì)于這樣的任務(wù)，我們稱(chēng)之為具有全局生命周期，如果具有全局生命周期的任務(wù)需要內(nèi)存資源，我們完全可以定義全局或靜態(tài)數(shù)組的方式來(lái)替代動(dòng)態(tài)分配的方式，下面是使用 malloc 來(lái)初始化全局變量 g_aaa_eap_str_buff 的代碼：

#define    MAX_AAA_SS_PORTS        64 
#define    MAX_NUM_PADIUS_IDS      (MAX_AAA_SS_PORTS * 256) 
#define    MAX_EAP_MESSAGE_LEN     4096 
 
static char **g_aaa_eap_str_buff; 
 
void thread_authenticator (void *_arg) 
{ 
    g_aaa_eap_str_buff = (char **) malloc (MAX_NUM_PADIUS_IDS); 
    if (0 == g_aaa_eap_str_buff) 
    { 
        log_error ("Failed to allocate buffer for storing eap string"); 
        return; 
    } 
 
    for (int i = 0; i < MAX_NUM_PADIUS_IDS; i++) 
    { 
        g_aaa_eap_str_buff [i] = (char *) malloc (MAX_EAP_MESSAGE_LEN); 
        if (0 == g_aaa_eap_str_buff [i]) 
        { 
            log_error ("Failed to allocate buffer for storing eap string"); 
        } 
    } 
 
    while (1) 
    { 
        ... 
    } 
} 

上述代碼是通過(guò) malloc 來(lái)動(dòng)態(tài)的獲取內(nèi)存，更好的方式是使用數(shù)組的方式來(lái)獲取內(nèi)存，而且這樣做的好處之一是內(nèi)存的釋放也不需要我們控制，這也就降低了內(nèi)存泄露的可能性。下面是代碼示例：

#define    MAX_AAA_SS_PORTS        64 
#define    MAX_NUM_PADIUS_IDS      (MAX_AAA_SS_PORTS * 256) 
#define    MAX_EAP_MESSAGE_LEN     4096 
 
char g_aaa_eap_str_buff [MAX_NUM_PADIUS_IDS][MAX_EAP_MESSAGE_LEN]; 
 
void thread_authenticator (void *_arg) 
{ 
    while (1) 
    { 
        ...... 
    } 
} 

可以看出來(lái)，使用數(shù)組之后，代碼量變的簡(jiǎn)潔了很多，但是也有一個(gè)地方是需要注意的：由于全局或者靜態(tài)數(shù)組一旦定義，它所占用的內(nèi)存在運(yùn)行期間就不能被釋放，因此在使用數(shù)組這種方式預(yù)留內(nèi)存時(shí)，需要注意是否帶來(lái)內(nèi)存浪費(fèi)問(wèn)題。

結(jié)論

上述便是一部分關(guān)于編程細(xì)節(jié)的內(nèi)容，可以看出來(lái)，合理的使用這些技巧，會(huì)讓代碼變得更改簡(jiǎn)潔，也能夠增加代碼的可讀性，同時(shí)也能夠減少 bug 的出現(xiàn)，這能很大程度上提升代碼的質(zhì)量。

本文轉(zhuǎn)載自微信公眾號(hào)「wenzi嵌入式軟件」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系wenzi嵌入式軟件公眾號(hào)。