审查Java 代码的十一种常见错误

　　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，很可能是虚拟机崩溃了，这时候即便检查返回结果也无济于事。

　　常见错误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方法，而对于原子类型的数据，你用该使用==操作符。

常见错误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.
　// 3) Write the new setting back.
　++this.value;
}

　　在测试的时候，你可能不会捕获到这个错误。首先，测试与线程有关的错误是很难的，而且很耗时间。其次，在有些机器上，这些代码可能会被翻译成一条指令，因此工作正常，只有当在其它的虚拟机上测试的时候这个错误才可能显现。因此最好在开始的时候就正确地同步代码:

public synchronized void increment (){
　++this.value;
}

　　常见错误9：在catch 块中作清除工作

　　一段在catch块中作清除工作的代码如下所示:

OutputStream os = null;
try{
　os = new OutputStream ();
　// Do something with os here.
　os.close();
}catch (Exception e){
　if (os != null)
　os.close();
}

　　尽管这段代码在几个方面都是有问题的，但是在测试中很容易漏掉这个错误。下面列出了这段代码所存在的三个问题:

　　1.语句os.close()在两处出现，多此一举，而且会带来维护方面的麻烦。
　　2.上面的代码仅仅处理了Exception，而没有涉及到Error。但是当try块运行出现了Error，流也应该被关闭。
　　3.close()可能会抛出异常。

　　上面代码的一个更优版本为:

OutputStream os = null;
try{
　os = new OutputStream ();
　// Do something with os here.
}finally{
　if (os != null)
　　os.close();
}

　　这个版本消除了上面所提到的两个问题:代码不再重复，Error也可以被正确处理了。但是没有好的方法来处理第三个问题，也许最好的方法是把close()语句单独放在一个try/catch块中。

常见错误10：增加不必要的catch 块

　　一些开发者听到try/catch块这个名字后，就会想当然的以为所有的try块必须要有与之匹配的catch块。

　　C++程序员尤其是会这样想，因为在C++中不存在finally块的概念，而且try块存在的唯一理由只不过是为了与catch块相配对。

　　增加不必要的catch块的代码就象下面的样子，捕获到的异常又立即被抛出:

try{
　// Nifty code here
}catch(Exception e){
　throw e;
}finally{
　// Cleanup code here
}

　　不必要的catch块被删除后，上面的代码就缩短为:

try{
　// Nifty code here
}finally{
　// Cleanup code here
}

　　常见错误11：没有正确实现equals，hashCode，或者clone 等方法

　　方法equals，hashCode，和clone 由java.lang.Object提供的缺省实现是正确的。不幸地是，这些缺省实现在大部分时候毫无用处，因此许多类覆盖其中的若干个方法以提供更有用的功能。但是，问题又来了，当继承一个覆盖了若干个这些方法的父类的时候，子类通常也需要覆盖这些方法。在进行代码审查时，应该确保如果父类实现了equals，hashCode，或者clone等方法，那么子类也必须正确。正确的实现equals，hashCode，和clone需要一些技巧。

　　小结

　　我在代码审查的时候至少遇到过一次这些错误，我自己也犯过其中的几个错误。好消息是只要你知道你在找什么错误，那么代码审查就很容易管理，错误也很容易被发现和修改。即便你找不到时间来进行正规的代码审查，以自审的方式把这些错误从你的代码中根除会大大节省你的调试时间。花时间在代码审查上是值得的。