『重构--改善既有代码的设计』读书笔记----Extract Method

在编程中，比较忌讳的一件事情就是长函数。因为长函数代表了你这段代码不能很好的复用以及内部可能出现很多别的地方的重复代码，而且这段长函数内部的处理逻辑你也不能很好的看清楚。因此，今天重构第一个手法就是处理长函数--Extract Method,抽取成一个独立的小函数。

我个人来说也很喜欢短小函数，因为他们代表了高强度的复用与灵活性。对于短小函数来说最最关键的就是短小函数的命名，其实你就是给了这些短小函数自我解释的机会，所以你如果给这些短小函数起一个接近其语义的名字，那当你读起长函数来说，就像是阅读一篇你设计好的故事。这个对于你之后的编程也是非常关键的。之前看到一篇文章说过，编程大牛与新手其中一个最重要的区别就是他们对于函数和类以及变量的命名非常谨慎。而我们往往一开始从学校走出来都是清一色的被老师教的i,j,k，尽快改掉这个习惯吧，现在的屏幕这么大，你也不需要去考虑纸张的问题，让变量，函数，类能够解释自身，省去你重新去理解的机会，这样岂不是更好？

一般来说，当你看到长函数，或者一堆函数实现挤在一起，意味着你需要对他们进行分离，又或者你需要实际下手为一堆函数写一个能够让人理解的注释的时候，表示你差不多也需要进行Extract Method了。其实很多时候，只有当你整理了这些函数之后，你才能看到高层应该能够看到的东西。比如这些代码段出现的位置，依赖的具体类更合适的是哪个，函数之间的逻辑关系有没有重复等等。因此，Extract Method能够帮助我更好的理解代码，能够站在更高的角度上去看待一些事情。『重构』一书中作者也提到，当他开始查看别人的代码或者接手别人的工作的时候，对于一些需要Extract Method的地方他会毫不犹豫去修改，重新命名。因为这个重构过程实质就是一个帮助你更好理解的过程。

Extract Method其实很简单，就是把在原来函数的内部的那些语句抽离出来，然后放到一个独立的目标小函数中去，然后在原来函数中的地方修改成对目标函数的调用就可以。但其中需要注意的地方就是局部变量这个东西。下面我们直接看第一个小例子

void printOwing()
{
    // print banner
    cout << "*********" << endl;
    cout << "**Baner**" << endl;
    cout << "*********" << endl;
}

这个例子是最简单的没有局部变量的例子，图中可以看到作者为了让你明白他接下来的3句是打印banner,特意加了注释。其实我们自己也可以看到这三句逻辑性其实就是应该放在一块，所以我们第一步就是创建目标函数printBanner,将这个代码片段复制进去。

void printBanner()
{
    cout << "*********" << endl;
    cout << "**Baner**" << endl;
    cout << "*********" << endl;
}

接下来我们就是找到原来函数的引用点，将这个代码片段替换成对目标函数的调用。

void printOwing()
{
    printBanner();
}

这样即完成了对这个函数的重构。下面来看第二个例子，注意，这个时候开始带局部变量了。（包括源函数的参数以及在源函数下声明的临时变量）

void printOwing()
{
    QString bannerVersion = QString("1.0");

    // print banner
    cout << "*********" << endl;
    cout << "**Baner**" << bannerVersion << endl;
    cout << "*********" << endl;
}

注意这里的区别，此时已经用到了临时变量bannerVersion.并且这个变量是在源函数下声明的，仔细观察可以看到我的提炼代码段并不会去修改他们而是简单的去读取他们，因此我们可以把这种当作参数传给目标函数

void printOwing()
{
    QString bannerVersion = QString("1.0");

    printBanner(bannerVersion);
}

void printBanner(const QString &value)
{
    cout << "*********" << endl;
    cout << "**Baner**" << value << endl;
    cout << "*********" << endl;
}

这样就完成了对于这种情况的重构。停下来看看我们做了什么，有些同学可能觉得这不就是把原来的长函数变成短函数了吗？但你仔细观察你会看到，是的，复用来了，对于我提炼的printBanner这个函数，我只需要一个QString,我就可以完成打印banner的功能，并且灵活性也来了，我可以自由改变版本号version。

接下来我们看第三个例子

void printOwing()
{
    Enumeration e = _orders.elements();
    double outstanding = 0.0;

    printBanner();

    // calcalate outstanding
    while (e.hasMoreElements())
    {
        Order each = e.nextElement();
        outstanding += each.getAmount();
    }
}

在这个例子中，我们需要重构分离出计算outstanding的计算过程，但我们发现了临时变量outstanding需要在目标函数里进行赋值更改，所以我们必须通过目标函数来把它返回，又因为源函数的Enumeration e这个变量只在被提炼代码中会被用到，所以我们可以直接转移他进目标函数，并且发现outstanding这个变量其实就是一个初始化，因此我们最后提炼可以得到这样的结果

void printOwing()
{
    printBanner();
    double outStanding = getOutstanding();
}

double getOutstanding()
{
    Enumeration e = _orders.elements();
    double outstanding = 0.0;

    // calcalate outstanding
    while (e.hasMoreElements())
    {
        Order each = e.nextElement();
        outstanding += each.getAmount();
    }

    return outstanding;
}

另外还有一种情况就是这个变量既需要目标函数作为返回，又需要目标函数对其做处理，则需要将这个变量传给目标函数并将结果返回出来

void printOwing(int val)
{
    Enumeration e = _orders.elements();
    double outstanding = val * ;

    // calcalate outstanding
    while (e.hasMoreElements())
    {
        Order each = e.nextElement();
        outstanding += each.getAmount();
    }
}

对于这种情况我们就要做到既要变量传入，也要将结果传出

void printOwing(int val)
{
    double outstanding = val * ;
    printBanner();
    outStanding = getOutstanding(outStanding);
}

double getOutstanding(int intialValue)
{
    Enumerition e = _orders.elements();
    double outstanding = intialValue;

    // calcalate outstanding
    while (e.hasMoreElements())
    {
        Order each = e.nextElement();
        outstanding += each.getAmount();
    }

    return outstanding;
}

这样即完成了对于拥有临时变量的函数进行Extract Method，希望你会喜欢：）