干掉你代码中的坏味道

简介:

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

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

1.png

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


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


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


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


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

2.png

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

3.png

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


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


再看看code里的内容: 

4.png

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


再看看Smell里的内容 : 

5.png

6.png

7.png

8.png

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

9.png

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


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

10.png

 


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


笔者review的方式:


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


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


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


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


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

11.png

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

12.png

13.png

14.png

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


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


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

15.png

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


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


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

目录
相关文章
|
数据库
代码坏味道
代码坏味道
119 0
消除代码坏味道
读完本章的收获:代码规范、代码可读性、鲁棒性的代码好坏案例,写出好代码的能力。
消除代码坏味道
|
数据库
我又写了一堆烂代码
“我又写了一堆烂代码!” 这句话我经常对自己说,目的是为了督促自己不断地思考所写的代码是否足够可靠。
63 0
|
存储 机器学习/深度学习 监控
我是傻x,被迫看了 1 天源码,千万别学我!
大家好,我是零一,之前一直很忙,业余时间的输入和输出都 24k铝合金人眼可见 得下降,这不最近上海疫情严重么,算了一下居家办公也已经将近 1个月了,这才有些许时间学习,所以最近也是一直在鼓捣点新东西,不为别的,主要是想再多输入一些新的知识
175 0
我是傻x,被迫看了 1 天源码,千万别学我!
SonarQube的代码坏味道详解
SonarQube的代码坏味道
1460 0
消灭 Java 代码的“坏味道”
阿里妹导读:代码中的"坏味道",如"私欲"如"灰尘",每天都在增加,一日不去清除,便会越累越多。如果用功去清除这些"坏味道",不仅能提高自己的编码水平,也能使代码变得"精白无一毫不彻"。这里,一直从事Java研发相关工作的阿里高级地图技术工程师王超,整理了日常工作中的一些"坏味道",及清理方法,供大家参考。
6970 0
x3d
|
程序员 PHP 开发工具
改改"坏"代码
程序猿很多时候费了九牛二虎之力使用各种黑科技实现了某个功能,终于可以交差,但整个过程就像个噩梦,一般人是不太愿意回过头去阅读自己写的代码的,交出去的代码就让它如往事般随风吧。 可你不愿读自己的代码,却避免不了去读别人的代码,正如别人不愿读你的代码一样。
x3d
979 0
乱想
1.我们觉得放松的大学四年,正是美国学生最努力拼搏的四年。 2
769 0