从本篇Blog开始,在学习具体的设计模式之前,先学习高质量代码的达成路径的实践部分代码重构和编程规范。
重构的目的
什么是重构,重构是一种对软件内部结构的改善,目的是在不改变软件的可见行为的情况下,使其更易理解,修改成本更低,这段定义可以理解为在保持功能不变的前提下,利用设计思想、原则、模式、编程规范等理论来优化代码,修改设计上的不足,提高代码质量,其中提高代码质量也就是提高代码的 可读性、可扩展性、可维护性、可重复性、简洁性、灵活性、可测试性
我们为什么要重构呢,重构的目的是什么呢?
- 首先,重构是时刻保证代码质量的一个极其有效的手段,不至于让代码腐化到无可救药的地步,项目演进过程中代码不停地在堆砌。如果没有人为代码的质量负责任,代码总是会往越来越混乱的方向演进。当混乱到一定程度之后,量变引起质变,项目的维护成本已经高过重新开发一套新代码的成本,想要再去重构,已经没有人能做到了。就像我们现在的CA系统实际上已经无可救药了,只能开发一套新的系统出来。
- 其次,优秀的代码或架构不是一开始就能完全设计好的,我们无法 100% 预见未来的需求,也没有足够的精力、时间、资源为遥远的未来买单,所以,随着系统的演进,重构代码也是不可避免的
- 最后,重构是避免过度设计的有效手段。在我们维护代码的过程中,真正遇到问题的时候,再对代码进行重构,能有效避免前期投入太多时间做过度的设计,做到有的放矢。这也是学习SOLID和YAGNI原则时多次提到的。持续重构代替开始的过度设计。
所以总的来说就是重构能够保证代码质量,持续重构可以让我们不至于在系统设计初期为过度设计买单,不至于在后期系统无可救药时丢弃它。
重构的内容
根据重构的规模,可以笼统地分为大规模高层次重构(以下简称为“大型重构”)和小规模低层次的重构(以下简称为“小型重构”)
- 大型重构指的是对顶层代码设计的重构,包括:系统、模块、代码结构、类与类之间的关系等的重构,这类重构涉及的代码改动会比较多,影响面会比较大,所以难度也较大,耗时会比较长,引入 bug 的风险也会相对比较大
- 重构的手段:分层、模块化、解耦、抽象可复用组件等等。
- 重构的工具: 设计思想、设计原则和设计模式。
- 小型重构指的是对代码细节的重构,包括类、函数、变量等代码级别的重构,比如规范命名、规范注释、消除超大类或函数、提取重复代码等等。这类重构要修改的地方比较集中,比较简单,可操作性较强,耗时会比较短,引入 bug 的风险相对来说也会比较小
大型重构需要系统化的解决,小型重构自己平时随见随改
重构的时机
一定要建立持续重构意识,把重构作为开发必不可少的部分,融入到日常开发中,而不是等到代码出现很大问题的时候,再大刀阔斧地重构。
重构的方法
进行大型重构的时候,需要当成一个技术需求项目去做:
- 提前做好完善的重构计划,有条不紊地分阶段来进行。
- 每个阶段完成一小部分代码的重构,然后提交、测试、运行,发现没有问题之后,再继续进行下一阶段的重构,保证代码仓库中的代码一直处于可运行、逻辑正确的状态。每个阶段,都要控制好重构影响到的代码范围,考虑好如何兼容老的代码逻辑,必要的时候还需要写一些兼容过渡代码。只有这样,才能让每一阶段的重构都不至于耗时太长(最好一天就能完成),不至于与新的功能开发相冲突
小规模低层次的重构,因为影响范围小,改动耗时短,可以依据编码规范随时去做,除了人工的编码意识,还可以使用一些代码检测插件,例如CheckStyle、FindBugs、PMD
总结一下
在系统开发前期我们不可能预见所有业务需求,而且还要避免过度设计,而随着业务的发展,代码不得不随着业务发展和堆砌,导致代码的熵增、系统的无序。所以持续重构真的非常重要,它能在不改变功能的前提下保证系统的健康度和活力。对于业务发展阶段的大的变动需要通过有计划、分阶段的大型重构来达成,而常规的小型变动则仅仅通过编程规范、意识以及一些代码规范检测工具即可达成。