`
atgoingguoat
  • 浏览: 196726 次
  • 性别: Icon_minigender_1
  • 来自: 长沙
社区版块
存档分类
最新评论

JAVA代码Review

阅读更多

 

 

什么是代码Review?

代码review是指在软件开发过程中,通过对源代码进行系统性检查来确认代码实现的质量保证机制

为什么不做代码Review?

  • ​业务需求大,工作时间紧张
  • 项目小,协作的人少,没必要

为什么要做代码Review?

  • 提高代码质量,提升自身水平
  • 及早发现潜在缺陷与BUG,降低事故成本
  • 促进团队内部知识共享,提高团队整体水平
  • 保证项目组人员的良好沟通
  • 避免开发人员犯一些很常见,很普通的错误

总而言之目的是查找系统缺陷,保证软件总体质量和提高开发者自身水平,使项目代码更加容易维护。

代码Review的好处

  1. 在代码提交之前如果有很多双眼睛盯着看可以发现bug,这是代码审查最广为人知的好处。(人们的确可以在代码审查中发现bug,但是这些bug大部分都是显而易见的小bug,开发者分分钟可以发现,而那些真正需要花时间发现的bug通常是在代码审查中发现的)

  2. 代码审查最大的好处是纯社会性的。(如果你编程的时候知道你的同事将要看你的代码,你的编程方式会不一样,你的代码会写的更整洁,注释更加清楚,组织得更好。因为你知道其他人会看你的代码,他们的意见是你需要关注的。如果没有审查,你虽然知道人们最后会去看你的代码,但是那样不会给你一种紧迫感,也不会给你同样的个人评判的感觉。)

  3. 还有一个更大的好处就是代码审查可以传播知识。(在很多开发小组里,每个人都负责某一个核心组件,专注于自己的这一块,只要其他同事的模块不会破坏自己的代码就不会去关注,这种模式导致一个模块只有一个人熟悉对应的代码,如果一个人请教或者离职,其他人对他负责的模块将一无所知。如果采用代码审查,那么至少有两个人熟悉代码-作者和审查者。审查者知道的代码不如作者多,但是他们都熟悉代码的设计和结构,这意义重大)

Code Review的前提

  1. 重视代码review 
    (Code Review人员是否理解了Code Review的概念和Code Review将做什么如果做Code Review的人员不能理解Code Review对项目成败和代码质量的重要程度,他们的做法可能就会是应付了事。)

  2. 代码是否已经正确的build,build的目的使得代码已 经不存在基本语法错误 
    (我们总不希望高级开发人员或是主管将时间浪费在检查连编译都通不过的代码上吧。 )

  3. 代码执行时功能是否正确 
    (Code Review人员也不负责检查代码的功能是否正确,也就是说,需要复查的代码必须由开发人员或质量人员负责该代码的功能的正确性。 )

  4. 开发人员是否对代码做了单元测试 
    (这一点也是为了保证Code Review前一些语法和功能问题已经得到解决,Code Review人员可以将精力集中在代码的质量上。 )

Code Review需要注意什么?

  1. 完整性检查(Completeness)

    • 代码是否完全实现了设计文档中提出的功能需求
    • 代码是否已按照设计文档进行了集成和Debug
    • 代码是否已创建了需要的数据库,包括正确的初始化数据
    • 代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型
  2. 一致性检查(Consistency)

    • 代码的逻辑是否符合设计文档
    • 代码中使用的格式、符号、结构等风格是否保持一致
  3. 正确性检查(Correctness)

    • 所有的变量都被正确定义和使用
    • 所有的注释都是准确的
    • 所有的程序调用都使用了正确的参数个数
  4. 可修改性检查(Modifiability)

    • 代码涉及到的常量是否易于修改(如使用配置、定义为类常量、使用专门的常量类等)
    • 代码是否只有一个出口和一个入口(严重的异常处理除外)
  5. 健壮性检查(Robustness)

  6. 可理解性检查(Understandability)

    • 注释是否足够清晰的描述每个子程序
    • 是否使用到不明确或不必要的复杂代码,它们是否被清楚的注释
    • 使用一些统一的格式化技巧(如缩进、空白等)用来增强代码的清晰度
    • 是否在定义命名规则时采用了便于记忆,反映类型等方法
    • 每个变量都定义了合法的取值范围
    • 代码中的算法是否符合开发文档中描述的数学模型
  7. 可验证性检查(Verifiability)

    • 代码中的实现技术是否便于测试

Code Review经验检查项

1、 编码规范方面检查项 
2、面向对象设计方面检查项 
- 类设计和抽象是否合适 
- 是否符合面向接口编程的思想 
- 是否采用合适的设计模式

3、性能方面检查项 
- 对hashtable,vector等集合类数据结构的选择和设置是否合适 
- 有无滥用String对象的现象 
- 是否采用通用的线程池、对象池模块等cache技术以提高性能 
- I/O方面是否使用了合适的类或采用良好的方法以提高性能(如减少序列化,使用buffer类封装流等) 
- 同步方法的使用是否得当,是否过度使用

4、数据库处理方面 
- 数据库资源是否正常关闭和释放 
- 数据库访问模块是否正确封装,便于管理和提高性能 
- 是否采用合适的事务隔离级别 
- 资源泄漏处理方面检查项 cursor

5、通讯方面检查项 
- socket通讯是否存在长期阻塞问题

6、重复代码 
7、其他 
- 日志是否正常输出和控制 
- 配置信息如何获得,是否有硬编码

怎么更有效的做Code Review

  1. 一次评审量要低于 200–400 行代码缺陷密度 就是每 1000 行代码之中所发现的错误(bug)数 
    这里写图片描述

  2. 每小时低于 300–500 LOC 检查率的目标 
    这里写图片描述

  3. 花足够的时间进行适当缓慢的评审,但是不要超过 60-90 分钟 
    但反过来说,评审代码所花的时间不得低于五分钟,就算代码只有一行也是如此。通常来说,单行的代码也会影响到整个的系统,所以花上五分钟时间去检查更改可能造成的结果是值得的

  4. 确定在评审开始之前代码开发者已经注释源代码了 
    这里写图片描述

  5. 使用检查表,因为它能极大地影响代码开发者和评审者的结果 
    另外一个有用的概念就是 个人检查表 。每个人一般都会犯 15-20 个错误(bug)。如果您注意到了一些典型的错误(bug),那么您就可以开发自己的个人检查表

  6. 确认缺陷得到了修复

分享到:
评论

相关推荐

    java代码评审检查表.xls

    java代码评审检查表:包含java常用代码审查内容

    Java项目开发代码Review常见问题实例.doc

    在Java项目开发中,代码审查(Code Review)是确保代码质量、遵循最佳实践以及提高团队协作效率的关键步骤。本文档将深入探讨在Code Review过程中常见的问题,并提供实例分析,以帮助开发者避免这些问题。 **第一章...

    java代码审查规范文档

    Code Review是一种用来确认方案设计和代码实现的质量保证机制,通过这个机制我们可以对代码、测试过程和注释进行检查。 Code Review主要用来在软件工程过程中改进代码质量,通过Code Review可以达到如下目的: .在...

    JavaReview.zip

    "JavaReview.zip"这个文件很可能包含了关于Java学习和复习的材料,可能包括源代码、教程、笔记或者示例项目。为了深入理解Java的核心概念和技术,我们需要探讨以下几个关键知识点: 1. **基础语法**:Java的基础...

    代码review.ppt

    了解代码review做的ppt,可以帮助人理解代码review的概念

    Java项目开发CodeReview 常见问题实例分析及指南

    CodeReview的基本手段还是需要技术经理通过人工检查项目成员的代码,来将各种问题扼杀在开发阶段,但是不同经验及技术水平的经理在review同一段代码所发现的问题可能相差比较大,不同的Team可能因此产生的效果也不同...

    java代码审查V1.0.doc

    ### Java代码审查重要知识点 #### 一、概述 **代码审查(Code Review)**是软件开发过程中一个重要的环节,它有助于在代码被正式集成之前发现并修复潜在的问题和缺陷。这一过程通常涉及多名团队成员,旨在提高代码...

    java review guide java复习资料

    ### Java复习资料知识点详解 #### 一、数组中是否可以包含对象类型和基本类型元素? 在Java中,数组可以包含对象类型的元素,但不能同时包含对象类型和基本类型的元素。这是因为Java中的数组是同质的,即数组中的...

    静态测试方法之代码审查(CodeReview)的清单

    静态测试方法之代码审查(CodeReview)的清单。代码审查可以帮助提高代码质量,避免由于代码习惯而造成的bug。下面列出的这些要点因该可以作为大部分代码审查的指导,如果是Java应用的话,这些建议应该被视作最佳实践...

    java review

    源代码文件通常以.java为扩展名,用于存放Java代码。当编译成功后,会生成对应名称的.class文件。在这些.class文件中,包含了可被JVM执行的字节码。 #### 五、Hello World程序分析 ```java class Hello { public ...

    Java 编程规范CheckList

    Java编程规范CheckList为开发者提供了一套全面而细致的编程准则,涵盖了从代码排版到注释撰写等多个方面。遵循这些规范不仅可以提高代码的质量,还能增强团队协作的效率。通过严格执行这些规范,开发者能够编写出既...

    Java Code review checklist.doc

    Java 代码审查检查清单 Java 是一种广泛使用的编程语言,用于开发各种应用程序。为了确保 Java 代码的质量和可靠性,代码审查是一个非常重要的步骤。代码审查可以帮助开发者发现和修复错误,提高代码的可读性和可...

    jupiter代码review工具

    **Jupiter代码审查工具详解** Jupiter是一款专用于代码审查的工具,旨在帮助软件开发团队提高代码质量和确保代码规范性。代码审查是软件开发过程中的重要环节,它可以帮助发现潜在的错误、提升代码可读性,并促进...

    基于Gitlab的代码审查流程(Code-Review)方案

    Jenkins是一个用Java编写的开源自动化服务器,能够执行各种自动化任务,尤其是软件开发中的持续集成。它支持多平台,具有插件扩展功能,并且可以通过Web界面进行管理和配置。Jenkins与GitLab可以结合使用,Jenkins...

    JAVA代码复查工具使用指南.pdf

    ### JAVA代码复查工具使用指南知识点解析 #### 一、概述 - **目的**: 本指南旨在为Java开发者提供一套标准化的代码复查流程,通过使用特定的工具来提高代码质量和可维护性。它不仅有助于发现潜在的错误和不规范的...

    IDEA代码检视插件Code Review Helper(支持团队协同)

    标题提到的"IDEA代码检视插件Code Review Helper"是针对IntelliJ IDEA集成开发环境的一款强大工具,旨在提升代码审查的效率和质量。代码审查是软件开发中的一个关键环节,通过它,团队成员可以互相检查彼此的代码,...

    java review.rar

    "java review.rar"这个压缩包很可能包含了与Java学习、复习或面试相关的材料,如代码示例、教程文档或者练习题。由于没有具体的标签信息,我们将基于Java语言的一般知识点进行详细的阐述。 首先,Java的基础部分...

    写好Java代码的30条经验总结.docx

    15. 代码review:代码review是非常重要的,应该定期review代码,以确保代码的质量和可读性。 通过遵守这些规则和建议,编写出的Java代码将更加简洁、易读和易维护,从而提高代码的质量和可读性。

    2018秋招java笔试题-java_review:Java评论

    Review 1. 数据结构和算法 红黑树 代码: ) 图解: 2. 面试题 2021.4.10 英礡Improbable笔试题 (2021 Improbable Intern Online Test) 括号匹配 约瑟夫环 2021.03.31 华为校园招聘软件笔试题 2021.3.31 兴业数金Java...

Global site tag (gtag.js) - Google Analytics