代码审查参考和建议

1.代码审查的概念

        代码审查,指对计算机源代码进行系统审查,以找出并修正在软件开发初期未发现的错误,提升软件的质量。

    代码审查是日常性工作,一次审查代码的行数一般建议在200行以内,建议不要超过400行.一次审查代码的时间一般建议在60分钟以内,建议不要超过90分钟,避免出现审查疲劳,降低审查的质量.

2.代码审查的好处

代码审查的重要性是被普遍认可的,可以提升代码的质量,找出潜在的Bug,保证代码风格的统一;同时也是一个相互学习的好机会.

1.发现别人的优秀编码习惯,对优秀设计模式和API的使用,帮助自己提高编码水平;

2.对了解和熟悉整个系统和业务,也有很好的帮助

3.通过他人的一些改进意见,学习借鉴他人的思考方式

4.从旁观者的角度审查代码和代码背后的设计思想

3.如何做代码审查

1.审查清单

        代码审查这件事其实是可以标准化和流程化的,其效果在一定程度上也是可以量化的。使用审查清单可以帮助审查者快速找到问题,甚至开发者在开发阶段就可以按照审查清单进行代码自查.

◎ 代码结构:是否包含超长代码,代码层次嵌套是否过深,函数是否入参过多,循环条件是否有跳出点,if语句是否有对应的else语句,是否存在重复的代码等。

◎ 代码安全性:I/O流是否正常关闭,资金计算是否使用了Double数据类型,是否有超大的临时对象,线程池大小是否合理,异常是否被忽略,是否有详细的日志记录,是否存在并发问题,参数是否做了必要的检查,远程服务的入参出参是否实现了Serialization并且自定义了serialVersionUID,应用是否依赖了SNAPSHOT版本的类库等。

◎ 代码性能:是否有长SQL语句、SQL语句是否用到索引,是否有成熟的类库可以替换自己实现的代码,是否可以考虑单例模式,是否可以考虑线程池,是否可以考虑NIO,是否可以进行锁优化等。

◎ 代码注释:指类及方法是否有注释,注释是否可以表达其准确含义,在代码中是否存在FIXME及TODO等注释,注释是否包含边界值及对异常情况的说明等.

◎ 单元测试:代码是否有可测试性,新代码是否有单元测试,单元测试是否可以覆盖所有场景。

◎ 代码优化:是否可以使用枚举代替自定义的常量,在代码中是否包含魔法值,是否可以使用Optional代替NPE的检查,是否可以使用Stream代替for循环,是否可以使用设计模式等

◎ 其他:代码逻辑是否正确,是否实现了业务功能,代码是否有好的可读性及可测试性等。

2.审查工具

工欲善其事,必先利其器,选择一款高效的工具,可以大大提升代码审查的效率。

代码审查工具的使用可参考:https://www.imooc.com/article/2493

3.重点关注的改动点

        通过使用代码审查工具,我们可以很清楚地看出代码有哪些改动点(包括新增的代码),通过对照我们事先置顶的审查清单,重点关注改动点是一种比较高效的代码审查方式。原有的代码一般是经过代码审查的,但代码的变化往往会引入新的问题,所以,在审查代码的过程中应该重点关注代码的改动点。但是,重点关注改动点并不是只关注改动点,其实,还有很多问题隐藏在非改动点处。这就需要负责代码审查的开发者通读改动点附近的全部代码,重点关注改动点,而不是只看改动点处的代码。通过通读全部代码,可以更好地发现问题,尤其是和业务逻辑相关的问题。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • 敏捷中高效开发的一个方法“结对开发”,目前没有看到哪个开发团队有这样实行。不严谨的开发思维会造成后续出现很多缺陷,...
    春风仿佛爱情阅读 237评论 0 0
  • 在我们关于高效代码审查的博文中,我们建议使用一个检查清单。在代码审查中,检查清单是一个非常好的工具——它们保证了审...
    i云哲阅读 550评论 0 1
  • 要有审查清单 代码审查这件事其实是可以标准化和流程化的,其效果在一定程度上也是可以量化的。要想做好代码审查...
    飞_侠阅读 445评论 0 0
  • 久违的晴天,家长会。 家长大会开好到教室时,离放学已经没多少时间了。班主任说已经安排了三个家长分享经验。 放学铃声...
    飘雪儿5阅读 7,473评论 16 22
  • 今天感恩节哎,感谢一直在我身边的亲朋好友。感恩相遇!感恩不离不弃。 中午开了第一次的党会,身份的转变要...
    迷月闪星情阅读 10,548评论 0 11