如何編寫可讀性高的C代碼？

面向?qū)ο蟮腃

面向?qū)ο蟮恼Z言更接近人的思維方式，而且在很大程度上降低了代碼的復(fù)雜性，同時(shí)提高了代碼的可讀性和可維護(hù)性，傳統(tǒng)的 C 代碼同樣可以設(shè)計(jì)出比較易讀，易維護(hù)，復(fù)雜度較低的優(yōu)美代碼，本文將通過一個(gè)實(shí)際的例子來說明這一點(diǎn)。

基礎(chǔ)知識

結(jié)構(gòu)體

除了提供基本數(shù)據(jù)類型外，C 語言還提供給用戶自己定制數(shù)據(jù)類型的能力，那就是結(jié)構(gòu)體，在 C 語言中，你可以用結(jié)構(gòu)體來表示任何實(shí)體。結(jié)構(gòu)體正是面向?qū)ο笳Z言中的類的概念的雛形，比如：

typedef struct{ 
    float x; 
    float y; 
 }Point;

定義了一個(gè)平面坐標(biāo)系中的一個(gè)點(diǎn)，點(diǎn)中有兩個(gè)域，x 坐標(biāo)和 y 坐標(biāo)。

結(jié)構(gòu)體中的域稱為結(jié)構(gòu)體的成員。結(jié)構(gòu)體中的數(shù)據(jù)類型可以是簡單數(shù)據(jù)類型，也可以是其他的結(jié)構(gòu)體，甚至結(jié)構(gòu)體本身還可以嵌套，比如，一個(gè)標(biāo)準(zhǔn)的鏈表結(jié)構(gòu)可以進(jìn)行如下定義：

typedef struct node{ 
    void *data;// 數(shù)據(jù)指針
    int dataLength;// 數(shù)據(jù)長度
    struct node *next;// 指向下一個(gè)節(jié)點(diǎn)
 }Node;

可以看到，結(jié)構(gòu)體 node 中的 next 指針的類型又是 node 類型。

函數(shù)指針

指針是 C 語言的靈魂，是 C 比其他語言更靈活，更強(qiáng)大的地方。所以學(xué)習(xí) C 語言必須很好的掌握指針。函數(shù)指針，即指向函數(shù)在內(nèi)存映射中的首地址的指針，通過函數(shù)指針，可以將函數(shù)作為參數(shù)傳遞給另一個(gè)函數(shù)，并在適當(dāng)?shù)臅r(shí)候調(diào)用，從而實(shí)現(xiàn)異步通信等功能。

比如， UNIX/Linux 系統(tǒng)中的信號注冊函數(shù)，其原型如下：

void (*signal(int signo,void (*func)(int))) (int)

使用的時(shí)候，需要自己在外部定義一個(gè)信號處理函數(shù) (signal handler), 然后使用 signal(sigNo, handler) 將處理程序注冊在進(jìn)程上，當(dāng)信號發(fā)生時(shí)，進(jìn)程就可以回調(diào)信號處理函數(shù)。

將函數(shù)指針作為結(jié)構(gòu)體的成員

正如前面提到的，結(jié)構(gòu)體的成員可以是簡單的數(shù)據(jù)結(jié)構(gòu)，也可以是其他的結(jié)構(gòu)體，當(dāng)然，也可以是指針。當(dāng)將函數(shù)指針作為結(jié)構(gòu)體的成員，并且這些函數(shù)只用來操作本結(jié)構(gòu)體中的數(shù)據(jù)時(shí)，就可以形成一個(gè)獨(dú)立的實(shí)體，這個(gè)實(shí)體中既有數(shù)據(jù)，也有對數(shù)據(jù)的操作，這樣自然就可以引出類(class)的概念。

面向?qū)ο笳Z言的特性

一般而言，繼承，封裝和多態(tài)被認(rèn)為是面向?qū)ο笳Z言所必須支持的三種特征，也正是通過這三種特征才可以體現(xiàn)出面向?qū)ο笤谀男┓矫鎯?yōu)于面向過程。

