代码重构终极指南!!

article/2025/8/14 19:58:39

👇👇关注后回复 “进群” ,拉你进程序员交流群👇👇

作者丨Alex Omeyer
译者丨弯月
出品丨CSDN(ID:CSDNnews)
原文链接:

https://medium.com/swlh/the-ultimate-engineers-guide-to-code-refactoring-c38372632906

我们一直在寻找各种方法来清理代码、降低复杂性和改善功能。而重构为我们指明了前进的方向。

e828e91c07118e9f5227197457bc8e38.png

1、什么是重构?

Martin Fowler曾出版了两本有关重构的书籍,他认为:

重构指的是,在不改变代码的外部行为,只改善其内部结构的方式下,修改软件系统的过程。重构是一种有条理的清理代码的方式,可以最大程度地减少引入bug的机会。本质上,重构意味着在代码编写完成后,改进代码的设计。

2、重构有什么好处?

重构源代码有数不清的好处。首先,重构可以将混乱、不正确和/或重复的代码转换成整洁的代码。它可以解决多位开发人员协同工作时可能引发的代码标准化问题。重构可以提高可读性,改善源代码的可维护性以及整体结构和功能。重构可以使代码更易于扩展和添加新功能。删除不必要的代码(比如重复代码)可以减少代码所使用的内存,并加快执行速度。

例如,在2014年,Kickstarter的工程师面临着一个巨大的挑战:由于用户数量呈指迅速增长,导致查询性能下降。为此,他们将MySQL查询重构为Redis,减少了100毫秒的加载时间,从而减少了加载时间的差异并提高了网站的整体速度。

3、技术负债与重构

271f57f0612fa9ecb366c32e8fae824c.png

简而言之,重构是消除或减少技术负债的一种方式。

重构对于长期维持的代码质量、安全性和性能至关重要。如果没有定期的重构,开发人员就会承受巨大的技术负债。重构代码的机会越少,技术负债就会越多,开发新功能也会变得越来越难。

4、重构的指标

我们可以通过各种指标,衡量重构代码的优先级。在指标的帮助下,我们可以有条不紊地计划重构,每一次都专心完成最重要的任务。

此外,你需要通过指标来衡量重构的效果。我们不仅需要重构低效的代码,而且还可以通过修改低效代码增加价值。为了获得真正的价值,你需要进行测试,包括单元测试和功能测试。除此之外,还有一些其他方面的指标,比如发现的bug数减少,以及降低循环复杂性(重构的目标是降低复杂性)。高度复杂的方法或功能(比如超过350行的方法或功能)就是良好的重构对象。

此外,我们还需要考虑,如何将重构融合到更广泛的团队目标或有关工作流和任务的里程碑中。

5、代码重构示例

代码重构的示例非常多,为了简洁起见,我们介绍以下几种:

红色,绿色和重构

重构与单元测试息息相关。最常见的形式之一就是敏捷方法固有的测试驱动开发(Test-Driven Development,即TDD)。你可以在编写代码之前先编写测试。从本质上来说,应该由测试来驱动程序,说明代码应该执行的操作。

红色,绿色和重构是测试驱动开发的一个示例:

  • 红色:编写没有实现代码的测试套件,必然会失败。

  • 绿色:编写实现代码,刚刚好可以通过测试套件。

  • 重构:寻找优化和改进代码的方法。

提取方法(又名提取函数)

将代码片段从现有方法移到新方法中,而新方法的名称明确说明了其功能。这种技术有助于降低复杂性并提高代码的可读性,另外《Java开发手册(嵩山版)》你需要好好看下。

提取变量

如果遇到难以理解的表达式,或者该表达式在整个代码中重复了多次,则可以通过提取变量重构,将表达式或其中一部分放入一个复杂度较低且更易于理解的变量中。这样可以减少复杂性和代码重复。

按抽象建立分支

按抽象建立分支可以逐步对软件系统进行大规模地修改,而你则可以一边修改代码,一边定期发布系统。这种方法可以降低在分支上重构代码的复杂性,避免在合并代码时出现问题。

方法组合

