【转】软件工程师必知:Java代码常见的十种异常(1)

【转】程序员必知:Java代码常见的十种错误(1)

【IT168 技术】每一个程序员在编写代码的过程中都免不了出现错误或是小的失误,这些小的错误和失误往往使得程序员还得返工。那么,如何才能尽量避免这些错误的发生 呢?笔者总结只有在日常的编写代码中总结出经验,在这篇文章中,笔者列出了10个Java编程中常见的错误,你可以把这些错误添加到你的代码审查的检查列 表中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。

  一、常见错误1:多次拷贝字符串

  测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。

  如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)  String s = new String ( " Text here " );

   但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)  String temp = " Text here " ;
【转】软件工程师必知:Java代码常见的十种异常(1)   String s
= new String (temp);

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)  String s = " Text here " ;

   二、常见错误2:没有克隆(clone)返回的对象

  封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便——Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)   import java.awt.Dimension;
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
/** */ /** *Example class.The x and y values should never*be negative. */
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public class Example ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
private Dimension d = new Dimension ( 0 , 0 );
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public Example () ... { }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
/** */ /** * Set height and width. Both height and width must be nonnegative * or an exception is thrown. */
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public synchronized void setValues ( int height, int width) throws IllegalArgumentException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
if (height < 0 || width < 0 )
【转】软件工程师必知:Java代码常见的十种异常(1)   
throw new IllegalArgumentException();
【转】软件工程师必知:Java代码常见的十种异常(1)   d.height
= height;
【转】软件工程师必知:Java代码常见的十种异常(1)   d.width
= width;
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public synchronized Dimension getValues() ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
// Ooops! Breaks encapsulation
【转】软件工程师必知:Java代码常见的十种异常(1)
   return d;
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   }

   Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)  Example ex = new Example();
【转】软件工程师必知:Java代码常见的十种异常(1)   Dimension d
= ex.getValues();
【转】软件工程师必知:Java代码常见的十种异常(1)   d.height
= - 5 ;
【转】软件工程师必知:Java代码常见的十种异常(1)   d.width
= - 10 ;

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

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

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   public synchronized Dimension getValues() ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
return new Dimension (d.x, d.y);
【转】软件工程师必知:Java代码常见的十种异常(1)   }

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

  三、常见错误3:不必要的克隆

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   /** */ /** * Example class.The value should never * be negative. */
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public class Example ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
private Integer i = new Integer ( 0 );
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public Example () ... { }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
/** */ /** * Set x. x must be nonnegative* or an exception will be thrown */
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public synchronized void setValues ( int x) throws IllegalArgumentException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
if (x < 0 )
【转】软件工程师必知:Java代码常见的十种异常(1)   
throw new IllegalArgumentException();
【转】软件工程师必知:Java代码常见的十种异常(1)   i
= new Integer (x);
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public synchronized Integer getValue() ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
// We can’t clone Integers so we makea copy this way.
【转】软件工程师必知:Java代码常见的十种异常(1)
   return new Integer (i.intValue());
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   }

   这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。

  方法getValue()应该被写为:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   public synchronized Integer getValue() ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
// ’i’ is immutable, so it is safe to return it instead of a copy.
【转】软件工程师必知:Java代码常见的十种异常(1)
   return i;
【转】软件工程师必知:Java代码常见的十种异常(1)   }

   Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)  ·Boolean
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Byte
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Character
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Class
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Double
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Float
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Integer
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Long
【转】软件工程师必知:Java代码常见的十种异常(1)   ·Short
【转】软件工程师必知:Java代码常见的十种异常(1)   ·String
【转】软件工程师必知:Java代码常见的十种异常(1)   ·大部分的Exception的子类

四、常见错误4:自编代码来拷贝数组

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   public class Example ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
private int [] copy;
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
/** */ /** * Save a copy of ’data’. ’data’ cannot be null. */
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public void saveCopy ( int [] data) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   copy
= new int [data.length];
【转】软件工程师必知:Java代码常见的十种异常(1)   
for ( int i = 0 ; i
【转】软件工程师必知:Java代码常见的十种异常(1)   copy[i]
= data[i];
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   }

   这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   void saveCopy ( int [] data) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
try ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   copy
= ( int [])data.clone();
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   }
catch (CloneNotSupportedException e) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
// Can’t get here.
【转】软件工程师必知:Java代码常见的十种异常(1)
  }

【转】软件工程师必知:Java代码常见的十种异常(1)   }

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   static int [] cloneArray ( int [] data) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
try ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
return ( int [])data.clone();
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   }
catch (CloneNotSupportedException e) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
// Can’t get here.
【转】软件工程师必知:Java代码常见的十种异常(1)
  }

【转】软件工程师必知:Java代码常见的十种异常(1)   }

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   void saveCopy ( int [] data) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   copy
= cloneArray ( data);
【转】软件工程师必知:Java代码常见的十种异常(1)   }

   五、常见错误5:拷贝错误的数据

  有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)   import java.awt.Dimension;
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
/** */ /** * Example class. The height and width values should never * be
【转】软件工程师必知:Java代码常见的十种异常(1)   negative.
*/

【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public class Example ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
static final public int TOTAL_VALUES = 10 ;
【转】软件工程师必知:Java代码常见的十种异常(1)   
private Dimension[] d = new Dimension[TOTAL_VALUES];
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public Example () ... { }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
/** */ /** * Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public synchronized void setValues ( int index, int height, int width) throws IllegalArgumentException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
if (height < 0 || width < 0 )
【转】软件工程师必知:Java代码常见的十种异常(1)   
throw new IllegalArgumentException();
【转】软件工程师必知:Java代码常见的十种异常(1)   
if (d[index] == null )
【转】软件工程师必知:Java代码常见的十种异常(1)   d[index]
= new Dimension();
【转】软件工程师必知:Java代码常见的十种异常(1)   d[index].height
= height;
【转】软件工程师必知:Java代码常见的十种异常(1)   d[index].width
= width;
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   
public synchronized Dimension[] getValues()
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
throws CloneNotSupportedException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
return (Dimension[])d.clone();
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   }

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

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   public synchronized Dimension[] getValues() throws CloneNotSupportedException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   Dimension[] copy
= (Dimension[])d.clone();
【转】软件工程师必知:Java代码常见的十种异常(1)   
for ( int i = 0 ; i
【转】软件工程师必知:Java代码常见的十种异常(1)   
// NOTE: Dimension isn’t cloneable.
【转】软件工程师必知:Java代码常见的十种异常(1)
   if (d != null )
【转】软件工程师必知:Java代码常见的十种异常(1)   copy[i]
= new Dimension (d[i].height, d[i].width);
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   
return copy;
【转】软件工程师必知:Java代码常见的十种异常(1)   }

   在克隆原子类型数据的多维数组的时候,也会犯类似的错误。原子类型包括int,float等。简单的克隆int型的一维数组是正确的,如下所示:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   public void store ( int [] data) throws CloneNotSupportedException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
this .data = ( int [])data.clone();
【转】软件工程师必知:Java代码常见的十种异常(1)   
// OK
【转】软件工程师必知:Java代码常见的十种异常(1)
  }

    拷贝int型的二维数组更复杂些。Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:它的类型为int[]。 简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。下面的例子演示了在克隆int型 二维数组时错误的和正确的做法:

#div_code img { border: 0px none; }
【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   public void wrongStore ( int [][] data) throws CloneNotSupportedException ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
this .data = ( int [][])data.clone(); // Not OK!
【转】软件工程师必知:Java代码常见的十种异常(1)
  }

【转】软件工程师必知:Java代码常见的十种异常(1)【转】软件工程师必知:Java代码常见的十种异常(1)   
public void rightStore ( int [][] data) ... {
【转】软件工程师必知:Java代码常见的十种异常(1)   
// OK!
【转】软件工程师必知:Java代码常见的十种异常(1)
   this .data = ( int [][])data.clone();
【转】软件工程师必知:Java代码常见的十种异常(1)   
for ( int i = 0 ; i
【转】软件工程师必知:Java代码常见的十种异常(1)   
if (data != null )
【转】软件工程师必知:Java代码常见的十种异常(1)   
this .data[i] = ( int [])data[i].clone();
【转】软件工程师必知:Java代码常见的十种异常(1)   }

【转】软件工程师必知:Java代码常见的十种异常(1)   }