代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 @-.? B
,S[K{y<
Bt^K]F\
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 ~>ME'D~
%@&a7JOL
{I%y;Aab8
jigs6#
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 .R44$F
t[.W$1=
U`R;P-
!7H6i#g*
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 zLjgCS<7
g+q@i{Yn
E|Bd>G
r$)$n&j
一、常见错误1# :多次拷贝字符串 U+]Jw\\l
lXrD!1F
T!q_/[i~7
o|S)C<w
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 <MD;@_Nz\
5?u[XAE
p(3sgY1
_[Gb)/@mM
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: ^kj=<+ v#
GA^mgm"O
)jW(6
/dHs &SU,
String s = new String ("Text here"); _ P ,@
ESQ!@G/n
g%J./F=@3
sn\;bq
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: gqiXmMm:9
_pDjg%A>n
ryD%i"g<
0TE@xqW
String temp = "Text here"; "|LQK0q3
String s = new String (temp); euRss#;
Z-Wfcnk
%&] 1FhL
w[fDk1H)
但是这段代码包含额外的String,并非完全必要。更好的代码为: i&ts YnP2
>Gd.&flSj
_,;%mK
Y^lQX~I2{
String s = "Text here"; X B I;Lg
2ChWe}f
=3+L#P=i9
qb7^VIo%c
二、常见错误2#: 没有克隆(clone)返回的对象 '"O&J}s;
sWxK~Yg
[!+D<Y
-q2MrJ*
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: mUwUs~PjA
J%P)%yX
gA
+:CgQ
i.@*tIK
import java.awt.Dimension; rc~Y=m
/***Example class.The x and y values should never*be negative.*/ g5}7y\
public class Example{ 70`M,``
private Dimension d = new Dimension (0, 0); h;Mu[`
public Example (){ } Q_lu`F|
&l^n4
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ .ev\M0Dt
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ RjtC:H&XZ
if (height < 0 || width < 0) 9".Uc8^p/F
throw new IllegalArgumentException(); ~= 9Vv
d.height = height; hmzair3X
d.width = width; 7+8bL{
} vl~%o@*_
z\$;'
public synchronized Dimension getValues(){ 'wE\{1~_[+
// Ooops! Breaks encapsulation @^HwrwRA
return d; WB;J1TpM7
} 5`yPT>*#m>
} Q!)z)-hI
+3?`M<L0
/$*; >4=>f
XPVV+.
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: jaa/k@OG
?1DUNZ6
JJNmpUJ
{.#j1r4J`
Example ex = new Example(); e5qvyUJM
Dimension d = ex.getValues(); VVN#
$
d.height = -5; 0$?qoS
d.width = -10; '}fel5YV
j, ZW[*M
}{#7Z8
XWf7"]%SX
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 QS%,7'EG
/ (.'*biQ
/J8o_EV
q4zSS #]A
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 % IPyCEJD
6i^0T
~Cu lFxu
(A|B@a!Y>
更好的方式是让getValues()返回拷贝: o:f|zf>
i<
jiOf')d5
y,1S&k
6|i`@|#
public synchronized Dimension getValues(){ d)9PEtI
return new Dimension (d.x, d.y); v(k*A:
} r5Wkc$
YBeZN98Nt
ju r1!rg%
V 3%Krn1'
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 kU>#1He
k\%,xf; x
yh4jRe?f
W|~q<},j
三、常见错误3#:不必要的克隆 Z!k5"\{0pE
m_~y
9PWm@
Nlf
w# xncH:1
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: N.k+AQb
5=Zp%[#
L>i<dD{
0>8ZN!@K
/*** Example class.The value should never * be negative.*/ :R{x]sv
public class Example{ u;QH8LK
private Integer i = new Integer (0); 4$qNcMdz
public Example (){ } [Aa[&RX+9
+q$xw}+PK
/*** Set x. x must be nonnegative* or an exception will be thrown*/ _Eszr(zJ
public synchronized void setValues (int x) throws IllegalArgumentException{ j#4+-
if (x < 0) ,K`E&hS
throw new IllegalArgumentException(); <tGI]@Nwk
i = new Integer (x); #IbS
} m`[oT\
cYE./1D a
public synchronized Integer getValue(){ i=x.tsJ:hB
// We can’t clone Integers so we makea copy this way. ?hP<@L6K
return new Integer (i.intValue()); \IO$+Guh
} {c&qB`y<.
} 5F% h>tqh
jM{(8aUG
^n6)YX
d%S=$}o
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 [BJ$|[11
rDK;6H:u{
$:T<IU[E
*vRNG 3D/
方法getValue()应该被写为: dxk;@Tz
"
&_$V@S
_K*\}un2
EY,;e\7O,
public synchronized Integer getValue(){ )w^GPlh
// ’i’ is immutable, so it is safe to return it instead of a copy. [u,hc/PL
return i; dcV,_
} jdV .{8@
CM+F7#T?n
nNd`]F^U
j;$6F/g
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: ]J8KCjq@
ey'pm\Z
a3b2nAI l
u^j8
XOT
?Boolean ^D%}V- "
?Byte *#ob5TBq[
?Character 9;>@"e21R
?Class #rSasucr
?Double 61ON
?Float c+}!yH$
?Integer R4z<Xf:!
?Long 94Kuy@0:+
?Short 8@9hU`H8l
?String 6R$F =MB
?大部分的Exception的子类 Y&K<{KA\4
Wq=ZU\Y
mf
Wz@=0
~%cSckE
四、常见错误4# :自编代码来拷贝数组 BXQ\A~P\
fxLE ]VJQ
X|lElN
+0oyt?
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成:
c4!c_a2pS
.Um?5wG~i
=!1-AR%.^
{<''OwQF~+
public class Example{ 'xLM>6[wz
private int[] copy; ,v$2'm)V
/*** Save a copy of ’data’. ’data’ cannot be null.*/ ~#HH;q_7m
public void saveCopy (int[] data){ GFASF,+
copy = new int[data.length]; X+?Il)Bv
for (int i = 0; i < copy.length; ++i) knNhN=hG+
copy = data; T:w2
} \]L::"![?
} ;PP_3`
X]3l| D
=hZ&66
2|T|K?R^
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: *_2O*{V
GY0XWUlC
UY }9
X\c1q4oB[
void saveCopy (int[] data){ yi
AG'[
try{ >Rl0%!
copy = (int[])data.clone(); O]$*EiO\
}catch (CloneNotSupportedException e){ 6ywnyh
// Can’t get here. onWYT} c{
} pAUfG^v
} +[X.-,yW
,N))=/
6\)8mK
o1p$9PL\:
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: TNX%_Q<
Hm.&f2|(
IDiUn!6Q
gr[ "A
static int[] cloneArray (int[] data){ "FLD%3l
try{ $,z[XM&9)
return(int[])data.clone(); LoV*YSDAY
}catch(CloneNotSupportedException e){ ,\m;DR1
// Can’t get here. [+:mt</HN
} 3;t@KuQ66
} Q)%8NVs
+_-)0[+p
]$?zT`>(F
(TbB?X}
这样的话,我们的saveCopy看起来就更简洁了: ||*&g2Y
A^= Hu,"e
U:pLnNp`
fRv
S@
void saveCopy (int[] data){ :)
Fp
B"
copy = cloneArray ( data); YQB]t=Ha
} b Q9"GO<X
Us@ {w`T
[X$|dOm'N
1=/MT#d^?
五、常见错误5#:拷贝错误的数据 5w,YBUp
w7`@=kVx
p)[BB6E
"$,}|T?Y`
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: NBbY## w0
@tjZvRtZ
2os6c te
)z*$`?)k
import java.awt.Dimension; 7Y @=x#
/*** Example class. The height and width values should never * be )l[7;ZIw$
negative. */ Vbqm]2o&
public class Example{ 1=o(sIeA
static final public int TOTAL_VALUES = 10; 3' :[i2[
private Dimension[] d = new Dimension[TOTAL_VALUES]; <5!RAdaj+
public Example (){ } -f|+
(
F"& A?
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ ^RFmRn
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ v%l|S{>(
if (height < 0 || width < 0) +hKPOFa'
throw new IllegalArgumentException(); O+8ApicjTc
if (d[index] == null) [ ;3EzZL
d[index] = new Dimension(); $.3CiM}~
d[index].height = height; z*k3q`=>
d[index].width = width; Ie`SWg*WL
} &:cTo(C'
public synchronized Dimension[] getValues() d)17r\*>I
throws CloneNotSupportedException{ 5f^`4pT
return (Dimension[])d.clone(); fB @pwmu
} 1!v >I"]
} ]5)&36
"|l
oSf@
).O2_<&?F
zx]M/=7,V#
这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。方法getValues()的更好版本为: ezq
q@t9
N:gstp
]TTJr C:
U0|j^.)
public synchronized Dimension[] getValues() throws CloneNotSupportedException{ m?R+Z6c[
Dimension[] copy = (Dimension[])d.clone(); U}vtVvx
for (int i = 0; i < copy.length; ++i){ (EF$^FYPK
// NOTE: Dimension isn’t cloneable. I;":O"ij\
if (d != null) |)P;%Fy9
copy = new Dimension (d.height, d.width); 1r-,VX7
} k}Clq;G
return copy; vsr~[d=
} gQ+_&'C
j|$y)FBX
Lw2YP[CR
E/ed0'|m
在克隆原子类型数据的多维数组的时候,也会犯类似的错误。原子类型包括int,float等。简单的克隆int型的一维数组是正确的,如下所示: XGrxzO|{
Z]> e & N
\8>N<B)
)>A%FL9
public void store (int[] data) throws CloneNotSupportedException{ 0 *Yivx6
this.data = (int[])data.clone(); C6T 9
// OK Om?:X!l"
} 0,D9\ Ebd
@}rfY9o'
1
FIiX
{*]=qSz
拷贝int型的二维数组更复杂些。Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:它的类型为int[]。简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。下面的例子演示了在克隆int型二维数组时错误的和正确的做法: '?!<I
&MGgO\|6
Z`1o#yZ
D<L{Z[
public void wrongStore (int[][] data) throws CloneNotSupportedException{ h|/*yTuN.y
this.data = (int[][])data.clone(); // Not OK! VT~
^:-]
} cB])A57<
public void rightStore (int[][] data){ Sm I8&c
// OK! WZO
0u
this.data = (int[][])data.clone(); O [ ; 6E
for (int i = 0; i < data.length; ++i){ $MVeMgPa
if (data != null) W!9f'Yn
this.data = (int[])data.clone(); RV @(&