C++的一些設計注意點

轉載

1. C++面向對象程序設計的重要概念

  • 1.1 類與對象

  對象(Object)是類(Class)的一個實例(Instance)。如果將對象比作房子,那麼類就是房子的設計圖紙。所以面向對象程序設計的重點是類的設計,而不是對象的設計。類可以將數據和函數封裝在一起,其中函數表示了類的行爲(或稱服務)。類提供關鍵字public、protected 和private 用於聲明哪些數據和函數是公有的、受保護的或者是私有的。

  這樣可以達到信息隱藏的目的,即讓類僅僅公開必須要讓外界知道的內容,而隱藏其它一切內容。我們不可以濫用類的封裝功能,不要把它當成火鍋,什麼東西都往裏扔。

  類的設計是以數據爲中心,還是以行爲爲中心?

  主張“以數據爲中心”的那一派人關注類的內部數據結構,他們習慣上將private 類型的數據寫在前面,而將public 類型的函數寫在後面

  主張“以行爲爲中心”的那一派人關注類應該提供什麼樣的服務和接口,他們習慣上將public 類型的函數寫在前面,而將private 類型的數據寫在後面

  很多C++教課書主張在設計類時“以數據爲中心”。我堅持並且建議讀者在設計類時“以行爲爲中心”,即首先考慮類應該提供什麼樣的函數。Microsoft 公司的COM 規範的核心是接口設計,COM 的接口就相當於類的公有函數[Rogerson 1999]。在程序設計方面,咱們不要懷疑Microsoft 公司的風格。

  設計孤立的類是比較容易的,難的是正確設計基類及其派生類。因爲有些程序員搞不清楚“繼承”(Inheritance)、“組合”(Composition)、“多態”( Polymorphism)這些概念。

  • 1.2 繼承與組合

  如果A 是基類,B 是A 的派生類,那麼B 將繼承A 的數據和函數。示例程序如下:


class A
{
    public:
    void Func1(void);
    void Func2(void);
};
class B : public A
{
    public:
    void Func3(void);
    void Func4(void);
};
// Example
main()
{
    B b; // B的一個對象
    b.Func1(); // B 從A 繼承了函數Func1
    b.Func2(); // B 從A 繼承了函數Func2
    b.Func3();
    b.Func4();
}

  這個簡單的示例程序說明了一個事實:C++的“繼承”特性可以提高程序的可複用性。正因爲“繼承”太有用、太容易用,纔要防止亂用“繼承”。我們要給“繼承”立一些使用規則:

  • 1. 如果類A 和類B 毫不相關,不可以爲了使B 的功能更多些而讓B 繼承A 的功能。

  不要覺得“不吃白不吃”,讓一個好端端的健壯青年無緣無故地吃人蔘補身體。

  • 2. 如果類B 有必要使用A 的功能,則要分兩種情況考慮:

  (1)若在邏輯上B 是A 的“一種”(a kind of ),則允許B 繼承A 的功能。如男人(Man)是人(Human)的一種,男孩(Boy)是男人的一種。那麼類Man 可以從類Human 派生,類Boy 可以從類Man 派生。示例程序如下:


class Human
{

};
class Man : public Human
{

};
class Boy : public Man
{

};

  (2)若在邏輯上A 是B 的“一部分”(a part of),則不允許B 繼承A的功能,而是要用A和其它東西組合出B。例如眼(Eye)、鼻(Nose)、口(Mouth)、耳(Ear)是頭(Head)的一部分,所以類Head 應該由類Eye、Nose、Mouth、Ear 組合而成,不是派生而成。示例程序如下:


class Eye
{
    public:
    void Look(void);
};
class Nose
{
    public:
    void Smell(void);
};
class Mouth
{
    public:
    void Eat(void);
};
class Ear
{
    public:
    void Listen(void);
};
// 正確的設計,冗長的程序
class Head
{
public:
    void Look(void) { m_eye.Look(); }
    void Smell(void) { m_nose.Smell(); }
    void Eat(void) { m_mouth.Eat(); }
    void Listen(void) { m_ear.Listen(); }
private:
    Eye m_eye;
    Nose m_nose;
    Mouth m_mouth;
    Ear m_ear;
};

  如果允許Head 從Eye、Nose、Mouth、Ear 派生而成,那麼Head 將自動具有Look、Smell、Eat、Listen 這些功能:

// 錯誤的設計


class Head : public Eye, public Nose, public Mouth, public Ear
{

};

  上述程序十分簡短並且運行正確,但是這種設計卻是錯誤的。很多程序員經不起“繼承”的誘惑而犯下設計錯誤。

  一隻公雞使勁地追打一隻剛下了蛋的母雞,你知道爲什麼嗎?

  因爲母雞下了鴨蛋。

  • 1.3 虛函數與多態

  除了繼承外,C++的另一個優良特性是支持多態,即允許將派生類的對象當作基類的對象使用。如果A 是基類,B 和C 是A 的派生類,多態函數Test 的參數是A 的 指針。那麼Test 函數可以引用A、B、C 的對象。示例程序如下:


class A
{
public:
    void Func1(void);
};
void Test(A *a)
{
    a->Func1();
}
class B : public A
{

};
class C : public A
{

};
// Example
main()
{
    A a;
    B b;
    C c;
    Test(&a);
    Test(&b);
    Test(&c);
};

  以上程序看不出“多態”有什麼價值,加上虛函數和抽象基類後,“多態”的威力就顯示出來了。

  C++用關鍵字virtual 來聲明一個函數爲虛函數,派生類的虛函數將(override)基類對應的虛函數的功能。示例程序如下:


class A
{
public:
    virtual void Func1(void){ cout<< “This is A::Func1 \n”}
};
void Test(A *a)
{
    a->Func1();
}
class B : public A
{
public:
    virtual void Func1(void){ cout<< “This is B::Func1 \n”}
};
class C : public A
{
public:
    virtual void Func1(void){ cout<< “This is C::Func1 \n”}
};
// Example
main()
{
    A a;
    B b;
    C c;
    Test(&a); // 輸出This is A::Func1
    Test(&b); // 輸出This is B::Func1
    Test(&c); // 輸出This is C::Func1
};

  如果基類A 定義如下:


class A
{
public:
    virtual void Func1(void)=0;
};

  那麼函數Func1 叫作純虛函數,含有純虛函數的類叫作抽象基類。抽象基類只管定義純虛函數的形式,具體的功能由派生類實現。

  結合“抽象基類”和“多態”有如下突出優點:

  • 1.應用程序不必爲每一個派生類編寫功能調用,只需要對抽象基類進行處理即可。這一

    招叫“以不變應萬變”,可以大大提高程序的可複用性(這是接口設計的複用,而不是代碼實現的複用)。

  • 2.派生類的功能可以被基類指針引用,這叫向後兼容,可以提高程序的可擴充性和可維護性。以前寫的程序可以被將來寫的程序調用不足爲奇,但是將來寫的程序可以被以前寫的程序調用那可了不起