由于語言開發(fā)商的宣傳或其他的各種原因，使的表面上面向?qū)ο蟮乃枷胍ㄟ^語言為載體而得以實(shí)現(xiàn)，然而實(shí)際上，面向?qū)ο笫且环N軟件設(shè)計(jì)思想，完全是可以與具體實(shí)現(xiàn)無關(guān)的。

雖然如此，但是不可否認(rèn)，這些所謂的純面向?qū)ο蟮恼Z言，在其代碼的可讀性以及與人的自然思維的匹配方面，比面向過程的語言要好的多。

語言層次的面向?qū)ο?/p>

我們一般要描述一個(gè)對象，一般需要描述這個(gè)對象的一些屬性，比如盒子(box) 是一個(gè)實(shí)體，它有 6 個(gè)面，有顏色，重量，是否為空等屬性，并且可以放東西進(jìn)去，可以取東西出來。

在面向?qū)ο蟮恼Z言中，通常將這樣的對象抽象成一個(gè)類 (class):

class Box{ 
    clolr color; 
    int weight; 
    boolean empty; 
    
    put(something); 
    something get(); 
 }

對盒子進(jìn)行操作時(shí)，可以做一下動(dòng)作：

 Box.put(cake); 
 Box.get();// 取到某個(gè)東西，從盒子中。

而面向過程的語言中，通常是將實(shí)體傳遞給一個(gè)貫穿全局的函數(shù)來進(jìn)行的，同樣以 Box 為例，對 Box 進(jìn)行操作時(shí)，往往是這樣：

 Put(Box, cake);// 將一個(gè)蛋糕放到盒子中
 Get(Box);// 從盒子中取出某個(gè)東西來

而顯然，第一種代碼形式更符合常理，所以面向?qū)ο蟮恼Z言大都提供這種語言層面的細(xì)節(jié)的支持，使得代碼的可讀性，可理解性大大增加。

C 語言，作為一個(gè)靈活而簡單的語言，我們完全可以通過 C 提供的簡單機(jī)制，實(shí)現(xiàn)這樣的比較優(yōu)美的代碼形式。

C 語言的面向?qū)ο?/strong>

如前所說，面向?qū)ο笫且环N軟件設(shè)計(jì)的思想，是語言無關(guān)的。在本節(jié)中，我舉一個(gè)鏈表(list)的例子來說明如何在 C 語言中的設(shè)計(jì)出有面向?qū)ο箫L(fēng)格的代碼。

定義接口

接口是面向?qū)ο笳Z言中的一個(gè)比較重要的概念，接口只對外部承諾實(shí)現(xiàn)該接口的實(shí)體可以完成什么樣的功能，但是不暴露實(shí)現(xiàn)的方式。這樣的好處是，實(shí)現(xiàn)者可以在不接觸接口使用者的代碼的情況下，對實(shí)現(xiàn)進(jìn)行調(diào)整。

我們來看看鏈表的接口定義：

清單 1. 鏈表的接口定義

#ifndef _ILIST_H 
 #define   _ILIST_H 
 
 // 定義鏈表中的節(jié)點(diǎn)結(jié)構(gòu)
 typedef struct node{ 
    void *data; 
    struct node *next; 
 }Node; 
 
 // 定義鏈表結(jié)構(gòu)
 typedef struct list{ 
    struct list *_this; 
    Node *head; 
    int size; 
    void (*insert)(void *node);// 函數(shù)指針
    void (*drop)(void *node); 
    void (*clear)(); 
    int (*getSize)(); 
    void* (*get)(int index); 
    void (*print)(); 
 }List; 
 
 void insert(void *node); 
 void drop(void *node); 
 void clear(); 
 int getSize(); 
 void* get(int index); 
 void print(); 
 
 #endif   /* _ILIST_H */

IList 接口中，可以清晰的看到，對于一個(gè) list 實(shí)體 ( 也就是對象 ) 來說，可以在其上進(jìn)行 insert, drop, clear, getSize, get(index) 以及 print 等操作。

接口的實(shí)現(xiàn)

清單 2. 構(gòu)造方法