代码过长不便于理解,而且也不方便修改。方法组合指的是一系列的操作,将方法改成顺序结构并删除重复的代码。这些操作包括内联方法、内联模板、用查询代替模板、拆分临时变量以及删除对参数的赋值等。

6、重构代码的工具

你需要专业的重构工具吗?Martin Fowler表示,自动化的工具有帮助但不是必需的。另外,Java 工具系列教程全部整理好了,微信搜索互联网架构师,在后台发送:2T,可以在线阅读。

他指出:

“许多语言都有IDE,可以自动执行许多常见的重构。这些是非常有价值的工具,可以帮助我更快地重构代码。但是,这些工具不是必不可少的,我经常在没有工具支持的情况下编写程序,每次只迈出一小步,并通过频繁的测试来发现错误。”

许多开发环境都可以自动化重构,一些常见的重构工具包括:

  • Visual studio intellicode

  • Eclipse IDE

  • Spring Tool Suite 4

  • Rider

  • IntelliJ IDEA

  • SonarQube

7、重构与工程经理的难题

为了解决引发重构需求的问题,首先我们需要弄清楚公司的运营方式。另外《Java开发手册(嵩山版)》你需要好好看下。在着手重构之前,请先回答下列几个问题:

  • 哪些任务最优先?

  • 开发的速度如何?

  • 开发人员是否感觉到了快速交付代码的压力?

  • 解决技术负债的流程都有哪些?

  • 实施了哪些类型的代码审核?

  • 团队成员是否具备适当的重构技能?

  • 公司的文档标准是什么?

如果不解决引发重构需求的根本问题,那么问题只会愈演愈糟。

8、高级管理层对重构的支持

你们公司可能并没有在基础设施和维护上投入太多资金。

可能会有人说,应该将花费在重构上的时间投入到新功能开发上。

但是,我们仍然应该看一看重构的好处,以及它们与工作流程、客户、收入和业务增长的关系。重构得当可以改善代码,交付有效更新以及急需的功能,从而吸引新客户和回头客。即使在成功发布产品之后,软件公司也可以通过这种方式保持竞争力。

为了获取高层管理的支持,还有一个更好的方法,即量化团队当前花费在修复原始代码中的错误或bug上的时间。具体一点,比如每天一个小时?每天两个小时?持续记录一个星期,你就会惊讶地发现原来团队每年需要花费数周或数月时间来修复遗留的代码。

9、团队支持与重构:一个Sprint还是马拉松?

很难在团队内部开展重构工作?提及重构就会哀声载道?顺利开展重构的最重要的标志就是有计划、有目标以及有文档记录的行动。Ron Jeffries(极限编程的三大创始人之一)将重构比喻为清道:

“花些时间清出一条道来,那么下一次我们就可以直奔我们要构建的下一个功能,而无需绕过杂草和灌木丛。”

但是,他强调指出,糟糕的代码需要花费很长的时间来清理,而且重构应该经过深思熟虑:

“如果我们只改进手头的代码,而忽略目前不涉及的代码,那么以后必然会走回头路。”

在同一个Sprint中,我们经常发现后面的功能用到了我们之前清理过的代码。我们就会立即享受重构的好处。如果我们等积攒了一堆技术负债,再开始重构,那么我们享受的好处会延迟,甚至可能会在一些没大有用的地方浪费精力。

产品工程师兼首席技术官Andreas Klinger是Fix-it Friday的粉丝,他表示:

“Fix-it Friday的规则很简单:除非当前的项目十万火急,否则周五的工作就应该是重构。让工程师选择他们的工作。我们不应该因为微观管理而抹杀这种乐趣。有些人会尝试新的库。有些人会修复积压的bug。这两种工作都很好。我们尝试鼓励大家平衡这些任务。”

无论采用哪种方法,你都需要慎重思考,询问团队哪些代码最影响他们的效率。

  • 修复哪些代码对你的其他代码产生的影响最大?

  • 解决哪些问题得到的回报最多?

你不太可能找到一整块专门的时间来重构代码,重构代码必然会牺牲你花费在其他项目上的时间,但请不要低估定期坚持开展小范围的重构带来的影响。聚沙成塔,集腋成裘,最终你会获得丰厚的回报。