2 良好的編程風格

  內功深厚的武林高手出招往往平淡無奇。同理,編程高手也不會用奇門怪招寫程序。良好的編程風格是產生高質量程序的前提。

  • 2.1 命名約定

  有不少人編程時用拼音給函數或變量命名,這樣做並不能說明你很愛國,卻會讓用此程序的人迷糊(很多南方人不懂拼音,我就不懂)。程序中的英文一般不會太複雜,用詞要力求準確。匈牙利命名法是Microsoft 公司倡導的[Maguire 1993],雖然很煩瑣,但用習慣了也就成了自然。沒有人強迫你採用何種命名法,但有一點應該做到:自己的程序命名必須一致。

  以下是我編程時採用的命名約定:

  • 宏定義用大寫字母加下劃線表示,如MAX_LENGTH;

  • 函數用大寫字母開頭的單詞組合而成,如SetName, GetName ;

  • 指針變量加前綴p,如*pNode ;

  • BOOL 變量加前綴b,如bFlag ;

  • int 變量加前綴i,如iWidth ;

  • float 變量加前綴f,如fWidth ;

  • double 變量加前綴d,如dWidth ;

  • 字符串變量加前綴str,如strName ;

  • 枚舉變量加前綴e,如eDrawMode ;

  • 類的成員變量加前綴m_,如m_strName, m_iWidth ;

  對於int, float, double 型的變量,如果變量名的含義十分明顯,則不加前綴,避免煩瑣。如用於循環的int 型變量i,j,k ;float 型的三維座標(x,y,z)等。

  • 2.2 使用斷言

  程序一般分爲Debug 版本和Release 版本,Debug 版本用於內部調試,Release 版本發行給用戶使用。斷言assert 是僅在Debug 版本起作用的宏,它用於檢查“不應該”發生的情況。以下是一個內存複製程序,在運行過程中,如果assert 的參數爲假,那麼程序就會中止(一般地還會出現提示對話,說明在什麼地方引發了assert)。


//複製不重疊的內存塊
void memcpy(void *pvTo, void *pvFrom, size_t size)
{
    void *pbTo = (byte *) pvTo;
    void *pbFrom = (byte *) pvFrom;
    assert( pvTo != NULL && pvFrom != NULL );
    while(size - - > 0 )
    *pbTo + + = *pbFrom + + ;
    return (pvTo);
}

  assert 不是一個倉促拼湊起來的宏,爲了不在程序的Debug 版本和Release 版本引起差別,assert 不應該產生任何副作用。所以assert 不是函數,而是宏。程序員可以把assert 看成一個在任何系統狀態下都可以安全使用的無害測試手段。

  很少有比跟蹤到程序的斷言,卻不知道該斷言的作用更讓人沮喪的事了。你化了很多時間,不是爲了排除錯誤,而只是爲了弄清楚這個錯誤到底是什麼。有的時候,程序員偶爾還會設計出有錯誤的斷言。所以如果搞不清楚斷言檢查的是什麼,就很難判斷錯誤是出現在程序中,還是出現在斷言中。幸運的是這個問題很好解決,只要加上清晰的註釋即可。這本是顯而易見的事情,可是很少有程序員這樣做。這好比一個人在森林裏,看到樹上釘着一塊“危險”的大牌子。但危險到底是什麼?樹要倒?有廢井?有野獸?除非告訴人們“危險”是什麼,否則這個警告牌難以起到積極有效的作用。難以理解的斷言常常被程序員忽略,甚至被刪除。[Maguire 1993]

  以下是使用斷言的幾個原則:

  • 使用斷言捕捉不應該發生的非法情況。不要混淆非法情況與錯誤情況之間的區別,後者是必然存在的並且是一定要作出處理的。

  • 使用斷言對函數的參數進行確認。

  • 在編寫函數時,要進行反覆的考查,並且自問:“我打算做哪些假定?”一旦確定了的
    假定,就要使用斷言對假定進行檢查。

  • 一般教科書都鼓勵程序員們進行防錯性的程序設計,但要記住這種編程風格會隱瞞錯誤。當進行防錯性編程時,如果“不可能發生”的事情的確發生了,則要使用斷言進行報警。

  • 2.3 new、delete 與指針

  在C++中,操作符new 用於申請內存,操作符delete 用於釋放內存。在C 語言中,函數malloc 用於申請內存,函數free 用於釋放內 存。由於C++兼容C 語言,所以new、delete、malloc、free 都有可能一起使用。new 能比malloc 幹更多的事,它可以申請對象的內存,而malloc 不能。C++和C 語言中的指針威猛無比,用錯了會帶來災難。對於一個指針p,如果是用new申請的內存,則必須用delete 而不能用free 來釋放。如果是用malloc 申請的內存,則必須用free 而不能用delete 來釋放。在用delete 或用free 釋放p 所指的內存後,應該馬上顯式地將p 置爲NULL,以防下次使用p 時發生錯誤。示例程序如下:

void Test(void)
{
    float *p;
    p = new float[100];
    if(p==NULL) return;
    …// do something
    delete p;
    p=NULL; // 良好的編程風格
    // 可以繼續使用p
    p = new float[500];
    if(p==NULL) return;
    …// do something else
    delete p;
    p=NULL;
}

  我們還要預防“野指針”,“野指針”是指向“垃圾”內存的指針,主要成因有兩種:

  • 指針沒有初始化。
  • 指針指向已經釋放的內存,這種情況最讓人防不勝防,示例程序如下:

class A
{
public:
    void Func(void){…}
};
void Test(void)
{
    A *p;
    {
        A a;
        p = &a; // 注意a 的生命期
    }
    p->Func(); // p 是“野指針”,程序出錯
}
  • 2.4 使用const

    在定義一個常量時,const 比#define 更加靈活。用const 定義的常量含有數據類型,該常量可以參與邏輯運算。例如:

const int LENGTH = 100; // LENGTH 是int 類型
const float MAX=100; // MAX 是float 類型
#define LENGTH 100 // LENGTH 無類型
#define MAX 100 // MAX 無類型

  除了能定義常量外,const 還有兩個“保護”功能:

  • 1 強制保護函數的參數值不發生變化

  以下程序中,函數f 不會改變輸入參數name 的值,但是函數g 和h 都有可能改變name的值。


void f(String s); // pass by value
void g(String &s); // pass by referance
void h(String *s); // pass by pointer
main()
{
String name=“Dog”;
f(name); // name 的值不會改變
g(name); // name 的值可能改變
h(name); // name 的值可能改變
}

  對於一個函數而言,如果其‘&’或‘*’類型的參數只作輸入用,不作輸出用,那麼應當在該參數前加上const,以確保函數的代碼不會改變該參數的值(如果改變了該參數的值,編譯器會出現錯誤警告)。因此上述程序中的函數g 和h 應該定義成:


void g(const String &s);
void h(const String *s);
  • 2 強制保護類的成員函數不改變任何數據成員的值

  以下程序中,類stack 的成員函數Count 僅用於計數,爲了確保Count 不改變類中的任何數據成員的值,應將函數Count 定義成const 類型。


class Stack
{
public:
    void push(int elem);
    void pop(void);
    int Count(void) const; // const 類型的函數
    private:
    int num;
    int data[100];
};
int Stack::Count(void) const
{
    ++ num; // 編譯錯誤,num 值發生變化
    pop(); // 編譯錯誤,pop 將改變成員變量的值
    return num;
}
  • 2.5 其它建議

  • 編寫一條過分複雜的語句,緊湊的C++/C 代碼並不見到能得到高效率的機器代碼,卻會降低程序的可理解性,程序出錯誤的機率也會提高。
  • 不要編寫集多種功能於一身的函數,在函數的返回值中,不要將正常值和錯誤標誌混在一起。
  • 不要將BOOL 值TRUE 和FALSE 對應於1 和0 進行編程。大多數編程語言將FALSE定義爲0,任何非0 值都是TRUE。Visual C++將TRUE 定義爲1,而Visual Basic 則將TRUE定義爲-1。示例程序如下:
BOOL flag;

if(flag) { // do something } // 正確的用法
if(flag==TRUE) { // do something } // 危險的用法
if(flag==1) { // do something } // 危險的用法
if(!flag) { // do something } // 正確的用法
if(flag==FALSE) { // do something } // 不合理的用法
if(flag==0) { // do something } // 不合理的用法
  • 小心不要將“= =”寫成“=”,編譯器不會自動發現這種錯誤。

  • 不要將123 寫成0123,後者是八進制的數值。

  • 將自己經常犯的編程錯誤記錄下來,製成表格貼在計算機旁邊。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章