干掉你代码中的坏味道

原文出自【听云技术博客】:http://blog.tingyun.com/web/article/detail/1094

最近团队开始抓代码质量了,总结一下自己的经验,先看看坏代码有哪些特点:

“都一样,不幸的家庭却各有不同”,这句话放到代码里也同样适用。接下来,我们聊一聊如何解决坏代码问题。 

如果我问你,“你们是如何保证团队代码质量的”,你的回答可能是:“我们每次写完代码,都会花一些时间review一下。” 

恩,做的确实不错,但是,做的还不够,除非你是门门考试都100的学霸,否则,借助一些工具还是比较稳妥的办法。 

在这里简单介绍一个代码分析工具RubyCritic,这是一个专门针对Ruby的一个静态代码分析工具。其它语言的,也有相似功能的工具链,我就不做介绍了。 

这是一个命令行工具,第一步就是添加到你的gem库中,当然,还可以使用guard自动化分析。(Ruby的世界,你懂得~) 第二step,在console运行【RubyCritic】命令,就像这样:  

在命令的最后,会生成一个静态页面。长这个样子:  

x轴代表改动频率,Y轴代表代码复杂程度 

这是分析结果的overview,超过200的复杂度的,基本都是坏代码。 

再看看code里的内容: 

对不同文件按照改动频率、复杂度、重复度和坏味道4个维度进行综合评定代码质量等级(和美国考试的成绩打分规则一样)。  

再看看Smell里的内容 : 

RubyCritic对代码分析的原理,其实就是分析一些,被它认为是坏代码的点。注意,我这里使用的措辞是“被它认为,所以,有时候,它不是绝对的正确。” 还可以查看具体的类文件中的代码质量问题。

更多的介绍,详见 https://github.com/whitesmith/rubycritic  

下面,我们针对RubyCritic给我们的一些坏代码的点,有针对性的做些代码调整。

 

这里使用git diff 比较新旧版本的差异。operator原来是实例方法,代码行7,并且里面还有一个if结构体。started_time_and_node 原来是实例方法,代码行4,并且里面还不止一个if结构体。 

笔者review的方式:

1.实例方法修改为类方法(减少混入方法,解耦合,减低负责度)

2.多使用Ruby原生链式操作(减少中间变量,更少的代码,对于脚本语言,就是更快的执行效率,而且很多原生方法是C语言实现。)

3.去掉结构体 (现代编程语言的结构体,让代码具有丰富的逻辑性和可读性,但是缺点就是cpu的额外开销。)  

以上部分,属于语法层面的奇技淫巧。      

第二部分,我们从设计角度分析一下。

它的代码行只有141行,方法也只有7个。但是评级却是C。再看看代码分析细节,这里就展现一小部分,简直就是惨不忍睹,不好意思全展现给大家看了。        

没有人会一开始就这样写代码,这种坏代码,永远都是渐渐变馊的。不过笔记仔细想来,当年遇到过比着还馊1000倍的代码(1000倍都不算过分)。            

这是笔者做的第一版重构结果。

这里使用了策略模式。Stats_hash不再是充当一个集合的作用,现在变成了一个环境类,将原来依赖if结构数据分装到不同的行为类中。 

第二版的改动计划是,引入work-job的模式,并发执行4个job。

第三版改动计划就是利用回调方式,去掉与该类不相干的代码,将逻辑分装到行为类里。    

好了,写到这里,基本的代码层面的优化思路就这些了,其它就是开支散叶的过程,这里就不冗余了。下一节,咱俩聊一聊性能优化的一些思路。

时间: 2024-08-02 09:48:42

干掉你代码中的坏味道的相关文章

解析大型.NET ERP系统 代码的坏味道

1  对用户输入做过多的约定和假设 配置文件App.config中有一个设定报表路径的配置节: <add key="ReportPath" value="C:\Users\Administrator"/> 在程序中有一个销售报表文件SalesReport.rpt,用代码调用这个报表,可能会写成: string salesReport=ReportPath + "SalesReport.rpt"; 因为路径末尾没有加反斜线,会抛出找不到

那些有坏味道的代码

