java代码审查V1.0

一、概述代码审查（Code Review）是消灭Bug最重要的方法之一，这些审查在大多数时候都特别奏效。

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

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

1.1主要工作1、发现代码中的bug;2、从代码的易维护性、可扩展性角度考察代码的质量，提出修改建议。

3、是否符合java开发规范和代码审核检查表1.2 基本流程1、代码编写者和代码审核者坐在一起，由代码编写者按照UC（Use Case）依次讲解自己负责的代码和相关逻辑，从表现层->持久层;2、代码审核者在此过程中可以随时提出自己的疑问，同时积极发现隐藏的bug;对这些bug记录在案。

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

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

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

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

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

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

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

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

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

二、java代码审查检查表三、Java代码审查的常见错误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 benonnegative * or an exception is thrown.*/public synchronized void setValues (int height,int width) throwsIllegalArgumentException{if (height < 0 || width < 0)throw new IllegalArgumentException();d.height = height;d.width = width;}public synchronized Dimension getValues(){// Ooops! Breaks encapsulationreturn 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 bethrown*/public synchronized void setValues (int x) throwsIllegalArgumentException{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 * benegative. */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 benonnegative * or an exception will be thrown. */public synchronized void setValues (int index, int height, intwidth) 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对象)的内容。