架构师重构代码的12条军规

作者 | Raffi Krikorian

对于开发者来说&＃xff0c;架构设计是软件研发过程中最重要的一环&＃xff0c;所谓没有图纸&＃xff0c;就建不了房子。在遍地App的互联网时代&＃xff0c;架构设计有了一些比较成熟的模式&＃xff0c;开发者和架构师也可以经常借鉴。

但是&＃xff0c;随着应用的不断发展&＃xff0c;最初的架构往往面临着各种问题&＃xff0c;比如无法满足客户的需求、无法实现应用的扩展、无法实现新的特性等等。在这种情况下&＃xff0c;我们如何避免一些坑&＃xff0c;尽量比较成功地实现架构的重构&＃xff0c;是很多开发者和架构师亟需解决的问题。

在这里&＃xff0c;跟大家分享一下Uber的工程主管Raffi Krikorian的12条规则&＃xff0c;并附上一些解读&＃xff0c;希望对大家有所启发。

1、确定重构的目的和必要性

看起来这个规矩有些多余&＃xff0c;但是请不要忽略。每一次架构的重构都是“伤筋动骨”&＃xff0c;就像做手术一样&＃xff0c;即使再成功&＃xff0c;也会伤元气&＃xff0c;所以决策者们首先要分析架构重构的理由和其他备选方案&＃xff0c;明确重构的目的是为了满足业务需求&＃xff0c;并且是不得不做的最佳方案&＃xff0c;然后再考虑其他问题。有时候&＃xff0c;经过分析就会发现&＃xff0c;也许还有其他解决方案&＃xff0c;比如增加计算资源&＃xff0c;或者重构的目的不是为了业务需求&＃xff0c;那就没有必要做了。

检查清单&＃xff1a;

• 架构重构的原因是什么&＃xff0c;是为了满足业务的需要还是只是觉得架构不好看&＃xff1f;

• 除了架构重构之外&＃xff0c;还有其他备选方案吗&＃xff1f;是否都分析过这些方案的利弊&＃xff1f;

2、定义“重构完成”的界限

如果确定要重构&＃xff0c;那么要把目标明确下来&＃xff0c;也就是重构的边界条件&＃xff0c;怎么才算是“完成”了重构&＃xff0c;目标要有数据量化&＃xff0c;或者有能够测试的办法。这也是一个需求分析的过程&＃xff0c;如果需求不明确&＃xff0c;那么规格说明书没法写清楚&＃xff0c;负责重构的团队也没有明确的目标&＃xff0c;不能以重构的时间或者主观的判断为结束的依据。前几天和一朋友聊天&＃xff0c;他最近在负责系统的性能优化&＃xff0c;也要做一些重构的事情&＃xff0c;开始的时候团队的目标不明确&＃xff0c;大家不知道优化到什么程度&＃xff0c;所以不敢下手。如果目标是提高10%&＃xff0c;那么可以从细节处着手&＃xff1b;如果是提高50%&＃xff0c;那可能要搞大动作才能实现了。后来目标明确之后&＃xff0c;团队才找到合适的办法。

检查清单&＃xff1a;

• 重构的目标可以量化&＃xff0c;或者说可以测试吗&＃xff1f;

• 重构完成的标准是什么&＃xff1f;得到业务部门或者领导的认可了吗&＃xff1f;

3、渐进式重构

现在软件研发最流行的就是快速迭代、持续交付、尽早反馈。这同样可以用在架构的重构上&＃xff0c;重构过程的难度不亚于构建一个新产品&＃xff0c;所以在设计重构的时候&＃xff0c;要引入持续交付的流程&＃xff0c;每一个重构步骤或者模块都要快速部署并得到反馈&＃xff0c;以便评估重构的效果&＃xff0c;及时作出策略调整。有的读者会说&＃xff0c;我们的架构重构是釜底抽薪型的&＃xff0c;没法渐进&＃xff0c;只能一蹴而就。如果是这种情况&＃xff0c;可以考虑在另外一套拷贝的系统中做重构&＃xff0c;经过谨慎测试之后&＃xff0c;将数据和业务迁移过去。

检查清单&＃xff1a;

• 能否把重构过程分成小的迭代&＃xff0c;每一次改进都能尽快得到反馈&＃xff1f;

• 重构过程中的效果能够定期展示给业务部门或者领导吗&＃xff1f;

4、确定当前的架构状态

