代码自审规范.docx

上传人:b****6 文档编号:4085062 上传时间:2022-11-27 格式:DOCX 页数:16 大小:23.67KB
下载 相关 举报
代码自审规范.docx_第1页
第1页 / 共16页
代码自审规范.docx_第2页
第2页 / 共16页
代码自审规范.docx_第3页
第3页 / 共16页
代码自审规范.docx_第4页
第4页 / 共16页
代码自审规范.docx_第5页
第5页 / 共16页
点击查看更多>>
下载资源
资源描述

代码自审规范.docx

《代码自审规范.docx》由会员分享,可在线阅读,更多相关《代码自审规范.docx(16页珍藏版)》请在冰豆网上搜索。

代码自审规范.docx

代码自审规范

 

代码审查规范

Version1.0

2018年2月

一、概述 

代码审查(Code Review)是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。

由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。

并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。

 

 

1.1主要工作 

1、发现代码中的bug; 

2、从代码的易维护性、可扩展性角度考察代码的质量,提出修改建议。

3、是否符合开发规范和代码审核检查表  

1.2 基本流程  

1、代码编写者和代码审核者坐在一起,由代码编写者按照UC(Use Case)依次讲解自己负责的代码和相关逻辑,从表现层->持久层; 

2、代码审核者在此过程中可以随时提出自己的疑问,同时积极发现隐藏的bug;对这些bug记录在案。

 

3、代码讲解完毕后,代码审核者给自己安排几个小时再对代码审核一遍。

 代码需要一行一行静下心看。

同时代码又要全面的看,以确保代码整体上设计优良。

 

4、代码审核者根据审核的结果编写“代码审核报告”,“审核报告”中记录发现的问题及修改建议,然后把“审核报告”发送给相关人员。

 

5、代码编写者根据“代码审核报告”给出的修改意见,修改好代码,有不清楚的地方可积极向代码审核者提出。

 

6、代码编写者 bug fix完毕之后给出反馈。

   

7、代码审核者把Code Review中发现的有价值的问题更新到"代码审核检查表"的文档中,对于特别值得提醒的问题可群发email给所开发人员。

  

1.3 责任 

代码编写者,代码审核者共同对代码的质量承担责任。

这样才能保证Code Review不是走过场,其中代码编写者承担主要责任,代码审核者承担次要责任。

二、代码审查检查表

重要性

激活

级别

检查项

总计

 

 

命名

 

 

重要

 

20

命名规则是否与所采用的规范保持一致?

 

 

20

是否遵循了最小长度最多信息原则?

重要

 

50

has/can/is前缀的函数是否返回布尔型?

注释

 

 

重要

 

10

注释是否较清晰且必要?

重要

Y

10

复杂的分支流程是否已经被注释?

 

 

10

距离较远的}是否已经被注释?

 

 

10

非通用变量是否全部被注释?

重要

Y

50

函数是否已经有文档注释?

(功能、输入、返回及其他可选)

 

 

10

特殊用法是否被注释?

声明、空白、缩进

 

 

 

 

20

每行是否只声明了一个变量?

(特别是那些可能出错的类型)

重要

 

40

变量是否已经在定义的同时初始化?

重要

 

40

类属性是否都执行了初始化?

 

 

20

代码段落是否被合适地以空行分隔?

 

Y

20

是否合理地使用了空格使程序更清晰?

 

 

20

代码行长度是否在要求之内?

 

 

20

折行是否恰当?

语句/功能分布/规模

 

 

 

 

20

包含复合语句的{}是否成对出现并符合规范?

 

 

20

是否给单个的循环、条件语句也加了{}?

 

 

20

if/if-else/if-elseif-else/do-while/switch-case语句的格式是否符合规范?

 

 

40

单个变量是否只做单个用途?

重要

 

20

单行是否只有单个功能?

(不要使用;进行多行合并)

重要

 

40

单个函数是否执行了单个功能并与其命名相符?

 

Y

20

