大话重构 之 解决万恶之首“重复代码”

排在坏味道之首的是重复代码。为什么它如此臭名昭著?不需要一码再解释了吧。

提示:对于任何事物,代码中只应该出现一次,而且是唯一的一次。

下面我们将介绍如何消除几种典型的重复代码,以及如何培养消除重复代码的习惯。

在同一个类中重复

第一种是在同一个类中存在重复代码,它最容易识别,也最容易解决。看下面的例子:

try {
    executorService.runTasks(...)
    timer.scheduleAtFixedRate(
        () => saveProgress(getProgress()),
        period, period
    )
} finally {
    executorService.shutdown()
    timer.cancel()
    saveProgress(getProgress())
}

saveProgress(getProgress())出现在两个地方,可以通过 提取方法 来解决。

try {
    executorService.runTasks(...)
    timer.scheduleAtFixedRate(
        () => persistProgress(),
        period, period
    )
} finally {
    executorService.shutdown()
    timer.cancel()
    persistProgress()
}

def persistProgress() {
    saveProgress(getProgress())
}

如果一个类超级长,上千行,那即使在一个类中也很难识别重复。这涉及到另一个坏味道“超长类”,《消灭坏味道》后续会有专门的文章来解决它。

在同一个类树下重复

第二种是在同一个类树下的不同子类中重复,比第一种识别起来困难些。

class Child1 extends Parent {
    def run() {
        init()
        process()
    }
    ...
}

class Child2 extends Parent {
    def run() {
        process()
    }
    ...
}

可以通过 上移方法模板方法 将公共部分上移到共同的父类。

class Parent {
    def run() { // 模板方法
        init()
        process()
    }
    
    def init() {}
    def process() //无函数体,等同于虚函数
}

class Child1 extends Parent {
    override def init() { ... }
    override def process() { ... }
}

class Child2 extends Parent {
    override def process() { ... }
}

在不相干的类中重复

第三种是在两个完全不相干的类中,如果不是专门地寻找很难发现。

class App1 {
    val last3 = scores.sort().take(3)
}

class App2 {
    val last10 = scores.sort().take(10)
}

可以先 提取方法 ,然后 移动方法 到新建的类,来消除重复。

class App1 {
    val last3 = Seqs.lastN(scores, 3)
}

class App2 {
    val last10 = Seqs.lastN(scores, 10)
}

object Seqs { // 新建的工具类
    def lastN[E](seq: Seq[E], n: Int)
        : Seq[E] = { // 返回值类型
        seq.sort().take(n)
    }
}

上面的例子,是在业务上没有联系的两个类。

有可能是业务上有联系,或者直接就是类似的,这个时候应该 抽取公共基类 ,然后按照第二种重复去重构。

细心的看官会发现,三种类型的重复有递进关系,离的越来越远,识别起来越来越难,解决起来也是。“在不相干的类中重复”可以通过重构转换成前两种,然后继续重构得以解决。

要培养好的编码习惯

good habit
good habit

解决重复并不困难,困难的是发现重复。发现重复并不困难,困难是培养发现重复的习惯。一码在写代码完成功能前,会习惯性地左右前后看看,别人是否已经做过相关的功能,和我要做的是否可以共用代码,这就很容易发现重复。

提示:如果你要动的是一个点,那么先了解她周围的一圈。

不仅解决了重复,而且经过一段时间,我就发现对整个系统的理解程度,在不知不觉中提高了不少。

其实和做人是一样的,著名的理财教练博多舍费尔在《小狗钱钱的爸爸 - 教你实现财务自由》一书中也强调:

不断将私人领域变成主导领域,这是你对未来的责任。

私人领域是生活中与我相关的,主导领域是由我直接或间接影响的。碰到事情不能光是自扫门前雪,需要积极地参与,变被动为主动,这样才会有更多的机会,让我们越来越好。

总结

希望各位看官不只是学会了消除重复的技能,而且理解了文中的两个重要提示。

  1. 对于任何事物,代码中只应该出现一次,而且是唯一的一次。
  2. 如果你要动的是一个点,那么先了解她周围的一圈。

关于示例代码的说明

一码觉得要讲如何写好代码,就得拿代码来说事。不过手机屏幕上代码的展示是个大问题。为了保证示例代码能让大家读得明白,一码做了些取舍:

  1. 用片段,而不是完整可运行的代码,突出重点
  2. 语言用Scala,因为她简洁易读

千万不要觉得不懂Scala,有压力,一码会用她里面最平易近人的部分,放心吧。

提示:Scala是JVM平台上的一种语言,拥有简洁和可扩展的特性,现在非常流行的大数据处理框架Spark就是用Scala开发的,学点Scala不会亏本的。

分类 大话重构

优雅程序员 原创 转载请注明出处

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

推荐阅读更多精彩内容