做好一点可让遗留代码起死回生

修改遗留代码的艺术

对于程序员来说,最怕也是最不愿意做的一件事情就是修改遗留代码。因为大部分情况下遗留代码是人家写的代码,又烂又长,晦涩难懂,在不能完全读懂代码的情况下修改代码,是非常危险的。

在《修改代码的艺术》这本书里,作者是这么定义遗留代码的:

遗留代码是没有测试守护的代码。

为什么这么说呢?因为代码会随着需求变更和时间推移而慢慢变坏,如果想一直保持代码的整洁,就必须持续地重构代码以改善代码的结构与设计,就好比我们要保持房间的整洁,就必须每天整理房间,否则房间肯定会变得乱七八糟。而持续重构的前提条件是要有测试来保证我们所做的改动不破坏已有代码的逻辑。所以,如果没有测试守护,我们就不敢重构,代码就会逐渐变成遗留代码。

那有什么方法能让遗留代码起死回生吗?

在修改遗留代码的时候,设法让代码以最小的成本运行起来,并在最短的时间内给出反馈。

讲个故事吧,我们公司的小U刚接手一个遗留系统,这个系统会接收另一个系统发出的订单,数据传输是通过FTP,格式是XML,如下图所示,通过Scheduling Server,系统每隔5分钟会读取FTP上的文件,然后根据解析出来的内容创建或者更新订单,并把订单结果存储到数据库中。


legacy system

在小U还不太熟悉代码的时候,就接到一个需求,需要在订单接口中加入一个新信息“remark”,于是小U花了一些时间研究代码,并成功找到了读取FTP文件和处理订单的代码:

public class ReceiveOrderMessageTask {    
    public void execute() {
        connectToFtp(readFTPConfig());
        List<String> fileContentList = readAllFiles("/in/orders");
        for (String fileContent : fileContentList) {
            OrderMessage orderMessage = JAXB.unmarshal(fileContent, OrderMessage.class);
            new ReceiveOrderTransaction(orderMessage).execute();
        }
    }
}

小U一开始还觉得挺幸运的,因为这段代码写得还算简单明了,ReceiveOrderMessageTask每五分钟会被SchedulingServer触发一次,读取FTP上的文件内容,然后把内容转成订单信息写入数据库,但是当小U想跑这段代码的时候,发现事情并不那么简单,小U必须先完成以下5个步骤:

  1. 在本地环境中配置好Scheduling Server并把它启动起来;
  2. 在本地环境中配置好Legacy System并把它启动起来;
  3. 找到本地环境连接的是哪个FTP,并往FTP上扔一个正确的订单文件;
  4. 等5分钟;
  5. 找到本地环境连接的是哪个数据库,在数据库里查看并验证订单是否正确生成;

对于新手小U来说,这个过程一点都不简单,小U花了整整一个下午才把整个流程跑通,事后小U觉得非常不值得,因为他花了一下午只是为了把这段代码跑起来。痛定思痛,小U想清楚了问题的本质,其实核心逻辑就是解析XML文件并生成订单,这些代码和Scheduling Server,FTP甚至是数据库半毛钱关系都没有。那怎么才能在不搭建任何外部环境的情况下就把代码跑起来呢?小U把解析xml到java object的代码移到ReceiveOrderTransaction中并写了下面这个测试:

public class ReceiveOrderMessageTest {    
    @Test
    public void testReceiveOrderMessage() {
        String xml = "<?xml version = 1.0 encoding = UTF-8"> " +
                             "<OrderMessage> " +
                             "    <orderNo>520131415</orderNo> " +
                             "    <remark>unit tests can cure legacy code</remark> " +
                             "    ... " +
                             "</OrderMessage>"
        Order order = new ReceiveOrderTransaction(xml).execute();
        assertEquals("unit tests can cure legacy code", order.getRemark());
    }    
}

有了这个单元测试,核心代码1秒钟内就跑起来了,小U在5分钟之内就很有信心地完成了所有代码的改动,事后小U特别兴奋,他说:

“如果以后再有新人做订单接口的改动,一定会很轻松,现在我虽然只检查了订单上remark信息是否是正确的,接下来我会逐步补充订单其它关键信息的检查,这样新人也不用担心他们的改动会破坏已有的逻辑了。随着这样的测试越来越多,大家会更通过重构逐步改善既有代码的设计,通过持续的改善,遗留代码一定会起死回生的!”

总结一下,要让遗留代码起死回生,你就要让代码以最低成本运行起来,并在最短的时间内给出有意义的反馈,在做好这一点的基础上,你才可能持续地重构代码,保持代码的整洁,改善代码的设计。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,087评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,544评论 25 707
  • 1、第八章 Samba服务器2、第八章 NFS服务器3、第十章 Linux下DNS服务器配站点,域名解析概念命令:...
    哈熝少主阅读 3,633评论 0 10
  • 从北京回上海,冥冥之中的指引,我中间到了济南,看望卜姐姐,也就是曾经有过两面之缘,有过无数交集的茶人老法师。 不知...
    Jessy自由行走的猫阅读 592评论 1 1
  • 无论身处哪个角落,谁又能遮蔽花儿的姿采,而那些拼命挤兑花儿的枝蔓,倒仿佛就是为显出花儿的珍贵与不凡。 纵使万千宠爱...
    文心访艺阅读 234评论 0 1