热门标签 | HotTags
当前位置:  开发笔记 > 运维 > 正文

【重构之法】代码的坏味道

代码的坏味道坏味道意指代码中出现的可以被改进的地方。当你嗅到坏味道的时候,也就意味着重构的时机到了。重构就是对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改
代码的坏味道

 

坏味道意指代码中出现的可以被改进的地方。当你嗅到坏味道的时候,也就意味着重构的时机到了。

重构就是对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改成本。

 

以下是《重构》中列出的“坏味道“。

 

1. 重复代码

 

  重复是代码腐朽之源。重复意味着当发生变化时,总是有很多的地方需要修改,也就是说需要对很多不同的地方负责。即使有着高级工具的辅助,对于跨函数、跨类之间的大量重复的同步修改都不会是一件轻而易举,并且能保证不会犯错的事情。

  每一处重复都意味着维护时的一份责任。消除重复就可以最大化的减少职责,也降低出错的可能性。

  抛开出错的可能性不谈,重复一般意味着业务逻辑的抽象还不够合理。

 

2. 过长函数

 

  没有什么是增加一层“间接层”不能解决的。如果有,那就增加两层。

  程序越长越难以理解。这可能与每个人大脑的结构有一定的关系,可能有些人的大脑的“栈”比较深,适应那些长函数。但对于大部分程序员、大部分人而言,太长的函数会导致“栈溢出”。

  将一个长函数拆分成多个小的函数,无疑会增加更多的函数间调用。在直觉上,这样需要增加额外的开销。但是,现代OO语言几乎已经完全免除了进程内的函数调用的开销。

 

3. 过大的类

 

  过大的类的一个标识就是,类中出现大量的实例变量。

  不是从一个类的代码行数来判断是否类过大。而是需要从的职责来判断,如果它拥有不同的职责,那么就需要将不同的职责拆分到不同的类中。

  单一职责原则。

 

4. 过长的参数列表

 

  过长的参数列表会导致难以理解,太多参数会造成前后不一致、不易使用。

  传递太多的参数数据,会带来另外一个问题:很难记住参数的顺序。也就是说,不容易记住每一个参数位置传入的值分别是什么意思。如果传入的是一个对象,则可以通过对象的实例变量来取值。屏蔽了参数顺序间的问题。

  但,有时候如果不希望造成“被调用对象”与“较大对象”间的某种依赖关系,这时将数据从对象中拆解出来单独作为参数也是合理的。

 

5. 发散式变化

 

  一个类受多种变化的影响。

  针对某一外界变化的所有修改,都只应该发生在单一类中,而这个新类内的所有内容都应该反应此变化。

  应该找出某特定原因而造成的所有变化,然后将它们提炼到一个类中。

 

6. 霰弹式修改

 

  一种变化引发多个类相应的修改。

  也就是,逻辑概念上相近的代码被分散四处。这样导致很难寻找,也会很容易忘记某个修改。

  应该把所有需要修改的代码放进同一个类中。

 

7. 依恋情结

 

  函数对某个类的兴趣高过对自己所处类的兴趣。这里所谓的兴趣就是指,对那个类的函数、数据的调用。

  一个函数会用到几个类的功能,将它置于何处的原则:判断哪个类拥有最多被此函数使用的数据,然后就将这个函数将那些数据摆在一起。

 

8. 数据泥团

 

  总是捆绑出现在一起的数据应该拥有属于它们自己的对象。

 

9. 基本类型偏执

 

  不要执着于使用基本数据类型。

 

10. switch 语句

 

  减少使用 switch 语句。从本质上说,它意味着重复。

  可以考虑使用多态来替换它。但是对于在单一函数中出现的使用多态,有点小题大做。

 

11. 平行继承体系

 

  当为某个类增加一个子类,必须也为另一个类相应的增加一个子类,便是出现了这个问题。

  消除的策略是:让一个继承体系的实例引用另一个继承体系的实例。

 

