审查Java代码的十一种常见错误
当前位置：以往代写 > JAVA 教程 >审查Java代码的十一种常见错误

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

2019-06-14

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

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

副标题#e#

代码审查是没落Bug最重要的要领之一，这些审查在大大都时候都出格奏效。由于代码审查自己所针对的工具，就是俯瞰整个代码在测试进程中的问题和Bug。而且，代码审核对消除一些出格细节的错误大有裨益，尤其是那些可以或许容易在阅读代码的时候发明的错误，这些错误往往不容易通过呆板上的测试识别出来。本文就常见的Java代码中容易呈现的问题提出一些建树性发起，以便您在审查代码的进程中留意到这些常见的细节性错误。

凡是给别人的事情挑错要比找本身的错容易些。别样视角的存在也表明白为什么作者需要编辑，而运带动需要锻练的原因。不只不应当拒绝别人的品评，我们应该接待别人来发明并指出我们的编程事情中的不敷之处，我们会受益匪浅的。正规的代码审查(code inspection)是提高代码质量的最强大的技能之一，代码审查—由同事们寻找代码中的错误—所发明的错误与在测试中所发明的错误差异，因此两者的干系是互补的，而非竞争的。

假如审查者可以或许有意识地寻找特定的错误，而不是靠漫无目标的欣赏代码来发明错误，那么代码审查的结果会事半功倍。在这篇文章中，我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的查抄列表(checklist)中，这样在颠末代码审查后，你可以确信你的代码中不再存在这类错误了。

一、常见错误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";

二、常见错误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()才可以。


#p#副标题#e#

三、常见错误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());
　 }
}

#p#分页标题#e#

这段代码是安详的，可是就象在错误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的子类

#p#副标题#e#

四、常见错误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);
}

五、常见错误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();
　 }
}

#p#副标题#e#

这儿的问题在于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型二维数组时错误的和正确的做法：

#p#分页标题#e#

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();
　 }
}

六、常见错误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，很大概是虚拟机瓦解了，这时候即便查抄返回功效也无济于事。

#p#副标题#e#

七、常见错误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;
}

#p#副标题#e#

九、常见错误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()大概会抛出异常。

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

#p#分页标题#e#

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需要一些能力。

小结

我在代码审查的时候至少碰着过一次这些错误，我本身也犯过个中的几个错误。好动静是只要你知道你在找什么错误，那么代码审查就很容易打点，错误也很容易被发明和修改。即便你找不到时间来举办正规的代码审查，以自审的方法把这些错误从你的代码中革除会大大节减你的调试时间。花时间在代码审查上是值得的。

    关键字：

在线提交作业