提高C代碼可讀性的編寫技巧與策略

面向對象的 C

面向對象的語言更接近人的思維方式，而且在很大程度上降低了代碼的復雜性，同時提高了代碼的可讀性和可維護性，傳統的 C 代碼同樣可以設計出比較易讀，易維護，復雜度較低的優美代碼，本文將通過一個實際的例子來說明這一點。

基礎知識

結構體

除了提供基本數據類型外，C 語言還提供給用戶自己定制數據類型的能力，那就是結構體，在 C 語言中，你可以用結構體來表示任何實體。結構體正是面向對象語言中的類的概念的雛形，比如：

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

定義了一個平面坐標系中的一個點，點中有兩個域，x 坐標和 y 坐標。

結構體中的域稱為結構體的成員。結構體中的數據類型可以是簡單數據類型，也可以是其他的結構體，甚至結構體本身還可以嵌套，比如，一個標準的鏈表結構可以進行如下定義：

typedef?struct?node{?
????void?*data;//?數據指針
????int?dataLength;//?數據長度
????struct?node?*next;//?指向下一個節點
?}Node;

可以看到，結構體 node 中的 next 指針的類型又是 node 類型。

函數指針

指針是 C 語言的靈魂，是 C 比其他語言更靈活，更強大的地方。所以學習 C 語言必須很好的掌握指針。函數指針，即指向函數在內存映射中的首地址的指針，通過函數指針，可以將函數作為參數傳遞給另一個函數，并在適當的時候調用，從而實現異步通信等功能。

比如， UNIX/Linux 系統中的信號注冊函數，其原型如下：

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

使用的時候，需要自己在外部定義一個信號處理函數 (signal handler), 然后使用 signal(sigNo, handler) 將處理程序注冊在進程上，當信號發生時，進程就可以回調信號處理函數。

將函數指針作為結構體的成員

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

面向對象語言的特性

一般而言，繼承，封裝和多態被認為是面向對象語言所必須支持的三種特征，也正是通過這三種特征才可以體現出面向對象在哪些方面優于面向過程。

由于語言開發商的宣傳或其他的各種原因，使的表面上面向對象的思想要通過語言為載體而得以實現，然而實際上，面向對象是一種軟件設計思想，完全是可以與具體實現無關的。

雖然如此，但是不可否認，這些所謂的純面向對象的語言，在其代碼的可讀性以及與人的自然思維的匹配方面，比面向過程的語言要好的多。

語言層次的面向對象

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

在面向對象的語言中，通常將這樣的對象抽象成一個類 (class):

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

對盒子進行操作時，可以做一下動作：

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

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

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

而顯然，第一種代碼形式更符合常理，所以面向對象的語言大都提供這種語言層面的細節的支持，使得代碼的可讀性，可理解性大大增加。

C 語言，作為一個靈活而簡單的語言，我們完全可以通過 C 提供的簡單機制，實現這樣的比較優美的代碼形式。

C 語言的面向對象

如前所說，面向對象是一種軟件設計的思想，是語言無關的。在本節中，我舉一個鏈表(list)的例子來說明如何在 C 語言中的設計出有面向對象風格的代碼。

定義接口

接口是面向對象語言中的一個比較重要的概念，接口只對外部承諾實現該接口的實體可以完成什么樣的功能，但是不暴露實現的方式。這樣的好處是，實現者可以在不接觸接口使用者的代碼的情況下，對實現進行調整。

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

清單 1. 鏈表的接口定義

#ifndef?_ILIST_H?
?#define???_ILIST_H?
?
?//?定義鏈表中的節點結構
?typedef?struct?node{?
????void?*data;?
????struct?node?*next;?
?}Node;?
?
?//?定義鏈表結構
?typedef?struct?list{?
????struct?list?*_this;?
????Node?*head;?
????int?size;?
????void?(*insert)(void?*node);//?函數指針
????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 接口中，可以清晰的看到，對于一個 list 實體 ( 也就是對象 ) 來說，可以在其上進行 insert, drop, clear, getSize, get(index) 以及 print 等操作。

接口的實現

清單 2. 構造方法

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?函數實現注冊在?list?實體上
????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. 插入及刪除

//?將一個?node?插入到一個?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)++;?
?}?
?
?//?刪除一個指定的節點?node?
?void?drop(void?*node){?
????Node?*t?=?list->_this->head;?
????Node?*d?=?NULL;?
????int?i?=?0;?
????for(i;i?_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;?
?}

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

測試

測試代碼

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

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

圖 1. 運行結果

結束語

C 語言所誕生的UNIX平臺提倡這樣一種設計哲學：盡量進行簡單的設計，讓使用者如同搭積木一樣的將這些簡單的工具連接成強大的，完整的應用。

應該說，C 比較好的繼承了這一點，C 語言非常簡潔，非常強大，而由于 C 語言誕生的比較早，當時的面向對象的思想還不成熟，所以出現了大量的過程式的 C 應用，從而給人們一種 C 語言是面向過程的語言的錯覺，其實 C 只是提供了一些簡單，強大而通用的能力，至于你想將其搭成什么樣的積木，則全靠你自己了。

審核編輯：黃飛

?