12. 冗余类

 

  对于无用的类,应该消除。这里的“无用”可能是因为重构使得它原有的工作被别的类瓜分了。

 

13. 夸夸其谈未来性

 

  不要为了出于应对变化的目的,来将一个类打造的“过于”灵活。

  变化是程序员最大的敌人。问题不在于“变化会出现”,而在于“难以预料变化出现的方式”。“变化”的粉墨登场总是会让我们措手不及。

  提前就想要做好应对变化的准备,大部分时候都是挖了一条“马奇诺防线”。投入巨大,收效甚微。

  我们需要让代码具有灵活性,但是过于的灵活带来的问题就是代码复杂度的增加。

 

14. 令人迷惑的暂时字段

 

  对象在所有的时候被认为需要它的所有变量。对于那些仅为某种特殊情况而设置的实例变量,会使得代码难以理解。

 

15. 过度耦合的消息链

 

  消息链就是“开火车”,一长串的“.”会让你lost。

  “不要与陌生人讲话。”

 

16. 中间人

 

  “中间人”就是把别人对它的调用“委托”给其他的对象。

 

17. 狎昵关系

 

  对于过分亲密的类,需要移动它们的函数和实例变量来帮它们划清界限。

  继承往往会造成过度亲密,因为子类对超类的了解总是超过后者的主观愿望。

 

18. 异曲同工的类

 

  两个函数做同一件事,却有不同的签名,需要根据它们的用途重新命名。

 

19. 不完美的库类

 

  复用别人的库时,可能库不够好,而往往我们不可能修改其中的类使其完成我们希望的工作。

 

20. 纯粹的数据类

 

  它们就是数据容器。不明白为什么这会被认为是一种“坏味道”。我们经常用到的"bean"。

 

21. 被拒绝的遗赠

 

  子类应该继承超类的函数和数据。但如果不想要继承所有的数据呢?该怎么拒绝这样的“传承”。

 

22. 过多的注释

 

  如果需要添加注释来解释函数,或许意味着需要拆分出一些小的函数,或给函数重命名。

 


 

 

  代码的坏味道有如厨房的油污,开始时不会觉得有多大的影响,但时间长了就会累积成“恶心”又难以“清除”的污渍。我们需要保持每天的清扫,而不是定期的“大扫除”。上面的“味道”就是一点一点的“油星”溅在“厨房”里,看到它们就顺手擦掉吧!

 