操作符++和——操作符的应用是否复合规范?

规模

 

 

重要

 

20

单个函数不超过规定行数?

重要

 

100

缩进层数是否不超过规定?

可靠性(总则/变量和语句)

 

 

重要

 

100

是否已经消除了所有警告?

重要

Y

40

常数变量是否声明为final?

重要

 

80

对象使用前是否进行了检查?

重要

 

80

局部对象变量使用后是否被复位为NULL?

重要

 

70

对数组的访问是否是安全的?

(合法的index取值为[0,MAX_SIZE-1])。

重要

 

20

是否确认没有同名变量局部重复定义问题?

 

 

20

程序中是否只使用了简单的表达式?

重要

Y

20

是否已经用()使操作符优先级明确化?

重要

Y

20

所有判断是否都使用了(常量==变量)的形式?

 

 

80

是否消除了流程悬挂?

重要

 

80

是否每个if-elseif-else语句都有最后一个else以确保处理了全集?

重要

 

80

是否每个switch-case语句都有最后一个default以确保处理了全集?

 

 

80

for循环是否都使用了包含下限不包含上限的形式?

(k=0;k

重要

 

40

XML标记书写是否完整,字符串的拼写是否正确?

 

 

40

对于流操作代码的异常捕获是否有finally操作以关闭流对象?

 

 

20

退出代码段时是否对临时对象做了释放处理?

重要

 

40

对浮点数值的相等判断是否是恰当的?

(严禁使用==直接判断)

可靠性(函数)

 

 

重要

Y

60

入口对象是否都被进行了判断不为空?

重要

Y

60

入口数据的合法范围是否都被进行了判断?

(尤其是数组)

重要

Y

20

是否对有异常抛出的方法都执行了try...catch保护?

重要

Y

80

是否函数的所有分支都有返回值?

重要

 

50

int的返回值是否合理?

(负值为失败,非负值成功)

 

 

20

对于反复进行了int返回值判断是否定义了函数来处理?

 

 

60

关键代码是否做了捕获异常处理?

重要

 

60

是否确保函数返回CORBA对象的任何一个属性都不能为null?

重要

 

60

是否对方法返回值对象做了null检查,该返回值定义时是否被初始化?

重要

 

60

是否对同步对象的遍历访问做了代码同步?

重要

 

80

是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作?

重要

 

60

线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出?

 

 

20

原子操作代码异常中断,使用的相关外部变量是否恢复先前状态?

重要

 

100

函数对错误的处理是恰当的?

可维护性

 

 

重要

 

100

实现代码中是否消除了直接常量?

(用于计数起点的简单常数例外)

 

 

20

是否消除了导致结构模糊的连续赋值?

(如a=(b=d+c))

 

 

20

是否每个return前都要有日志记录?

 

 

20

是否有冗余判断语句?

(如:

if(b)returntrue;elsereturnfalse;)

 

 

20

是否把方法中的重复代码抽象成私有函数?

三、代码审查的常见错误 

3.1常见错误1# :

多次拷贝字符串 

测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。

不可变对象是不可改变的,因此不需要拷贝它。

最常用的不可变对象是String。

  

如果你必须改变一个String对象的内容,你应该使用StringBuffer。

下面的代码会正常工作:

  

String s = new String ("Text here");  

但是,这段代码性能差,而且没有必要这么复杂。

你还可以用以下的方式来重写上面的代码:

  

String temp = "Text here"; String s = new String (temp);  

但是这段代码包含额外的String,并非完全必要。

更好的代码为:

  

String s = "Text here";  

3.2常见错误2#:

 没有克隆(clone)返回的对象 

封装(encapsulation)是面向对象编程的重要概念。

不幸的是,Java为不小心打破封装提供了方便——Java允许返回私有数据的引用(reference)。

下面的代码揭示了这一点:

   

import java.awt.Dimension; 

/**

*Example class.The x and y values should never*be negative.

*/ 

public class Example{ 

private Dimension d = new Dimension (0, 0); 

public Example (){ }  

/**

* Set height and width. Both height and width must be nonnegative 

* or an exception is thrown.

*/ 

public synchronized void setValues (int height,int width) throws IllegalArgumentException{ 

if (height < 0 || width < 0) 

throw new IllegalArgumentException();

d.height = height; 

d.width = width;

 }  

public synchronized Dimension getValues(){ 

// Ooops!

 Breaks encapsulation 

return d;

 } 

Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。

不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码:

   

Example ex = new Example();

Dimension d = ex.getValues(); 

d.height = -5; 

d.width = -10;  

现在,Example对象拥有负值了!

如果getValues() 的调用者永远也不设置返回的Dimension对象的width和height值,那么仅凭测试是不可能检测到这类的错误。

  

不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。

   

更好的方式是让getValues()返回拷贝:

  

public synchronized Dimension getValues(){ 

return new Dimension (d.x, d.y);

 }  

现在,Example对象的内部状态就安全了。

调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。

   

3.3常见错误3#:

不必要的克隆 

我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。

但是,事情没有绝对:

  

/**

* Example class.The value should never 

* be negative.

*/ 

public class Example{ 

private Integer i = new Integer (0); 

public Example (){ }  

/**

* Set x. x must be nonnegative

* or an exception will be thrown

*/ 

public synchronized void setValues (int x) throws IllegalArgumentException{ 

if (x < 0) 

throw new IllegalArgumentException();

 i = new Integer (x); 

}  

public synchronized Integer getValue(){ 

// We can’t clone Integers so we makea copy this way. 

return new Integer (i.intValue()); 

 

这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。

Integer对象,就象String对象那样,一旦被创建就是不可变的。

因此,返回内部Integer对象,而不是它的拷贝,也是安全的。

   

方法getValue()应该被写为:

  

public synchronized Integer getValue(){ 

// ’i’ is immutable, so it is safe to return it instead of a copy. return i; }  

Java程序比C++程序包含更多的不可变对象。

JDK 所提供的若干不可变类包括:

  

·Boolean ·Byte 

·Character ·Class ·Double ·Float ·Integer ·Long ·Short ·String 

·大部分的Exception的子类

3.4常见错误4# :

自编代码来拷贝数组 

 

Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成:

   

public class Example{ private int[] copy; 

/*** Save a copy of ’data’. ’data’ cannot be null.*/ public void saveCopy (int[] data){ copy = new int[data.length]; 

for (int i = 0; i < copy.length; ++i) copy[i] = data[i]; } }  

这段代码是正确的,但却不必要地复杂。

saveCopy()的一个更好的实现是:

  

void saveCopy (int[] data){ try{ 

copy = (int[])data.clone(); 

}catch (CloneNotSupportedException e){ // Can’t get here. } }  

如果你经常克隆数组,编写如下的一个工具方法会是个好主意:

  

static int[] cloneArray (int[] data){ try{ 

return(int[])data.clone(); 

}catch(CloneNotSupportedException e){ // Can’t get here. } }  

这样的话,我们的saveCopy看起来就更简洁了:

 

 

void saveCopy (int[] data){ copy = cloneArray ( data); } 

3.5 常见错误5#:

拷贝错误的数据 

 

有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。

由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差:

  

import java.awt.Dimension; 

/*** Example class. The height and width values should never * be negative. */ 

public class Example{ 

static final public int TOTAL_VALUES = 10; 

private Dimension[] d = new Dimension[TOTAL_VALUES]; public Example (){ }  

/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ 

public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ if (height < 0 || width < 0) 

throw new IllegalArgumentException(); if (d[index] == null) 

d[index] = new Dimension(); d[index].height = height; d[index].width = width; } 

public synchronized Dimension[] getValues() throws CloneNotSupportedException{ return (Dimension[])d.clone(); } }  

这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。

方法getValues()的更好版本为:

   

public synchronized Dimension[] getValues() throws CloneNotSupportedException{ 

Dimension[] copy = (Dimension[])d.clone(); for (int i = 0; i < copy.length; ++i){ // NOTE:

 Dimension isn’t cloneable. if (d !

= null) 

copy[i] = new Dimension (d[i].height, d[i].width); } 

return copy; } 

 

在克隆原子类型数据的多维数组的时候,也会犯类似的错误。

原子类型包括int,float等。

简单的克隆int型的一维数组是正确的,如下所示:

  

 

public void store (int[] data) throws CloneNotSupportedException{ this.data = (int[])data.clone(); // OK }  

拷贝int型的二维数组更复杂些。

Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:

它的类型为int[]。

简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。

下面的例子演示了在克隆int型二维数组时错误的和正确的做法:

  

public void wrongStore (int[][] data) throws CloneNotSupportedException{ 

this.data = (int[][])data.clone(); // Not OK!

 } 

public void rightStore (int[][] data){ // OK!

 

this.data = (int[][])data.clone(); for (int i = 0; i < data.length; ++i){ if (data !

= null) 

this.data[i] = (int[])data[i].clone(); } }  

3.6常见错误6#:

检查new 操作的结果是否为null 

 

Java编程新手有时候会检查new操作的结果是否为null。

可能的检查代码为:

 

 

Integer i = new Integer (400); if (i == null) 

throw new NullPointerException();  

检查当然没什么错误,但却不必要,if和throw这两行代码完全是浪费,他们的唯一功用是让整个程序更臃肿,运行更慢。

 

C/C++程序员在开始写java程序的时候常常会这么做,这是由于检查C中malloc()的返回结果是必要的,不这样做就可能产生错误。

检查C++中new操作的结果可能是一个好的编程行为,这依赖于异常是否被使能(许多编译器允许异常被禁止,在这种情况下new操作失败就会返回null)。

在java 

中,new 操作不允许返回null,如果真的返回null,很可能是虚拟机崩溃了,这时候即便检查返回结果也无济于事。

 

3.7常见错误7#:

用== 替代.equals 

 

在Java中,有两种方式检查两个数据是否相等:

通过使用==操作符,或者使用所有对象都实现的.equals方法。

原子类型(int, 

flosat, char 等)不是对象,因此他们只能使用==操作符,如下所示:

  

int x = 4; int y = 5; if (x == y) 

System.out.println ("Hi"); 

// This ’if’ test won’t compile. if (x.equals (y)) 

System.out.println ("Hi");  

对象更复杂些,==操作符检查两个引用是否指向同一个对象,而equals方法则实现更专门的相等性检查。

  

更显得混乱的是由java.lang.Object 

所提供的缺省的equals方法的实现使用==来简单的判断被比较的两个对象是否为同一个。

  

许多类覆盖了缺省的equals方法以便更有用些,比如String类,它的equals方法检查两个String对象是否包含同样的字符串,而Integer的equals方法检查所包含的int值是否相等。

   

大部分时候,在检查两个对象是否相等的时候你应该使用equals方法,而对于原子类型的数据,你用该使用==操作符。

  

3.8 常见错误8#:

 混淆原子操作和非原子操作 

 

Java保证读和写32位数或者更小的值是原子操作,也就是说可以在一步完成,因而不可能被打断,因此这样的读和写不需要同步。

以下的代码是线程安全(thread safe)的:

  

public class Example{ 

private int value; // More code here... public void set (int x){ 

// NOTE:

 No synchronized keyword this.value = x; } }  

不过,这个保证仅限于读和写,下面的代码不是线程安全的:

  

public void increment (){ 

// This is effectively two or three instructions:

 // 1) Read current setting of ’value’. // 2) Increment that setting. /

展开阅读全文
相关资源
猜你喜欢
相关搜索
资源标签

当前位置:首页 > 初中教育 > 政史地

copyright@ 2008-2022 冰豆网网站版权所有

经营许可证编号:鄂ICP备2022015515号-1