最近每天早上上班的第一件事情就是把昨天写的代码重构优化一下,以前没弄过,现在发现这个过程真是非常爽的.看着代码一点点变好,还是很不错的感觉. 最经常遇到的一些坏味道这里列一下: 嵌套太多 1 2 3 4 5 6 7 8 9 10 if (!empty($data) {     if (is_array($data)) {         foreach($data as $item) {             // Do something         }         return $

《重构》阅读笔记-代码的坏味道

决定何时重构.何时停止和知道如何重构一样重要! 开发者必须通过实践培养自己的经验和直觉,培养出自己的判断力:学会判断一个类内有多少个实例变量算是太大.学会判断一个函数内有多少行代码才算太长. 重复代码(Duplicated Code) 如果你在一个以上的地方看到相同的程序结构,那么可以肯定:设法将它们合而为一,程序会变得更美好!你需要决定这个重复的代码放在哪里比较合适,并确保它被安置之后就不会在别的地方再次出现. 过长函数(Long Method) 程序越长越难以理解.现代OO语言几乎完全免去了

领域建模中的七种坏味道信息

领域建模(见侧边栏)作为一项强大的技术,常备于很多IT专业人士的工具箱之中.令人遗憾的是,在过 去的几年间,因为领域建模的几个问题导致人们对其大失所望,尤其是在敏捷领域.这种方式的两个切实存在 的问题就是:它会消耗太长的时间并且很易于导致"分析瘫痪(analysis paralysis"),而这会导致停滞( "spinning wheels").我们为领域建模提供了一种方式,可以用来解决这些问题. 我们会讨论领域 模型中的一些信号,这些信号会告诉你要提出更多的问题.

aspnetforums 代码中的web设计模式

web|设计 一直不怎么理解aspnetforums中的设计模式,大量的使用自定义控件,n-per的结构显得过于复杂.开始以为是因为要load user def skin的缘故,今天无意中看到一篇微软中国社区中的文章,地址 http://www.microsoft.com/china/community/Column/93.mspx 看过后懂了一些.对比文章和aspnetforums的代码,获益量多. 文章内容如下: 专栏作品领悟Web设计模式袁剑 -----------------------

[设计模式]Asp.Net Forums 代码中的web设计模式

 来源: 版权所有:UML软件工程组织 作者:袁剑 摘要 本文介绍了在.NET框架下应用Web设计模式改进WebForm程序设计的一些基本方法及要点. 关键字 设计模式,ASP.NET,WebForm,MVC,Page Controller,Front Controller,Page Cache 目录 引言经典的WebForm架构设计模式MVC模式下的WebFormPage Controller模式下的WebFormFront Controller模式下的WebFormPag

java-优化-代码中的优化(1)

1.尽量使用final修饰符. 带有final修饰符的类是不可派生的.在JAVA核心API中,有许多应用final的例子,例如java.lang.String.为String类指定final防止了使用者覆盖length()方法.另外,如果一个类是final的,则该类所有方法都是final的.java编译器会寻找机会内联(inline)所有的final方法(这和具体的编译器实现有关).此举能够使性能平均提高50%. 2.尽量重用对象. 特别是String对象的使用中,出现字符串连接情况时应使用St

利用FindBugs减少代码中的bug数学习

FindBugs 作用 开发人员在开发了一部分代码后,可以使用FindBugs进行代码缺陷的检查.提高代码的质量,同时也可以减少测试人员给你报的bug数. 静态分析工具承诺无需开发人员费劲就能找出代码中已有的缺陷.当然,如果有多年的编写经验,就会知道这些承诺并不是一定能兑现. 代码缺陷分类 根据缺陷的性质,大致可以分为下列几类 ·Bad practice  不好的做法·Correctness   可能有不正确·Dodgy code     糟糕的代码·Experimental  实验·Inter

[译] 代码中添加注释之好坏丑

本文讲的是[译] 代码中添加注释之好坏丑, 原文地址:Putting comments in code: the good, the bad, and the ugly. 原文作者:Bill Sourour 译文出自:掘金翻译计划 译者: bambooom 校对者:zhangqippp.steinliber 代码中添加注释之好坏丑 题图是克林特 · 伊斯特伍德在<黄金三镖客>中剧照. 如果你以前听过这句话就打断我... 「好的代码自身就是文档」. 在我 20 多年以写代码为生的经历中,这是我听