Node *node = NULL; 
 List *list = NULL; 
 
 void insert(void *node); 
 void drop(void *node); 
 void clear(); 
 int getSize(); 
 void print(); 
 void* get(int index); 
 
 List *ListConstruction(){ 
    list = (List*)malloc(sizeof(List)); 
    node = (Node*)malloc(sizeof(Node)); 
    list->head = node; 
    list->insert = insert;// 將 insert 函數(shù)實(shí)現(xiàn)注冊在 list 實(shí)體上
    list->drop = drop; 
    list->clear = clear; 
    list->size = 0; 
    list->getSize = getSize; 
    list->get = get; 
    list->print = print; 
    list->_this = list;// 用 _this 指針將 list 本身保存起來
 
    return (List*)list; 
 }

需要注意的是此處的 _ this 指針，_this 指針可以保證外部對 list 的操作映射到對 _this 的操作上，從而使得代碼得到簡化。清單 3. 插入及刪除

// 將一個(gè) node 插入到一個(gè) list 對象上
 void insert(void *node){ 
    Node *current = (Node*)malloc(sizeof(Node)); 
    
    current->data = node; 
    current->next = list->_this->head->next; 
    list->_this->head->next = current; 
    (list->_this->size)++; 
 } 
 
 // 刪除一個(gè)指定的節(jié)點(diǎn) node 
 void drop(void *node){ 
    Node *t = list->_this->head; 
    Node *d = NULL; 
    int i = 0; 
    for(i;i < list->_this->size;i++){ 
        d = list->_this->head->next; 
        if(d->data == ((Node*)node)->data){ 
            list->_this->head->next = d->next; 
            free(d); 
            (list->_this->size)--; 
            break; 
        }else{ 
            list->_this->head = list->_this->head->next; 
        } 
    } 
    list->_this->head = t; 
 }

其他的實(shí)現(xiàn)代碼可以參看下載部分，這里限于篇幅就不再意義列舉出來。

測試

測試代碼

好了，前面做的一切工作都是為了保證我們的暴露給使用者的 API 可以盡量的簡潔，優(yōu)美，現(xiàn)在到測試的時(shí)候了：清單 4. 測試代碼

int main(int argc, char** argv) { 
    List *list = (List*)ListConstruction();// 構(gòu)造一個(gè)新的鏈表
    
 // 插入一些值做測試
    list->insert("Apple"); 
    list->insert("Borland"); 
    list->insert("Cisco"); 
    list->insert("Dell"); 
    list->insert("Electrolux"); 
    list->insert("FireFox"); 
    list->insert("Google"); 
    
    list->print();// 打印整個(gè)列表
            
    printf("list size = %dn",list->getSize()); 
    
    Node node; 
    node.data = "Electrolux"; 
    node.next = NULL;  
    list->drop(&node);// 刪除一個(gè)節(jié)點(diǎn)
    
    node.data = "Cisco"; 
    node.next = NULL; 
    list->drop(&node);// 刪除另一個(gè)節(jié)點(diǎn)
    
    list->print();// 再次打印
    printf("list size = %dn",list->getSize()); 
    list->clear();// 清空列表
 
    return 0; 
 }

圖 1. 運(yùn)行結(jié)果

結(jié)束語

C 語言所誕生的UNIX平臺提倡這樣一種設(shè)計(jì)哲學(xué)：盡量進(jìn)行簡單的設(shè)計(jì)，讓使用者如同搭積木一樣的將這些簡單的工具連接成強(qiáng)大的，完整的應(yīng)用。

應(yīng)該說，C 比較好的繼承了這一點(diǎn)，C 語言非常簡潔，非常強(qiáng)大，而由于 C 語言誕生的比較早，當(dāng)時(shí)的面向?qū)ο蟮乃枷脒€不成熟，所以出現(xiàn)了大量的過程式的 C 應(yīng)用，從而給人們一種 C 語言是面向過程的語言的錯(cuò)覺，其實(shí) C 只是提供了一些簡單，強(qiáng)大而通用的能力，至于你想將其搭成什么樣的積木，則全靠你自己了。

本文來源網(wǎng)絡(luò)，免費(fèi)傳達(dá)知識，版權(quán)歸原作者所有。如涉及作品版權(quán)問題，請聯(lián)系我進(jìn)行刪除。