『重构--改善既有代码的设计』读书笔记----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 * 2;

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

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

void printOwing(int val)
{
    double outstanding = val * 2;
    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,希望你会喜欢:)

时间: 2024-08-10 02:21:38

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

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

有时候,当你遇到一个大型函数,里面的临时变量和参数多的让你觉得根本无法进行Extract Method.重构中也大力的推荐短小函数的好处,它所带来的解释性,复用性让你收益无穷.但如果你遇到上种情况,你可能会天真的以为我只要适当的进行Replace Temp with Query,就可以把这种现象给化解.但情况往往事与愿违,不能达到你所理想的高度.这个时候你需要用到重构中的杀手锏--Replace Method with Method Object,这个手法出自Kent Beck [Beck].

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

明确函数所在类的位置是很重要的.这样可以避免你的类与别的类有太多耦合.也会让你的类的内聚性变得更加牢固,让你的整个系统变得更加整洁.简单来说,如果在你的程序中,某个类的函数在使用的过程中,更多的是在和别的类进行交互,调用后者或者被后者调用,那么你就要注意了,你要去判断这个类是否真正适合他原来所在的类. 简单来说,这套手法就是在该函数最常引用的新类中建立一个有着类似行为的新函数,让旧函数变成一个单纯的委托函数或者完全删掉. Move Method是重构理论的支柱.如果一个类的责任太多,或者一个类和

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

在面向对象中,对于类这个概念我们应该有一个清晰的责任认识,就是每个类应该只有一个变化点,每个类的变化应该只受到单一的因素,即每个类应该只有一个明确的责任.当然了,说时容易做时难,很多人可能都会和我一样,一开始建立类的时候信心满满,牢记SRP原则,但随着开发进度的不断进行,很有可能你会给你原本设计好的类增加新字段或者增加新函数,对于少量的增加你可能会因为麻烦,考虑不去单独做一个新类来分解.久而久之,你这个类会变得越来越臃肿,所掌管的责任也会越来越多.这样的类往往还有大量的数据和函数,往往太大而不易

『重构--改善既有代码的设计』读书笔记----Replace Temp with Query

Replace Temp with Query,顾名思义,表示你用查询来替换临时变量本身,临时变量对于函数来说是只有当前函数可见的,如果你在同类的别的地方要用到这个变量你就必须重新写表达式来获取这个变量,这样的话你就会在不经意间让你的函数变得复杂起来,所以如果你想要使用Extract Method,那么Replace Temp with Query是必不可少的一个步骤.而我们前面介绍的Inline Temp其实是这个手法的一部分,两者的区别在于Inline Temp已经有了表达式自身,只需要做简

『重构--改善既有代码的设计』读书笔记----代码坏味道【3】

星期六了,适当出去放松了下,回来继续我们重构的话题.今天是坏味道[3]了,很多朋友跟我私信,叫我把坏味道出完,再出手法.其实这是有道理的,很多时候,"发现"远比"怎么做"重要的多.就拿设计模式来讲,GoF里面的设计模式相信有很多人都了解过.具体的设计模式应该怎么实现啊相信有很多人都背的滚瓜烂熟,但问题的难点往往在于你应该什么时候用这个设计模式.重构也一样,手法步骤都是死的,关键在于应该发现什么时候应该重构.所以,我还是决定继续出坏味道,把坏味道全部出完我们再去学手法

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

重构可以把复杂的东西分解成一个个简单的小块.但有时候,你必须壮士断腕删掉整个算法,用简单的算法来取代,如果你发现做一件事情可以有更清晰的方式,那你完全有理由用更清晰的方式来解决问题.如果你开始使用程序库,发现其中库提供的功能特性和你的代码重复,那么你也应该改变你原来的算法.或者当你想要修改原先的算法,让他去做一件和原先略有差异的事情,这时候你也可以把原先的算法替换成一个较易修改的算法,让后续修改来的简单点. 使用这个手法之前,确保自己已经充分了解原先函数,替换巨大而复杂的算法是很复杂的,你可以先

『重构--改善既有代码的设计』读书笔记----Introduce Explaning Variable

有时候你会遇到一系列复杂的表达式连续运算的时候,这个时候你可能根本招架不住如此长或者是如此复杂的长函数.这个时候你可以通过引用临时变量来储存他们的结果,将这些长函数的结果分成一个个临时变量来让函数清晰化.但在这里,我的想法与作者的想法是一样的,我会更倾向于去用Extract Method去将复杂函数弄清晰,而尽量不去Introduce Explaning Vaiable,因为Extract Method优点很多,除了不增加临时变量增加函数长度之外,他的生命周期也比临时变量来的长,他可以让类中的所

『重构--改善既有代码的设计』读书笔记----Change Value to Reference

有时候你会认为某个对象应该是去全局唯一的,这就是引用(Reference)的概念.它代表当你在某个地点对他进行修改之后,那么所有共享他的对象都应该在再次访问他的时候得到相应的修改.而不会像值对象(Value)一样,不可修改.举个例子,你认识小明,我也认识小明,小明忽然把头发都踢了,这个时候你认识的小明和我认识的小明都是同一个人,都是光头,这个小明就是世界的唯一实例,然而,你有100块钱,我有50块钱,我把50块钱花到只剩20,你手里的100块钱并不会因为我的50块钱改变而改变,不会相应的修改,这

『重构--改善既有代码的设计』读书笔记----Replace Data Value with Object

当你在一个类中使用字段的时候,发现这个字段必须要和其他数据或者行为一起使用才有意义.你就应该考虑把这个数据项改成对象.在开发初期,我们对于新类中的字段往往会采取简单的基本类型形式来保存,但随着我们开发进度的增加,这些简单的数据项就不再那么简单了.比如一开始你会使用一个字符串来表示一串电话号码,但是随后你会发现,这个电话号码已经变的不再纯粹,它可能还需要“格式化”,“抽取取号”等特殊行为.一开始你可能会不以为意,觉得这个数据项就这么一两个,不会对你造成影响.但重复代码(Duplicate Code