GMTC北京站优惠购票最后一周!13个热点专题,50+大厂案例,这里一览 了解详情
写点什么

降低代码重构的风险

  • 2012 年 11 月 15 日
  • 本文字数:2232 字

    阅读完需:约 7 分钟

重构是每一个开发人员都要面对的功课,Martin Fowler 将其定义为“在不改变软件外部行为的前提下,对其内部结构进行改变,使之更容易理解并便于修改”。技术专家 Paul 在博客中讨论了重构的风险,并提出了降低风险的措施。

Paul 在文中指出:

重构代码是危险的,代码的变化会导致测试的压力很大。除非有必要的理由,否则不要轻易重构。我指的重构并不是说把 while 循环改成 for 循环,或者把 StringBuffer 改成 StringBuilder,而是指比较大的改动,比如重新方法、函数或者整个类或者包。

错误的重构时机包括:

  • 代码逻辑对你来说过于复杂,而且没有时间去分析它。
  • 你没有理解为何之前的开发人员是这样编写代码的。
  • 你参与的系统是关键系统,而且时间紧。
  • 你对团队、应用或者编程语言是新手。

正确的重构时机包括:

  • 现有的代码比预期的要复杂,而且你已经分析过它。
  • 你所做的改动比现有代码逻辑更加清晰。
  • 你有时间、人力和财力来增加完整的项目回归测试。
  • 现有代码过时了而且效率低下,比如孤立的或者质量差的代码。
  • 你和同事讨论过重构代码的好处和风险,并且达成一致。

如何减低重构风险呢?Paul 认为可以从以下几点入手:

  • 利用自动化的回归测试来快速验证你的代码更改,这非常重要,如果你还没有准备好自动化回归测试,那么请在重构之前先搭建好测试环境。
  • 努力把代码的重构安排在较小的开发周期内。
  • 尽量把更改独立化,方便查找问题。
  • 确保测试计划包含了所有的回归、功能、负载、性能和用户验收测试。
  • 在开始重构之前,花时间弄清楚复杂的代码逻辑。
  • 在需要时利用设计模式,不要为了用而用,必须要充分的理由。

无独有偶,技术专家 McConnell 在“代码大全”中也提到了安全重构的措施。

保存初始代码——在开始重构之前,要保证你还能回到代码的初始状态。用版本控制系统保存一个初始版本,或者把最初正确的文件复制到备份目录中去。

重构的步伐请小一些——这样才能理解所做修改对程序的全部影响。

同一时间只做一项重构——除非是对付那些最为简单的重构,否则请在同一时间只做一项重构,在进入下一项重构之前,对代码重新编译并测试。

把要做的事情一条条列出来——伪代码编程过程的自然延伸就是列出一份重构列表,然后你应该按照这份列表从 A 点一步步走到 B 点。写一份重构列表能够让你在修改时保持思路连贯。

多使用检查点——在重构的时候,很容易出现代码没有按照设想正常运行的情况。除了保存初始代码外,在重构中还应在多个地方设置检查点,这样一来,即使你编码时钻进了死胡同,仍然可以让程序回到正常工作的状态。

利用编译器警告信息——要让一些小错误错过编译器的目光很容易。你最好把编译器的警告级别设置为尽可能苛刻,一旦输入中有这些小错误,编译器就能立刻把它们找出来。

重新测试——应该把重新测试作为检查所修改代码工作的补充。当然,这点要取决于从一开始你是否就有一套优秀的测试用例。

增加测试用例——除了重新运行过去做过的那些测试,还应该增加新的单元测试来检验新引入的代码。如果重构使得一些测试用例已经过时,那么就删除这些用例。

根据重构风险级别来调整重构方法——有一些重构实施起来会比其他重构更为危险。而类似于“用具名常量替代神秘数值”一类的重构则机会不会出现什么问题。涉及到类、成员函数结构、数据路架构等改变,或者对布尔判断等进行修改的重构则极具风险。对于简单的重构而言,你只需要简化整个重构过程,然后简单的对代码重新测试,而不用一次去完成一个重构,也不用进行正式的检查工作。

不适合重构的情况包括:

不要把重构当做先写后改的代名词——重构最大的问题在于被滥用。程序员们有时会说自己是在重构,而实际上他们所完成的工作仅仅是对无法运行的代码修修补补,希望能够程序跑起来。重构的含义是在不影响程序行为的前提下改进可运行的代码。那些修补破烂代码的程序员们不是在重构,而是在拼凑代码。

避免用重构代替重写——有时,代码所需要的不是细微修改,而是直接一脚踢出门外,这样你就可以全部重新开始。如果发现自己处于大规模的重构之中,就应该问问自己是否应该把这部分代码推到重来,重新设计,重新开发。

Kent Beck 认为,重构中面临最大的挑战就是如何做到循序渐进,循序渐进指的是如何将工作分解为可控的步骤,并且每个步骤都易于管理。重构步伐过快会导致不稳定代码的出现。此外,想得越多,越是谨慎反而会严重减慢重构的步伐。