10、文档与重构

标准化命名约定之类的文档可以让每个人都达成共识。Xerox的高级开发人员的研究发现,缺乏文档是重构最大的难题之一。

记录重构的工作内容不仅可以记录花费的时间,而且还可以为将来的团队成员提供说明。另外,关注公众号互联网架构师,在后台回复:2T,可以获取我整理的 Java 系列面试题和答案,非常齐全。

最后,你还通过文档记录下自己的成功:重构带来的最大成功是什么?这些可以成为代码审核的考虑因素吗?

作者丨Alex Omeyer
译者丨弯月
出品丨CSDN(ID:CSDNnews)
原文链接:

https://medium.com/swlh/the-ultimate-engineers-guide-to-code-refactoring-c38372632906

-End-

最近有一些小伙伴,让我帮忙找一些 面试题 资料,于是我翻遍了收藏的 5T 资料后,汇总整理出来,可以说是程序员面试必备!所有资料都整理到网盘了,欢迎下载!

340baac37044fbf4a3c9333f577035d5.png

点击👆卡片,关注后回复【面试题】即可获取

在看点这里c932b751b998c63446549f450cafb017.gif好文分享给更多人↓↓


http://chatgpt.dhexx.cn/article/w2TPdIWr.shtml

相关文章

如何进行代码重构?

作为一个程序员,大部分时候,如果不是一个人承包整个项目,那么有1/3的时间在写代码,1/3的时间在看别人写的代码,剩下的1/3的时间在摸鱼。 那么如何提高摸鱼的时间?看别人写代码十分头疼,分分钟想…

代码重构学习

一、代码重构是什么 用重构手法去重构代码 二、为什么需要代码重构 1.方便维护。为了在修改代码时,添加的地方有个切入点,减少bug。 2.有利于理解设计思想和代码。 三、代码重构怎么做(养成习惯) 思想: 1.修改一…

代码重构技巧:如何将烂代码变成好代码?

这是本文的目录 前言重构入门1. 格式化代码2. 注释3. 废弃的代码4. 变量命名5. 常量命名6. 负值条件的重构7. {} 作为单独的一行8. 变量定义和使用距离太远 重构进阶1. 重复代码2. 函数参数3. 变量多余4. 缺少变量5. 复杂条件 老旧代码的重构利用工具总 结零基础Python学习资源…

代码重构新手教程:如何将烂代码变成好代码?

作者 | 王莉敏 策划 | 蔡芳芳 作为有几年工作经验的程序员,都会对 bad code 不满意。如何将烂代码变成好代码,本文将由浅入深、一步步带你理解重构的奥秘,让你对重构有个基本的了解。本文基于文章《The Simple Ways to…

常见代码重构技巧(非常实用)

你已选中了添加链接的内容点击上方“芋道源码”,选择“设为星标” 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 8:55 更新文章,每天掉亿点点头发... 源码精品专栏 原创 | Java 2020 超神之路,…

hue执行workflow工作流出现直接FAILED

