干掉你代码中的坏味道

简介:

原文出自【听云技术博客】: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。


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


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

目录
相关文章
|
人工智能 编解码 测试技术
云电脑显卡性能终极对决:ToDesk云电脑/顺网云/海马云,谁才是4K游戏之王?
本文对比了ToDesk云电脑、顺网云和海马云三大平台的性能表现,涵盖游戏实战与AI模型测试。ToDesk云电脑搭载RTX 5090显卡,在4K游戏与大模型支持上表现卓越;顺网云适合中轻度游戏玩家,强调即开即用的便捷性;海马云面向企业用户,提供稳定算力与多任务支持。评测从显卡、处理器、压力测试到网络传输技术全面展开,最终推荐:硬核玩家首选ToDesk云电脑,内容创作者可选ToDesk云电脑或海马云,企业用户则更适合海马云。
2932 23
|
存储 JSON 数据安全/隐私保护
"FastAPI身份验证与授权的奥秘:如何用Python打造坚不可摧的Web应用,让你的项目一鸣惊人?"
【8月更文挑战第31天】在现代Web开发中,保证应用安全性至关重要,FastAPI作为高性能Python框架,提供了多种身份验证与授权方式,包括HTTP基础认证、OAuth2及JWT。本文将对比这些机制并附上示例代码,展示如何使用HTTP基础认证、OAuth2协议以及JWT进行用户身份验证,确保只有合法用户才能访问受保护资源。通过具体示例,读者可以了解如何在FastAPI项目中实施这些安全措施。
899 1
|
缓存 应用服务中间件 Linux
淘宝APP在短视频场景下的IETF QUIC最佳实践
手机淘宝在短视频、图片等多个场景下会用到CDN内容分发网络,手机淘宝技术和阿里云CDN技术有非常多的共建合作,其中包括在IETF QUIC加速产品方向。1月12日的「阿里云CDN重磅升级 | 新一代传输协议QUIC让CDN更快一步」产品发布会中,来自大淘宝平台技术团队,负责手机淘宝网络和网关技术的喵吉,分享了手机淘宝使用IETF QUIC加速产品的应用场景和效果,以及介绍下配套的XQUIC库的情况。以下为分享全文。
1214 67
淘宝APP在短视频场景下的IETF QUIC最佳实践
|
安全 关系型数据库 MySQL
宝塔Linux面板安装教程(+Mysql)
宝塔Linux面板安装教程(+Mysql)
宝塔Linux面板安装教程(+Mysql)
|
机器学习/深度学习 Python
Python 金融量化 道路突破策略(唐奇安道路突破策略&布林带通道及其市场风险)
Python 金融量化 道路突破策略(唐奇安道路突破策略&布林带通道及其市场风险)
2418 0
Python 金融量化 道路突破策略(唐奇安道路突破策略&布林带通道及其市场风险)
|
15天前
|
人工智能 自然语言处理 文字识别
阿里云百炼Qwen3.7-Max简介:能力、优势、支持订阅计划参考
Qwen3.7-Max是阿里云百炼面向智能体时代推出的新一代旗舰模型,对标GPT-5.5、Claude Opus 4.7等闭源旗舰。该模型支持百万级token上下文窗口,具备顶级推理能力、多模态搜索与视觉理解增强、流式输出低延迟响应等核心优势,覆盖编程、办公、长周期自主执行等复杂场景。同时支持OpenAI接口兼容,便于系统快速迁移。用户可通过Token Plan团队或节省计划等订阅方式灵活调用,适合企业级高要求场景使用。
5776 29
阿里云百炼Qwen3.7-Max简介:能力、优势、支持订阅计划参考
|
10天前
|
存储 定位技术 数据库
CodeGraph 如何让 Claude Code减少 7 成工具调用?
CodeGraph 为 Coding Agent 提供本地代码知识图谱,把函数、类、调用链和框架路由提前整理成“项目地图”,减少盲目搜索和文件读取。它不是新 Agent,而是上下文基础设施,让 Agent 更快找到正确代码路径,平均减少 7 成工具调用。
1168 2
|
7天前
|
人工智能 安全 定位技术
CodeGraph深度解析 让Claude Code工具调用直降七成的核心原理与实操教程
如今以Claude Code为代表的AI编程智能体已经成为开发者日常编码、项目重构、漏洞修复的必备工具。但在长期使用过程中,几乎所有开发者都会遇到同一个明显痛点:AI虽然具备强大的代码生成与分析能力,却常常陷入盲目探索的循环中。
941 1