重构代码的一个例子

概述：重构无止境，重构你的代码，精雕细琢，千锤百炼。

 

我相信不少人都有这种感觉：某天闲暇下来回顾整理以前所写的代码，发现很多地方写得都不够好，代码中竟然存在着如此之多的“坏味道”。

这对于追求艺术的程序员来说是无法接受的。所以要重构代码。

通过下面的例子，看看什么是代码重构：

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

{