當前位置: 妍妍網 > 碼農

如何編寫可讀性高的 C 程式碼?

2024-06-07碼農

物件導向的 C

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

基礎知識

結構體

除了提供基本數據型別外,C 語言還提供給使用者自己客製數據型別的能力,那就是結構體,在 C 語言中,你可以用結構體來表示任何實體。結構體正是物件導向語言中的類的概念的雛形,比如:

typedefstruct{
float x; 
float y; 
 }Point;

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

結構體中的域稱為結構體的成員。結構體中的數據型別可以是簡單數據型別,也可以是其他的結構體,甚至結構體本身還可以巢狀,比如,一個標準的連結串列結構可以進行如下定義:

typedefstructnode{
void *data;// 數據指標
int dataLength;// 數據長度
structnode *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):

classBox{
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 
// 定義連結串列中的節點結構
typedefstructnode{
void *data; 
structnode *next;
 }Node; 
// 定義連結串列結構
typedefstructlist{
structlist *_this;
Node *head; 
int size; 
void (*insert)(void *node);// 函式指標
void (*drop)(void *node); 
void (*clear)(); 
int (*getSize)(); 
void* (*get)(int index); 
void (*print)(); 
 }List; 
voidinsert(void *node)
voiddrop(void *node)
voidclear()
intgetSize()
voidget(int index)
voidprint()
#endif/* _ILIST_H */


IList 介面中,可以清晰的看到,對於一個 list 實體 ( 也就是物件 ) 來說,可以在其上進行 insert, drop, clear, getSize, get(index) 以及 print 等操作。

介面的實作

清單 2. 構造方法

Node *node = NULL
 List *list = NULL
voidinsert(void *node)
voiddrop(void *node)
voidclear()
intgetSize()
voidprint()
voidget(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 物件上
voidinsert(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 
voiddrop(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; 
 }

其他的實作程式碼可以參看下載部份,這裏限於篇幅就不再意義列舉出來。

測試

測試程式碼

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

intmain(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\n",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\n",list->getSize()); 
list->clear();// 清空列表
return0
 }





圖 1. 執行結果

結束語

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

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

<END>

點這裏👇關註我,記得標星呀~

感謝你的分享,點贊,在看三