重構代碼的一個例子

概述:重構無止境,重構你的代碼,精雕細琢,千錘百煉。

 

我相信不少人都有這種感覺:某天閒暇下來回顧整理以前所寫的代碼,發現很多地方寫得都不夠好,代碼中竟然存在着如此之多的“壞味道”。

這對於追求藝術的程序員來說是無法接受的。所以要重構代碼。

通過下面的例子,看看什麼是代碼重構:

void PrintHello()

{

    CTextHandler strHandler;

    strHandler.SendText(“Hello 2013”, true);

}

函數SendText中的第二個參數代表什麼含義?好吧,我們轉到函數聲明處:

class CTextHandler

{

public:

    void SendText(const string& mag, bool send_new_line);

    //...

};

原來,它表示“是否要加上一個回車換行”。

源代碼最主要的用途是交流,是對意圖的交流。正如Harold Abelson與Gerald Jay Sussman在《The Structure and Interpretation of Computer Programs》中所說的:代碼的主要功能是供別人閱讀,其次纔是計算機執行(Programs must be written for pelple to read, and only incidentally for machines to execute)。

上面的代碼中,bool類型的參數無能傳遞任何有用的信息給讀者,那麼嘗試改變一下。

去掉第二個參數,讓用戶自己加‘\n’,代碼如下:

class CTextHandler

{

public:

    void SendText(const string& msg);

    //...

};

 

CTextHandler strHandler;

strHandler.SendText(“Hello 2012\n”); //換行

strHandler.SendText(“Hello 2013”);   //不換行

 

這樣的設計看似完美,但是一旦bool類型參數所表示的意義有所變化,這樣的方法就會宣告失敗:

void SendText(const string& msg, bool apply_bold);

其中,第二個參數表示是否加粗。那之前的設計方案就沒有用了。

那麼如何適應這多種並且有可能不斷增加的字體格式的需求呢?最笨的方法就是,爲不同的格式提供不同的函數,如下:

void SendText(...);

void SendText_NewLine(...);

void SendText_Bold(...);

//...

 

這違背了Don’t Repeat Yourself原則。

最後的努力,使用枚舉:

class CTextHandler

{

public:

    enum TEXT_FORMAT

    {

        WITH_NEW_LINE,

        NO_NEW_LINE,

    };

    void SendText(const string& msg, TEXT_FORMAT fmt);

};

 

CTextHandler t;

t.SendText(“Hello”, CTextHandler::WITH_NEW_LINE);

t.SendText(“World”, CTextHandler::NO_NEW_LINE);

漂亮的解決方法!但是還不夠完美,需要對枚舉類型進行精心設計,如下:

enum TEXT_FORMAT

{


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