我们该如何做好Code Review?

引言

午后的阳光,静静地照在你的脸上。这时候配上一杯82年的java,脑子一片灵光闪过,呃......上午刚写完需求,下午好像没什么事了,不如看看自己写的代码?至此,一场Code Review也就拉开序幕了。

前言

Code Review,即代码审查,是指对计算机源代码系统化地审查,常用软件同行评审的方式进行,其目的是在找出及修正在软件开发初期未发现的错误,提升软件质量及开发者的技术。代码审查以不同的形式进行,例如结对编程、非正式的看过整个代码,或是正式的软件检查。[1]

配对review(Mutual Review)

在我们项目组的code review中,制定了A童鞋与B童鞋的一对一review关系,“配对”成功后,这两位童鞋的代码负责相互review对方的代码,这样也形成了责任关系,可能这里有些人会表示并不赞同这种“强制”的责任制,更喜欢随意的工作方式。但是我们在实际中发现,如果不采取一对一的这种方式,很容易造成漏掉review某些童鞋代码。当然,在相互review之后,还可以继续对其他同事代码进行review,这样既确保了完备性,也保证了多样性。

流程和步骤如下:
Owner(被review的童鞋),Reviewer(执行代码review的童鞋)。

  • Reviewer对Owner的代码进行review,针对某个缺陷代码提出review,格式如下:
  @Override
    protected void onDestroy() {
        super.onDestroy();
        BitmapCache.getDefault().clear(true, false);
        BitmapCache.getDefault().close();
        //TODO review by xxx 2016/12/28 最好不要显示调用这个方法,如果必须要进行垃圾回收建议与runFinalizationSync(),否则调用可能不起作用。
        System.gc();
    }
  • Owner修改之后,并不要删除todo,而是由对应的Reviewer验证之后来删除,所以Owner修改完代码之后,格式如下:
  @Override
    protected void onDestroy() {
        super.onDestroy();
        BitmapCache.getDefault().clear(true, false);
        BitmapCache.getDefault().close();
        //TODO review by xxx 2016/12/28 最好不要显示调用这个方法,如果必须要进行垃圾回收建议与runFinalizationSync(),否则调用可能不起作用。
        // FIX by xxx: 2017/1/11 
    }
  • Owner对已经修复完的问题进行再次Review,验证通过之后可以删除上述的todo及fix,如验证失败则继续补充相应的TODO。
  @Override
    protected void onDestroy() {
        super.onDestroy();
        BitmapCache.getDefault().clear(true, false);
        BitmapCache.getDefault().close();

至此,Mutual Review也就顺利完成,这项工作我也把它称为Daily Review,因为这项review属于日常性,长期性的工作,从我们项目组来看,这项工作发现大多数缺陷代码。那么既然如此,为什么还需要Review Meeting呢?主要考虑有如下几点:

  1. Mutal Review的结果不能达成一致时,也就是说两个童鞋谁也不认同谁,这样就需要大家一起讨论来定夺应该怎么修改。
  2. Code Review会议能够集思广益,往往经过讨论之后能得到问题的最优解或次优解。
  3. Code Review会议使得各个人员之间能够面对面的进行交流,比起Mutual Review能对需要修改的点进行更细节的讨论,并且沟通效率更高。

代码评审会议(Review Meeting)

review meeting

代码评审会议一般流程如下:

  1. 每期版本迭代上线前至少进行一次,且最好应在上线前一周做完,最少也得提前三天,因为需要预留给测试时间进行review修改后的测试。
  2. 每次会议时间不宜过长,如讨论内容较多可分次举行。
  3. 在一次会议过程中,每位开发童鞋轮流对自己已经在代码中写过//TODO review by xxx 的地方进行讲解。讲解每处review的原因,其他童鞋可以进行讨论,是否有修改的必要?有没有更好地实现方式?是否需要将该案例加入到编码规范中?等等。
  4. 讨论结束后,总结会议中讨论的结果,并综合考虑修改的工作量与上线前剩余的时间,最终决定是否在上线前修改完成,还是可以考虑上线后下个版本进行修改。

结语

经过理论及实践表明,定期进行Code Review有如下几点好处:

  1. 能够学习他人代码,能够开阔思路,并且提升代码健壮性,改掉边界条件考虑不周的情况。
  2. 对于测试同学没有能够测试到的bug提前进行修复,降低线上bug及crash率。
  3. 在code review会议中集思广益,促进团队成员交流,有助于营造团结协作的团队氛围。

说了这么多,如果你不想看或者实在做不到的话只能送你一句话了。

参考资料

  1. Kolawa, Adam; Huizinga, Dorota. Automated Defect Prevention: Best Practices in Software Management. Wiley-IEEE Computer Society Press. 2007: 260/426. ISBN 0-470-04212-5.

文末福利

本人目前在网易搬砖,如果想要挪挪地方,请猛戳此处,选好部门及岗位以后,欢迎投简历给我(changan_luo@163.com),我来帮您内推。

最后欢迎拍砖,说得不好的地方欢迎交流~

欢迎给民工打赏晚饭加个鸡腿,谢谢~

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

推荐阅读更多精彩内容