“ 一颗老鼠屎,坏了一锅粥,代码也是如此。”

在我们的项目中,也许在刚开始开发的时候,大家都会遵从一些规范来实施,但是当业务进度催的紧,或者人员变动,随着时间的迁移,项目不断的迭代以后,这时的代码可能就会出现一些“坏味道”了。

“坏味道”代码的出现可能不会影响我们的业务逻辑,大家自然也就比较容易忽视掉了,但是这如同是给我们代码埋下的定时炸弹,当爆炸的那天,需要我们背锅处理的时候,就会后悔当初为何不去解决这些问题呢?下面我们来看一下有哪些“坏味道”代码可以提前处理的吧。

1、多此一举型代码。

if(a > b){    return true;
}else{  return false;
}

也许一些经验不那么老道的开发会觉得这段代码没问题呀,可以跑得通,确实,在逻辑上是没问题的,但是有更简洁明了的写法为何不用?if() 里面的条件是boolean ,然后我们的返回值也是boolean,所以可以改写成

return a > b;

2、瞎命名型代码。

int a;
String wzbt; // 文章标题
String fastdi; //fast di 快递  。。中西结合...

以上只是不规范命名的实例的冰山一角,良好的命名除了见名知意以外,还可以在长时间以后回来阅读代码时,更快的回忆起业务逻辑,不至于在各种无解的命名中乱了手脚,为了一时的方便而随意命名是非常不值得的。

3、if完一定要加else型代码

