读书「重构」

设计一个「类」的时候有什么原则

  • 终极目标:提升代码的可理解性。
  • 一个类应该是一个清楚的抽象,处理一些明确的责任。
  • 封装,每个对象应该尽可能少了解系统的其他部分。这样一旦发生变化,需要了解这一变化的对象就会比较少。
  • 修改函数和查询函数分开设计,在查询函数里不要做任何修改,同时最好用 get 和 set 命名。

重构的基本原则?

  1. 添加新功能,和重构不可同时进行,重构时不加新功能,加新功能时不重构。
  2. 重构时不应该添加任何测试。
  3. 小步前进,频繁测试。
  4. 一个函数应该且只应该完成一件事情。

对一个对象/函数来说,哪些地方很可能需要重构?

  1. 拥有太多实例变量
  2. 有超过百行的函数
  3. 函数的参数超过三个
  4. 牵一发动全身,如果经常一个改动需要在许多不同的类内做出小修改。
  5. 如果有些数据项经常会成群地出现在一起,很可能需要拥有他们自己的对象。判断方法是删掉这些数据项中的一项,如果其他的数据立刻变得没有意义,那么说明他们应该在一起。

重构的方法有哪些?

  1. 分解函数

    • 当看到一个过长的函数或者一段需要注释才能让人理解用途的代码,把这段代码放到一个独立函数里面去
    • 函数命名应该以「做什么」而不是「怎么做」来命名。
  2. 用对象取代函数

    • 如果有一个大型函数,其中对局部变量的使用使你无法使用Extract Method,考虑把这个函数放进一个单独的对象中。然后再分解函数。
  3. 移动类字段

    • 如果一个 A 类里的一个字段与 B 对象有更多的交流:经常被后者调用,考虑把 A 中的这个字段放到 B 里。
  4. 移动类函数

    • 与移动类字段相似:如果一个 A 类里的一个函数与 B 对象有更多的交流:或者调用后者,或者被后者调用,考虑把 A 中的这个函数放到 B 里。但优先考虑移动类字段。
  5. 分解类

    • 如果类的责任过于复杂,考虑分解这个类,抽象出一个新类。
    • 一个方法是思考如果把这个函数或者变量去掉之后,是不是其他的函数或变量就没有意义了?
    • 另一个方式是某些特性需要用一种方式子类化,而另一些特性需要用另一种方式子类化,那就意味着这个类需要分解。
  6. 隐藏委托(Delegate)

    • 如果某个 Client 必须通过对象 A 的某个字段获得另一个对象 B,然后调用 B 的函数,那么 Client 就必须知道这一层委托关系,如果这一层委托关系发生变化,就不得不通知 Client,可以在把在 A 中放置一个简单的委托函数,将委托关系隐藏起来,去掉这一层依赖。
    • 当 Client 调用 B 的所有函数都被 A 承包了,Client 也就不需要知道 B 对象了。
    • 隐藏委托也是一把双刃剑,会使委托类 A 非常臃肿,这时候直接调用 B 反而可能更好,掌握合适的隐藏委托程度。
  7. 外加函数

    • 尽量不要重载原始类函数,如果需要增加新功能,可以继承原始类,增加新函数。
  8. 公开的字段自封装

    • 用 get 和 set 获取值。Python 并没有 Public 关键词,因此 Python类的所有属性都是可以直接访问的,应用这个设计理念,最好把 Python 类的所有字段统一在开头加上_以示私有变量,公开的变量用 @property 装饰器包装。
    • 如果字段是一个集合(list,set, dict等),谨慎对待 set 函数,需要的话,用 add,remove 会比 set 要更好。
  9. 简化条件表达式

    • 尽管一个函数最好只有一个出口,但为了这一个出口的设计而加上多重 if else 判断并不一定划算。
    • 多重 if else 用来处理异常或者说处理完了已经对函数后半部分没有兴趣的话,可以直接 return 或者抛出异常。
    • switch case 的情况下,使用「多态」设计模式,将条件表达式的每一个分支放进一个子类内的函数实现,然后将原始函数声明为抽象函数。
  10. 使用断言

    • 某些代码只有在某个条件为真的时候才能正常运行,此时与其用注释,不如使用断言来标明。
    • 不要滥用断言,只用它来检查「一定必须为真」的条件。
    • 如果断言的约束条件不满足的情况下,程序依然可以正常运行,考虑拿掉断言。

参考

Martin Fowler 重构——改善既有代码的设计

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,592评论 18 139
  • 《重构》读书笔记 总览 第一部分 第一章从实例程序出发,展示设计的缺陷,对其重构可以了解重构的过程和方法。 第二部...
    白桦叶阅读 2,371评论 2 5
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,567评论 18 399
  • BSON mongodb副本集 http://www.cnblogs.com/visionwang/p/32904...
    不系流年系乾坤阅读 289评论 0 0
  • 在一天工作的大部分时间里,面对的是接上互联网的电脑,想必这是大家的大同小异之处,但接下,若看的网页、所接收的内容来...
    捡石头的村童阅读 368评论 0 3