正如许多与我结对编程的伙伴都会告诉你的那样,我有一个非常不招人喜欢的习惯:在重构时总会说“不要再想啦”。我知道这并不是我真正要说的,因为我不可能去故意表达这个意思,但是直到现在,我才有机会可以给出一个更好的解释。

垂直重构是指调整方法或代码块在调用堆栈中的上下顺序,然而水平重构则指的是在类似于同级别的对象间所做的调整。依 Kent 所述,重构时应避免同时做上述两种调整。

当需要重构具有多重调用或是多重实现的对象时,就要额外小心,并且重新回到垂直和水平方法,将这两者操作分开进行,并且要时刻注意代码重构的深度。

Kent Beck 认为比较好的一个办法就是使用索引卡(Index Cards):

在电脑旁放置索引卡会帮助我保持专注。当我在处理水平重构时突然意识到还可以做垂直重构时,我会迅速记在索引卡上,然后马上回到刚才正在进行的工作中。这种方法不仅可以使我在进行下一步工作前,有效地先将手头的工作结束,同时,又不会导致某些好点子被遗忘。方法之好用,整个过程感觉就像是在做冥想,技能感受到自己的呼吸,又不会被完全自我的意识所牵绊。

InfoQ 的读者对代码重构有何见解?欢迎发表自己的看法!

2012 年 11 月 15 日 01:155727
用户头像

发布了 501 篇内容, 共 229.4 次阅读, 收获喜欢 51 次。

关注

评论

发布
暂无评论
发现更多内容

内存型数据库Redis,是如何实现持久化的?

Zhongger

redis

Spring 5 中文解析测试篇-Spring测试

青年IT男

Spring5 JUnit

Redis 数据同步机制--主从模式

是老郭啊

redis 主从配置 主从同步 redis主从 主从复制

鼓舞人心!主席支持数字经济!央行数字货币研究所为世界制定区块链相关国际标准

CECBC

区块链 金融

又踩Maven的两个坑

xiaoboey

maven Unknown lifecycle phase settings.xml 无效 PowerShell

北京城市副中心将试点法定数字货币

CECBC

数字货币 货币

实战解读丨Linux下实现高并发socket最大连接数的配置方法

华为云开发者联盟

Linux TCP socket 高并发

云图说 | 一分钟带你扫盲云容器黑话

华为云开发者联盟

容器 节点 集群

【基础架构】不同场景下的数据存储技术,你用对了吗?

嘉为蓝鲸

网络 存储 系统 raid 磁盘挂载

不支持原子性的 Redis 事务也叫事务吗?

大头星

Java redis 事务

Golang Package sync 透析

卓丁

sync Go 语言

Docker私有化部署gitlab gitlab-runner

Leon

gitlab 持续集成 runner

快来看看!AQS 和 CountDownLatch 有怎么样的关系?

程序员小航

Java AQS 源码阅读 CountDownLatch JUC

或许是史上最好的AQS源码分析了,你确定要错过?!

InfoQ_d2212957090d

握草,你竟然在代码里下毒!

小傅哥

Java 程序员 小傅哥 bug 有毒代码

DB-Engines 9月数据库排名:ClickHouse一路猛冲,Redis坐稳第七

华章IT

MySQL 数据库 redis Clickhouse

一个银行客户经理的“变形记”

华为云开发者联盟

人工智能 金融科技

为什么企业自主开发软件时,都会使用统一的模块化框架式开发平台?

Learun

敏捷开发 程序设计 开发工具 软件设计 技术方案

XSKY全新一代SDS一体机五大场景之存储+灾备

XSKY融合存储

LeetCode题解:225. 用队列实现栈,两个队列, 压入 - O(n), 弹出 - O(1),JavaScript,详细注释

Lee Chen

大前端 LeetCode

学习 Java,有什么书籍推荐?学习的方法和过程是怎样的?

沉默王二

Java 学习 程序员 书单

[翻译] Go Concurrency Patterns: Pipelines and cancellation[Go并发模式]

卓丁

channel pipeline

浅析LR.Net工作流引擎

Philips

敏捷开发 工作流 软件开发流程 开发工具

有奖征文重磅来袭,来!一起玩把大的!

有只小耳朵

用 Python 实现一个简易版的 Pong 游戏 (一)

Matrix Chan

Python Turtle Python游戏

给DevOps加点料——融入安全性的DevSecOps

禅道项目管理

DevOps 运维 测试 开发 安全性

3. 站在使用层面,Bean Validation这些标准接口你需要烂熟于胸

YourBatman

Hibernate-Validator Bean Validation 数据校验

你问我答:容器平台改造后的安全是如何解决的?

BoCloud博云

云计算 容器 微服务 PaaS 博云

大数据管理:构建数据自己的“独门独院”

华为云开发者联盟

大数据 数据湖

ARTS打卡 第15周

引花眠

微服务 ARTS 打卡计划

oeasy教您玩转linux010206 蒸汽机车 sl

o

降低代码重构的风险_社区_崔康_InfoQ精选文章