场景: 执行以下任务流的时候就出现了直接失败的情况 在第一次执行并且数据完善的情况下测试的,状态是成功的 但是第二次是在第一次基础上测试的,基础数据有所缺失 日志为: Failing Oozie Launcher, Main class [org.apache.oo…

Git Workflow工作流示意图

来自:http://blog.osteele.com/posts/2008/05/my-git-workflow UPDATE: git pretty 来自: http://justinhileman.info/article/git-pretty/full/ from: http://iccm.cc/git-workflow/

使用Python开源库Couler编写和提交Argo Workflow工作流

Python 是用户在 Kubernetes 上编写机器学习工作流的流行编程语言。 开箱即用时,Argo 并没有为 Python 提供一流的支持。相反,我们提供Java、Golang 和 Python API 客户端[1]。 但这对大多数用户来说还不够。许多用户需要一个抽象层来添加组件和特定于…

SharePoint 2013 Nintex Workflow 工作流帮助(八)

博客地址 http://blog.csdn.net/foxdave 工作流动作 15. Complete Workflow Task(User interaction分组) 此工作流动作将完成任何进行中的任务,它将处理足够的单独任务来达到选择的结果,接下来工作流引擎会依据工作流的设置处理…

工作流(Workflow) -- 实现简单工作流程

工作流(activiti) 工作流简介 业务过程的部分或整体在计算机应用环境下的自动化 工作流就是多个参与者,按照某种预定义的规则,传递业务信息,进行审核的功能一个框架(activiti) 核心 23张表 ACT_RE_*:RE’表示repository。 这个前缀的表包含了流程定义和流程静态资源 (…

wf工作流java_WF Workflow 状态机工作流 开发

概述 工作流是对业务流程的建模,当我们设计工作流的时候,我们首先要分析业务处理过程中要经历的步骤。然后,我们就可以利用WF创建工作流模型来模拟业务的处理过程。 我们知道,WF包含两种类型的工作流:顺序工作流和状态…

Mendix 9.6 - Workflow(工作流)基础设计

一 概述 Workflow(工作流)是Mendix 9版本中新增的一种可视化语言功能模块,我们可以用它来构建可扩展的流程。此外它还与其他可视化语言完全集成,例如微流编辑器和页面编辑器。 在公司我们往往需要填写许多表单,包括行政、人事、IT等方面的&a…

workflow工作流(三):画流程图工具对比

一、总结 我所用过能画工作流的工具有2个:1.eclipse插件,2.flowable官方网页版,结论是eclipse插件好用,后者要上传下载,还容易丢数据 注意事项:eclipse插件画出来的bpmn文件的schama是activiti&#xff0…

Bladex Workflow工作流引擎开发进阶-版本v1.2.2

Bladex Workflow工作流引擎开发进阶 1 Bladex Workflow简介2 Flowable简介3 workflow部署和配置-参考文档《BladeX插件 - Blade-flow使用帮助文档 》4 配置任务监听4.1 问题:监听类注入不了service 5 配置事件监听6 复杂表单-配置外部表单(不建议配置超大…

workflow工作流(二):34张表

1.常用的表 2.总共34张表 Activiti的后台是有数据库的支持,所有的表都以ACT_开头。 第二部分是表示表的用途的两个字母标识。 用途也和服务的API对应。 ACT_RE_*: RE表示repository。 这个前缀的表包含了流程定义和流程静态资源 (图片,规则&…

SAP Workflow 工作流开发步骤总结

一、配置 SWU3 设置管理员 二、新建业务对象 查看我们需要增强的业务对象,比如我们项目上用的是BUS2000114,一般我们工作流的触发 是用单据状态的改变来触发,这就需要我们增强业务对象 使用SWO1 新建一个业务对象 继承上面的标准对象 注意…

小小研究一下工作流WorkFlow

修房子 在小牧老家农村,小时候总是看到村里有人在修房子。每次看到有人修房子的时候,他就会爬到房子面前的沙粒堆上去,翻找随着沙子一起被挖出来的贝壳。虽然也不知道拿来干嘛,不过总觉得收集贝壳很好玩。 小牧也喜欢看他们修房子。修房子的时候,专业的修房师傅会指导工…

微软 workflow 工作流总结

1.状态机工作流 (1)状态机工作流从state1 流转到 state2 到stateN (2) state中有执行状态和退出状态 (3) 在进入下一个步骤(state1 到 state2)前,首先会判断进入下一个状态的条件,下面我把它叫做判断模块 (4)在判断模块中,有三个生命周期:Trigger,Condition,Action (5)判断模…

WorkFlow工作流

工作流 一、什么是工作流 历史发展: 工作流的理论起源于70年代中期办公的自动化领域。90年代。工作流技术的研究与开发进一步发展。1993年8月,成立第一个工作流技术标准话的工业组织WFMC(工作流管理联盟)。现在,工作…

工作流(Workflow)基本介绍

工作流简介 工作流(Workflow),就是“业务过程的部分或整体在计算机应用环境下的自动化”,它主要解决的是“使在多个参与者之间按照某种预定义的规则传递文档、信息或任务的过程自动进行,从而实现某个预期的业务目标&a…