推荐阅读
  • Android中高级面试必知必会,积累总结
    本文介绍了Android中高级面试的必知必会内容,并总结了相关经验。文章指出,如今的Android市场对开发人员的要求更高,需要更专业的人才。同时,文章还给出了针对Android岗位的职责和要求,并提供了简历突出的建议。 ... [详细]
  • Spring特性实现接口多类的动态调用详解
    本文详细介绍了如何使用Spring特性实现接口多类的动态调用。通过对Spring IoC容器的基础类BeanFactory和ApplicationContext的介绍,以及getBeansOfType方法的应用,解决了在实际工作中遇到的接口及多个实现类的问题。同时,文章还提到了SPI使用的不便之处,并介绍了借助ApplicationContext实现需求的方法。阅读本文,你将了解到Spring特性的实现原理和实际应用方式。 ... [详细]
  • 本文介绍了Hyperledger Fabric外部链码构建与运行的相关知识,包括在Hyperledger Fabric 2.0版本之前链码构建和运行的困难性,外部构建模式的实现原理以及外部构建和运行API的使用方法。通过本文的介绍,读者可以了解到如何利用外部构建和运行的方式来实现链码的构建和运行,并且不再受限于特定的语言和部署环境。 ... [详细]
  • 处理docker容器时间和宿主机时间不一致问题的方法
    本文介绍了处理docker容器时间和宿主机时间不一致问题的方法,包括复制主机的localtime到容器、处理报错情况以及重启容器的步骤。通过这些方法,可以解决docker容器时间和宿主机时间不一致的问题。 ... [详细]
  • 本文介绍了Web学习历程记录中关于Tomcat的基本概念和配置。首先解释了Web静态Web资源和动态Web资源的概念,以及C/S架构和B/S架构的区别。然后介绍了常见的Web服务器,包括Weblogic、WebSphere和Tomcat。接着详细讲解了Tomcat的虚拟主机、web应用和虚拟路径映射的概念和配置过程。最后简要介绍了http协议的作用。本文内容详实,适合初学者了解Tomcat的基础知识。 ... [详细]
  • Tomcat/Jetty为何选择扩展线程池而不是使用JDK原生线程池?
    本文探讨了Tomcat和Jetty选择扩展线程池而不是使用JDK原生线程池的原因。通过比较IO密集型任务和CPU密集型任务的特点,解释了为何Tomcat和Jetty需要扩展线程池来提高并发度和任务处理速度。同时,介绍了JDK原生线程池的工作流程。 ... [详细]
  • 本文介绍了Java的集合及其实现类,包括数据结构、抽象类和具体实现类的关系,详细介绍了List接口及其实现类ArrayList的基本操作和特点。文章通过提供相关参考文档和链接,帮助读者更好地理解和使用Java的集合类。 ... [详细]
  • 本文介绍了电流源并联合并的方法,以及谐振电路的原理。谐振电路具有很强的选频能力,通过将电感和电容连接在一起,电流和电压会产生震荡。谐振频率的大小取决于电感和电容的大小,而电路中的电阻会逐渐降低震荡的幅度。电阻和电容组成的电路中,当电容放完电后,电阻两端的电压为0,电流不再流过电容。然而,电感是一种特殊的器件,当有电流流过时,线圈会产生感应磁场,阻止电流的流动,从而使电流不会减小。 ... [详细]
  • 标题: ... [详细]
  • 单点登录原理及实现方案详解
    本文详细介绍了单点登录的原理及实现方案,其中包括共享Session的方式,以及基于Redis的Session共享方案。同时,还分享了作者在应用环境中所遇到的问题和经验,希望对读者有所帮助。 ... [详细]
  • 本文介绍了在Docker容器技术中限制容器对CPU的使用的方法,包括使用-c参数设置容器的内存限额,以及通过设置工作线程数量来充分利用CPU资源。同时,还介绍了容器权重分配的情况,以及如何通过top命令查看容器在CPU资源紧张情况下的使用情况。 ... [详细]
  • 集合的遍历方式及其局限性
    本文介绍了Java中集合的遍历方式,重点介绍了for-each语句的用法和优势。同时指出了for-each语句无法引用数组或集合的索引的局限性。通过示例代码展示了for-each语句的使用方法,并提供了改写为for语句版本的方法。 ... [详细]
  • Python SQLAlchemy库的使用方法详解
    本文详细介绍了Python中使用SQLAlchemy库的方法。首先对SQLAlchemy进行了简介,包括其定义、适用的数据库类型等。然后讨论了SQLAlchemy提供的两种主要使用模式,即SQL表达式语言和ORM。针对不同的需求,给出了选择哪种模式的建议。最后,介绍了连接数据库的方法,包括创建SQLAlchemy引擎和执行SQL语句的接口。 ... [详细]
  • position属性absolute与relative的区别和用法详解
    本文详细解读了CSS中的position属性absolute和relative的区别和用法。通过解释绝对定位和相对定位的含义,以及配合TOP、RIGHT、BOTTOM、LEFT进行定位的方式,说明了它们的特性和能够实现的效果。同时指出了在网页居中时使用Absolute可能会出错的原因,即以浏览器左上角为原始点进行定位,不会随着分辨率的变化而变化位置。最后总结了一些使用这两个属性的技巧。 ... [详细]
  • 开发笔记:Docker 上安装启动 MySQL
    篇首语:本文由编程笔记#小编为大家整理,主要介绍了Docker上安装启动MySQL相关的知识,希望对你有一定的参考价值。 ... [详细]
author-avatar
baaiiii
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有