在启动重构之前&＃xff0c;团队要对当前的架构状态有清晰的了解&＃xff0c;也就是设定好基准&＃xff0c;以便评估重构的效果。据我的经验&＃xff0c;负责重构的架构师或者开发者&＃xff0c;往往还没有搞清楚现有的架构设计&＃xff0c;就开始重构了&＃xff0c;结果经常出现这样的情况&＃xff1a;重构到某个阶段&＃xff0c;发现行不通&＃xff0c;然后一拍脑袋说&＃xff0c;哦&＃xff0c;原来这块的架构是这个样的&＃xff0c;是为了达到某某业务需求啊&＃xff0c;这块不能动&＃xff0c;得想别的办法。类似的例子在研发团队中时有发生&＃xff0c;也提醒我们要慎重小心。记得有位哲人说过&＃xff0c;了解别人很容易&＃xff0c;了解自己很难。

检查清单&＃xff1a;

• 你了解当前的架构设计吗&＃xff1f;它的设计初衷和之前的选型方案知道吗&＃xff1f;

• 你能给架构设定一个基准状态吗&＃xff1f;

5、不要忽略数据

数据的重要性不言而喻&＃xff0c;业务都是以数据流为载体的&＃xff0c;所以架构重构的本质就是对于数据流的重构。数据对重构的重要性主要体现在两个方面&＃xff1a;在重构设计时&＃xff0c;需要考虑业务数据的需求&＃xff0c;重构之后的系统对于数据的存储、处理、分析等功能是否有影响&＃xff1b;在重构过程中&＃xff0c;考虑依靠数据甚至是实际的数据来验证重构的效果&＃xff0c;提供评估的支持。

检查清单&＃xff1a;

• 业务数据的需求在重构设计中有体现吗&＃xff1f;

• 重构过程中能否通过实际数据来验证效果&＃xff1f;

6、管理好技术债务

技术债务在平常的软件研发过程中也是比较突出的问题&＃xff0c;现在单独拿出来强调是希望提醒开发者们&＃xff1a;架构重构往往是为了偿还技术债务&＃xff0c;所以请不要在偿还技术债务的过程中制造技术债务了。技术债务就像信用卡一样&＃xff0c;会有很高的利息率&＃xff0c;就如同给团队留下了大量的帐务开销。组织应该培养一种保证设计质量的文化。应当鼓励重构、同时也应当鼓励持续设计以及其它有关代码质量的实践。在开发时间中应当专门抽出一部分以解决技术债务。如果没有合适的照料&＃xff0c;那么真实世界中的代码会变得越来越复杂难懂。

检查清单&＃xff1a;

• 团队对技术债务有跟踪和备忘录机制吗&＃xff1f;还是开发人员可以随意的产生债务&＃xff1f;

• 针对技术债务有定期的培训、回顾机制吗&＃xff1f;

7、远离那些虚荣的东西&＃xff08;例如使用“热门”的技术栈&＃xff09;

架构的重构过程应该是以目标为导向&＃xff0c;换句话说“注重实效”。对于技术人来说&＃xff0c;一个经常被轻视的问题在于&＃xff0c;喜欢追逐新鲜的热门技术&＃xff0c;这其实是个好事情&＃xff0c;说明技术人勇于创新&＃xff0c;不断接受新技术。但是对于架构的重构这样的关键性任务来说&＃xff0c;是不是新技术并不重要&＃xff0c;重要的是能不能实现重构的目标。对于新技术来说&＃xff0c;虽然热度大&＃xff0c;但是人才储备还不足&＃xff0c;大家踩过的坑还不多&＃xff0c;积累的失败教训和成功经验还不够&＃xff0c;在这种情况下&＃xff0c;建议大家不要头脑一热就上马新技术&＃xff0c;应该客观冷静地评估新技术和成熟技术对架构重构的影响和效果&＃xff0c;以数据和经验来说话&＃xff0c;而不要追赶时髦。

检查清单&＃xff1a;

• 重构的技术选型是否有详实的数据和专家评估&＃xff1f;

• 选用的技术是否有良好的人才积累和足够的经验支持&＃xff1f;你是不是实验小白鼠&＃xff1f;

• 在技术选型时&＃xff0c;是否至少有两个方案待评估&＃xff1f;有没有成熟的技术方案&＃xff1f;

8、做好准备面对压力

这条军规更像是对架构师们的心理建议&＃xff0c;软件开发过程中&＃xff0c;压力无处不在。对于架构重构来说&＃xff0c;压力来源于多个方面&＃xff1a;管理层、团队成员、同级部门等等。说白了&＃xff0c;架构重构对个人来说往往是一件出力不讨好的事情。和做一个新产品能够取得很高的赞赏相比&＃xff0c;重构的成绩往往并不受领导重视&＃xff0c;而且出了问题还要承担很大的责任。从软件开发角度看&＃xff0c;做新产品是从0到1&＃xff0c;而架构重构是从-1到1&＃xff0c;复杂性和难度通常更大。因此&＃xff0c;重构的负责人要提前做好心理准备&＃xff0c;舒缓压力的一个技巧是&＃xff0c;设置好里程碑&＃xff0c;将重构的成果量化&＃xff0c;并且和业务的变化关联起来&＃xff0c;定期向利益相关各方同步状态&＃xff0c;得到大家的理解和支持。