if(condition){ //dosm
}else{  return ;
}
if(condition){  //dosm
}else{  throw new Exception();
}
while(xx){   if(condition){  //dosm  }else{  continue;       }
}

很多情况下,我们通过一些语句的前置类减少不必要的else,让代码看起来更简练清晰。

if(!condition){   return ;
}
//dosm
if(!condition){    throw new Exception();
}
//dosm

  4、复制粘贴型

举个例子,项目中A模块引入B模块的优惠券业务,此时C模块也要引入B模块的优惠券业务,由于此时的优惠券业务可能是B模块中的几行代码,很多人就为了贪图方便,直接复制这几行代码直接放到C模块了。so easy,代码完美运行。

看起来似乎又没什么毛病,此时程序员的天敌产品经理过来了,他说在要在优惠券逻辑前面加点限制条件,ok,那么此时就要改动A模块跟B模块2份代码,而且要保持一致性,这个需求就完成了。过了一个版本,D模块也要引用优惠券业务,此时你又愉快的复制过去,然后可爱的产品经理又过来跟你说,这个版本我们要砍掉前面的限制条件...这时候你就要同步三段代码...跟产品经理的一场大战估计在所难免了。

所以从上面的案例中,如果我们一开始不偷懒把公共逻辑抽取出来,在各个模块引用的话,不论怎么修改,我们只要维护一份逻辑就可以,不至于手忙脚乱。

5、又长又臭型代码

此类坏味道代码一般出现在“有历史“的代码中,经过不同开发人员的迭代,一个方法可能会出现几千行的情况,即使有注释,也会让人看得痛不欲生,这时候刚接手修改的人必然会说一句“WTF”了。

所以这就要求我们在平时写代码的过程中养成提炼的习惯,一般来说,当某块业务逻辑需要注释来说明的时候,一般都可以提炼成方法来调用,通过这种方式会使得阅读代码的时候逻辑更加清晰。

还有一种又长又臭情况是出现在方法的参数中,不断的迭代过程也会导致参数的增加或者修改,甚至有看过朋友公司的代码出现一个方法10多个参数的情况。一般来说,当参数超过5个的时候就要考虑封装到对象当中了。

6、无病呻吟型

//输出info日志
logger.info("xxx");
//定义num变量
int num  = 0;
...

上面举例的是一些无关痛痒的注释,当代码中充斥着这些玩意的时候会让人觉得很臃肿,当你做到上面五点的时候,代码已经不需要太多注释了(),所以我们的注释要注释到痛点,具体可参考《阿里java开发规范手册》

细节决定成败,在我们工作的过程中,当然还有很多需要我们注意的细节,大家有什么心得可以留言交流一下~

最后推荐一下 <重构 改善代码的既有设计>这本书,比较详细的介绍有那些坏味道需要重构的地方。


“程序猿技术大咖”,您值得拥有!
公众号ID:cxyjsdk长按左侧二维码关注

优化代码里的 “ 坏味道 ”相关推荐

  1. 优化代码中的“坏味道”

    " 一颗老鼠屎,坏了一锅粥,代码也是如此." 在我们的项目中,也许在刚开始开发的时候,大家都会遵从一些规范来实施,但是当业务进度催的紧,或者人员变动,随着时间的迁移,项目不断的迭代 ...

  2. 消除代码中的坏味道,编写高质量代码

    消除代码中的坏味道,编写高质量代码 Intro 想要写出较好的代码,保证代码的高质量需要时刻警惕代码中的坏味道,今天分享一下,我觉得平时写的代码中可能会出现的坏味道代码的一些示例 常见的坏味道代码 B ...

  3. java 代码坏味道_代码中的坏味道

    前言 在日常生活中,当我们买的水果放久了之后会发出一种难闻的气味("坏味道"),这个时候我们就应该把它扔掉.同样,代码也有"坏味道",当然确定什么是和不是代码& ...

  4. 消灭 Java 代码的“坏味道”

    点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试资料 导读 明代王阳明先生在<传习录>谈为学之道时说: 私欲 ...

  5. 消灭 Java 代码的“坏味道”【转】

    原文地址:https://mp.weixin.qq.com/s/-YQsD6jJuxewFjQtyX16UA 明代王阳明先生在<传习录>谈为学之道时说: 私欲日生,如地上尘,一日不扫,便又 ...

  6. 第十三期:消灭 Java 代码的“坏味道”

    代码中的"坏味道",如"私欲"如"灰尘",每天都在增加,一日不去清除,便会越累越多.如果用功去清除这些"坏味道",不仅能 ...

  7. 教你消灭 Java 代码的“坏味道”

    导读 明代王阳明先生在<传习录>谈为学之道时说: 私欲日生,如地上尘,一日不扫,便又有一层.着实用功,便见道无终穷,愈探愈深,必使精白无一毫不彻方可. 代码中的"坏味道" ...

  8. 重构笔记——代码的坏味道(上)

    本文是在学习中的总结,欢迎转载但请注明出处:http://blog.csdn.net/pistolove/article/details/42041757 在重构入门篇中,简单地介绍了重构的定义.为何 ...

  9. 重构系列之重构的标志:《重构》代码的坏味道

    重复代码 1. 表现:同一个类的两个函数含有相同的表达式. 方案:提炼函数. 2. 表现:两个互为兄弟的子类内含有相同表达式. 方案:函数上移,推入超类. 3. 表现:如果两个毫不相关的类出现重复代码 ...

最新文章

  1. JavaScript确认提交?
  2. 艰难的这年,程序员的未来在哪里?
  3. 三十五、Scrapy 中的杂知识总结和代理池的编写
  4. css --- 圣杯布局
  5. 问答题:如何构建一套满足GPT-3的存储系统?
  6. matlab虚拟现实之V-Realm Builder2中viewpoint节点的使用
  7. Intel® Math Kernel Library (Intel® MKL)
  8. php 多任务,PHP并行多任务研究(笔记)
  9. 2021 年最佳开源软件榜单
  10. 初学python_day05
  11. Pygame安装方法(Windows10, Python-3.7.2)
  12. 领跑衫获奖感言 课程总结
  13. 移动端车牌识别要做到那一步?
  14. 4、Java 并发编程基础
  15. 7个步骤!3分钟!轻松绘制简单好看的折线图!
  16. 计数排序CountingSort
  17. android 手机录屏功能,手机自带录屏功能在哪里找?轻松搞定屏幕录制
  18. [iOS开发]iPhoneX系列顶部和底部尺寸图解
  19. C++中的log函数
  20. ibm服务器中文件存储设置,IBMv7000存储服务器双活配置流程

热门文章

  1. Gaint 自行车知识及价格表
  2. 标签页 插件 html,chrome新标签页插件(微度新标签页)
  3. 绿色小巧——WebPlayer2009网络播放器发布
  4. 计算机毕业设计Java家居门户网站(源码+系统+mysql数据库+lw文档)
  5. 计算机主机的安装视频,台式电脑光驱怎么安装 电脑光驱的安装图解
  6. iPhone12一半用户选蓝色
  7. 机器人加锤石如何放技能q_lol机器人怎么勾人 机器人Q技能命中技巧详解
  8. echarts学习备忘
  9. 无广告的视频二维码生成教程(组图介绍)
  10. 案例:JavaScript 打印100~1000之间的水仙花数