代码重构：函数重构规则

 

转：https://www.cnblogs.com/ludashi/p/5223241.html

重构是项目做到一定程度后必然要做的事情。代码重构，可以改善既有的代码设计，增强既有工程的可扩充、可维护性。随着项目需求的不断迭代，需求的不断更新，我们在项目中所写的代码也在时时刻刻的在变化之中。在一次新的需求中，你添加了某些功能模块，但这些功能模块有可能在下一次需求中不在适用。或者你因为需求迭代与变更，使你原有的方法或者类变得臃肿，以及各个模块或者层次之间耦合度增加。此时，你要考虑重构了。

 

重构，在《重构，改善既有代码的设计》这本经典的书中给出了定义，大概就是：在不改变代码对外的表现的情况下，修改代码的内部特征。说白了，就是我们的测试用例不变，然后我们对既有的代码的结构进行修改。重构在软件开发中是经常遇到的，也是非常重要的。在需求迭代，Debug，Code Review时，你都可以对你既有的代码进行重构。

 

在接下来的几篇博文中，我想与大家一块去窥探一下代码重构的美丽，学习一下代码重构的一些规则。当然在每个规则中都有小的Demo, 在本篇博客以及相关内容的博客是使用Swift语言实现的。当然，和设计模式相同，重构重要的是手法和思想，和使用什么样的语言关系不大。经典的重构书籍中是使用Java语言来实现的，如果你对PHP, Python等其他语言比较熟悉，完全可以使用这些语言来测试一些重构手法。

 

本篇博客的主题就是通过一些列的重构手法，对既有的需要重构的函数或者方法进行重构。并且会将每个示例在GitHub上进行分享，感兴趣的小伙伴可以对其进行下载。有的小伙伴说了，我没有Mac，怎么对你写的Swift代码进行编译呢？这个问题好解决，你可以看我之前发表的这篇博客《窥探Swift之使用Web浏览器编译Swift代码以及Swift中的泛型》。你可以将相关代码进行拷贝，在浏览器中观察结果。因为在线编译的网站是国外的，访问起来也许会有一些卡顿，不过是可以用的。好前面扯了这么多了，进入今天的主题。

 

一、Extract Method(提取函数)-------将大函数按模块拆分成几个小的函数

Extract Method被翻译成中文就是提取函数的意思，这一点在代码重构中用的非常非常的多。在重构时提倡将代码模块进行细分，因为模块越小，可重用度就越大。不要写大函数，如果你的函数过大，那么这意味着你的函数需要重构了。因为函数过大，可维护性，可理解性就会变差。并且当你实现类似功能的时候就容易产生重复代码。写代码时，最忌讳的就是代码重复。这也就是经常所说的DRY（Don`t Repeat Yourself）原则。所以当函数过长时，你需要将其细分，将原函数拆分成几个函数。

 

下方将会通过一个示例来直观的感受一下Extract Method，当然这些示例不是我原创的，是《重构：改善既有代码的设计》中Java示例演变的Swift版，在写Swift代码时，对原有的示例进行了一些修改，算是伪原创吧。不过目的只有一个：希望与大家交流分享。实在是没有必要再找其他的例子说明这些重构规则，因为《重构：改善既有的代码的设计》这本书真的是太经典了。

 

1.需要重构的代码如下所示。下方代码中的MyCustomer类中有两个常量属性，并且该类提供了一个构造器。该类还提供了一个输出方法，就是第一该类中的属性进行打印说明，其实该类中没有什么功能

 

在写好需要重构的类后，我们要为该类写一个测试用例。这便于在我们重构时对重构的正确性进行验证，因为每次重构后都要去执行该测试用例，以保证我们重构是正确的。下方截图就是为上方示例写的测试用例以及该测试用例的打印结果。当然重构后我们也需要调用该测试用例，并观察打印结果是否与之前的一致。当然如果你不想自己观察，你可以为上面的类添加相应的单元测试，这也是在常规项目中经常使用的。至于如果添加测试用例，我们会在后面的博客中进行详细介绍。下方就是上述类的测试用例和输出结果：

      

 

2.接下来我们对上面类中的printOwning函数进行分析。上述类可以正常工作，这是肯定的。但是printOwning()函数写的不够好。因为它干了太多的事情，也就是说该函数包括了其他子模块，需要对其进行拆分。由上面截图中的红框可以看出，每个红框就代表着一个独立的功能模块，就说明这一块代码可以被拆分成独立的函数。在拆分子函数时，我们要为该函数起一个与改代码块功能相符合的名字。也就是说当你看到该函数名字时，你就应该知道该函数是干嘛的。

 

下方代码段就是我们重构后的类。说白的，就是对函数中可以进行独立的模块进行提取，并为提取的新的函数命一个合适的名称。经过重构后printOwing()函数就只有两行代码，这样看其中调用的函数名也是很容易理解其作用的。下方拆分出来的三个函数也是一个独立的模块，因为函数短小，所以易于理解，同时也易于重用。经过Extract Method，当然好处是多多的。经过重构后的代码，我在调用上述的测试用例，输出结果和原代码是一直的，如果不一致的话，那么说明你的重构有问题呢，需要你进行Debug。