检查清单&＃xff1a;

• 架构的重构是否得到了管理层&＃xff08;特别是最高管理层&＃xff09;的支持&＃xff1f;他们是否对重构的时间、任务量有直接的认识&＃xff1f;

• 你的重构计划中是否包含了一些可以量化的成果&＃xff1f;是否定期向管理层展示这些成果&＃xff1f;

9、了解业务

虽然看起来像是一句废话&＃xff0c;但是我想Raffi Krikorian特意把这条提出来一定是有理由的。架构重构的最终目的是改进业务&＃xff0c;所以对于业务的了解将有助于架构师和技术人确定重构目标的优先级和关键路径。比如&＃xff0c;我们需要知道哪些关键业务的架构是不能碰的&＃xff0c;哪些业务之间是互相关联的&＃xff0c;哪些业务的架构是需要优先重构的…..等等。除了了解业务本身&＃xff0c;我们还需要了解“人”&＃xff0c;表面上管理层是重构目标的裁决者&＃xff0c;但实际上业务部门的人才是。技术人需要了解他们的业务需求&＃xff0c;并将其转化为重构目标。通过这种方式&＃xff0c;架构重构的意义才能得到具体的体现。

检查清单&＃xff1a;

• 是否与业务部门就架构重构所能实现的业务目标进行过充分的讨论和确认&＃xff1f;

• 是否对关键业务和优先重构的业务进行了确认&＃xff1f;

10、做好面对非技术因素的准备

恩……这又是一个不那么让人舒服的建议。不管你是否愿意相信&＃xff0c;技术在架构重构&＃xff08;以及其他很关键的公司决策中&＃xff09;的影响因素中并不是最高的&＃xff0c;我们还会涉及到商业利益、管理层偏好、大客户影响、办公室zhengzhi、站队问题等等&＃xff0c;对于架构师和技术人来说&＃xff0c;这些因素往往不是他们所能掌控的。我们能做的就是&＃xff0c;与利益相关者设定重构目标&＃xff0c;然后&＃xff0c;根据不同的影响因素&＃xff0c;调整目标。请记住&＃xff0c;不要死扛这个目标&＃xff0c;当有人提出不同的意见时&＃xff0c;要坦诚地和他们交流&＃xff0c;并告知他们如何采纳意见&＃xff0c;那么重构目标会有变化&＃xff0c;然后让其他利益相关者也知道这些变化。非技术因素的影响是客观存在的&＃xff0c;而且从商业层面来说也是合理的&＃xff0c;所以对于技术人来说要学会适应。

检查清单&＃xff1a;

• 当非技术因素影响架构的重构时&＃xff0c;你是否对目标做了调整并告知了利益相关各方&＃xff1f;

• 你是否准备以开放而不是抵制的心态来对待非技术因素的影响&＃xff1f;

11、对于代码质量有所掌握

这和上篇中所提到的“管理好技术债务”有异曲同工之处。架构的重构对代码质量要求很高&＃xff0c;一方面是重构过程对bug的容忍性比新产品的研发更低&＃xff0c;另一方面也决定了下一次重构的难易程度。关于代码质量的书籍和文章已经有很多&＃xff0c;在这里只想提醒大家一点&＃xff1a;代码审查是一个非常好的办法。代码审查是软件开发过程中的必要步骤&＃xff0c;既可以帮助被审查者提到代码质量&＃xff0c;又可以让审查者加深对产品的理解。不论团队多忙&＃xff0c;一定要保证代码提交之前&＃xff0c;是经过其他成员审核过的&＃xff0c;短期来看会占用团队的时间&＃xff0c;长期来看是事半功倍的好事。

检查清单&＃xff1a;

• 团队成员是否对代码质量有足够的重视&＃xff1f;是否有奖惩措施&＃xff1f;

• 团队内部是否有代码质量的标准文档和审查流程&＃xff1f;

12、让团队做好准备

这是Raffi Krikorian列举的最后一条军规&＃xff0c;是对之前所有建议的总结&＃xff0c;我在这里不做解读了&＃xff0c;请大家自我感觉吧。

结尾

关于架构的重构&＃xff0c;Raffi Krikorian给了很好的建议&＃xff0c;不过到底有没有效果&＃xff0c;还是要实践中检验。尽信书不如无书&＃xff0c;来源于实践中的经验是最有价值的&＃xff0c;为技术人所用才有意义。