代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 "'*w_H0
5!iBKOl#D
<%:,{u6
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 |lVoL.Z,0
rnS&^
VL| q`n
-DE?L,9X9
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 TAKvE=a;
hScC<=W
.{
r
%C4q9
_Xzl=j9[
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 *MZa|Xy
oTLpq:9J
y-#01Z
f,'9Bj.~
一、常见错误1# :多次拷贝字符串 1_6oM/?'
[mA\,ny9
?Y\hC0a60
-5sKJt]+i
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 ,K~r':ht
S_dM{.!Z(,
M5T4{^i
T6fm`uL&L
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: rJ)8KY>
OVa38Aucr3
9a3mN(<
}+ZZO0
String s = new String ("Text here"); U@<]>.$
U6yZKK
Ee 15Y$1
(bo-JOOdY(
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: CKr5L
dE]yb|Ld
k;xIo(:
#Zt(g( T
String temp = "Text here"; e|S_B*1*0
String s = new String (temp); B4 +A
U)iq
s\3OqJo%)
TIYo&?Z)
但是这段代码包含额外的String,并非完全必要。更好的代码为: jltW@co2sV
0mi$_Ld+
o2e gNTG
k5/W'*P
String s = "Text here"; UTR`jXCg
RSK5 }2
$Z[W}7{pt#
)H|cri~D
二、常见错误2#: 没有克隆(clone)返回的对象 c-q=Ct
8D6rShx =
gvu1
l[u=_uaYl
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: _fE$KaP
.LA?2N
zyPc<\HoK
$fFh4O4
import java.awt.Dimension; Ic')L*i7O
/***Example class.The x and y values should never*be negative.*/ cPbAR'
public class Example{ ?3Y~q;I]O
private Dimension d = new Dimension (0, 0); EEdU\9DH(
public Example (){ } SKeX~uLz
%E*Q0/
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ o#9Q
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ /;clxtus
if (height < 0 || width < 0) c4Wl^E8
throw new IllegalArgumentException(); ?{rpzrc!*
d.height = height; cbaa*qoU
d.width = width; $i]G'fj
} AtYqD<hl:
.-4]FGg3
public synchronized Dimension getValues(){ bd)'1;p
// Ooops! Breaks encapsulation i$JN
s)I%
return d; X(JE]6_
} <tto8Y
j
} N977F$Bo
`Y_G*b.Rm
8Ai\T_l
7-A/2/G<
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: nR`)kORc
>vKOG@I
(Qf. S{;
nN5fP<H2x
Example ex = new Example(); o9]i
{e>L
Dimension d = ex.getValues(); Ci_Qra 6
d.height = -5; 8T?D#,/
d.width = -10; FL E3LH
o8h`9_
7r o&Q%
V[2}
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 4=qZ Z>[t
4~i?xo=;v
Ld?'X=eQ
yZQcxg%
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 o1Nfn'!3/>
LDh,!5G-M
Yan}H}Oq
9Yd"Y-
更好的方式是让getValues()返回拷贝: ;b_l/T(
?Sr7c|a2
,)M/mG?,
@UQ421Z`
public synchronized Dimension getValues(){ 6KDm#7J
return new Dimension (d.x, d.y); G.3yuok9
} \wF-[']N
W5,&*mo
qNi`OVh&
MFQyB+Z
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 IxaF*4JG
&a.A8v)
Z -fiJ75
(\UpJlW
三、常见错误3#:不必要的克隆 G j^*
DM,)nh6'
kgh0
s;cGf+
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: K5^`,}Q^
"p]!="\
7~Z(dTdSG
(0E<Fz
V
/*** Example class.The value should never * be negative.*/ 9DdR"r'7
public class Example{ nh*6`5yj
private Integer i = new Integer (0); A DVUx}
public Example (){ } ZvwU
*vzEfmN:d
/*** Set x. x must be nonnegative* or an exception will be thrown*/ }0,dG4Oo=
public synchronized void setValues (int x) throws IllegalArgumentException{ N}>[To3
if (x < 0) 2Q 5-.2]
throw new IllegalArgumentException(); AQwai>eL
i = new Integer (x); |k^C-
} 1gQ_76Yck
#I1q,fm
public synchronized Integer getValue(){ >t{-_4Yv?
// We can’t clone Integers so we makea copy this way. JOH\K0=e
return new Integer (i.intValue()); R@){=8%z
} =Cd{bj.8
} P$Q,t2$A
Vh?RlIUA
WPAT\Al&AE
\/64Xv3L0
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 td7Of(k'
+)LCYDRV7
}U '
mLx=Zes:.
方法getValue()应该被写为: d$"?8r4:K
,^RZ1tLz
n?U^vK_
[bw1!X3
public synchronized Integer getValue(){ O?ODfO+>
// ’i’ is immutable, so it is safe to return it instead of a copy. g(9kc<`3'D
return i; $[Q;{Q
} #Vu;R5GZ}
1'N<ITb
C]Y%dQh+a
!_FTy^@c2
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: cyo[HI?WM
zz!jt
A
*d`KD64
`~z[Hj=2
?Boolean zhJ0to[%?
?Byte 5|cRHM#
?Character 'E&tEbY
?Class Zrp-Hv27,,
?Double \d*ts(/a*
?Float \~g,;>%7Y
?Integer #^BttI
?Long icb*L ~qm
?Short !9.FI{W
?String Ii&p v
?大部分的Exception的子类 \B^NdG5Y
M4D @G
_a f $0!
cUr!U\X[
四、常见错误4# :自编代码来拷贝数组 SU1N*k#-o
?4oP=.
c/igw+L()
vZW[y5
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: 8+J>jZ
plp-[eKcD
J.'%=q(Sb
mz+UkA'
public class Example{ fs?H
private int[] copy; ;6~5FTmV
/*** Save a copy of ’data’. ’data’ cannot be null.*/ Eh)VT{vp
public void saveCopy (int[] data){ l4dG=x}M]
copy = new int[data.length]; Oi zj|'
for (int i = 0; i < copy.length; ++i) Q6wa-Y,
copy = data; 8d2\H*a9~
} S~hu(x#
} f%i%QZP
8*x=Fm,Ok
YYT#{>&
+g kJrw
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: [uK{``"
}Z{FPW.QK
!l=)$RJKdD
YCQ$X
void saveCopy (int[] data){ lZuH:AH
try{ ];lZ:gT
copy = (int[])data.clone(); reNf?7G+m
}catch (CloneNotSupportedException e){ [sjkm+
?
// Can’t get here. % P Ex
} zj(V\y&H
} #]6{>n1*+w
hlDB'8
ma+AFCi
~\AF\n%
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: 0#DEh|?
nJGs ,~"
X9NP,6
!><asaB]1
static int[] cloneArray (int[] data){ ;g? |y(xv
try{ [`oVMR
return(int[])data.clone(); 5A*&!1T
}catch(CloneNotSupportedException e){ O$}.b=N9
// Can’t get here. ^!d0abA
} S1I.l">P
} k=[s%O6H
TYb$+uY
`CH,QT7e
bc4 V&
这样的话,我们的saveCopy看起来就更简洁了: 7KX27.~F
'5 ~cd
=#,`k<v%I
Y)DX
void saveCopy (int[] data){ p7@R+F\.};
copy = cloneArray ( data); 5QLK
} B~N3k
CUYA:R<)
&H]/'i-
RG""/x;
五、常见错误5#:拷贝错误的数据 *;]}`r
}ePl&-9T
*=2W:,$
~bxev/$d
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: <K`E*IaW
j7gw?,
xsn=Ji2 F
)?UoF&c/
import java.awt.Dimension; Jp_#pV*}:
/*** Example class. The height and width values should never * be r+8D|stS
negative. */ j&oRj6;Ha+
public class Example{ #}FUa u$
static final public int TOTAL_VALUES = 10; V(F9=r<X
private Dimension[] d = new Dimension[TOTAL_VALUES]; _OTVQo Ap
public Example (){ } Bskp&NV':
.WqqP
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ M|K^u.4
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ h7!O
K
if (height < 0 || width < 0) %z-*C'j5H
throw new IllegalArgumentException(); HyU: BW;
if (d[index] == null) rO$pj~!|Q
d[index] = new Dimension(); ?nGi if
d[index].height = height; MCmb/.&wu
d[index].width = width; w CB*v<*
} v={{$=/t
public synchronized Dimension[] getValues() ~}}<+ JEEO
throws CloneNotSupportedException{ :86:U 0^
return (Dimension[])d.clone(); nYjrEy)Q
} R-S<7Q3E0=
} #%\0][Xf
{9U!0h-2"
/oHCV0!0
[jzsB:;XB&
这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。方法getValues()的更好版本为: O*~z@"\
_(F-(X|
)6C+0b*
dHXe2rTE;&
public synchronized Dimension[] getValues() throws CloneNotSupportedException{ ]`|$nU}v
Dimension[] copy = (Dimension[])d.clone(); w,LmAWZ4Y
for (int i = 0; i < copy.length; ++i){ {:K_=IRZ
// NOTE: Dimension isn’t cloneable. 0_gN]>,9n
if (d != null) )*;Tt @'y
copy = new Dimension (d.height, d.width); vKG\8+
} Giv,%3'
return copy; %7 bd}sJ#
} su1lv#
78uImC*o
q2vD)r
j#n ]q{s4
在克隆原子类型数据的多维数组的时候,也会犯类似的错误。原子类型包括int,float等。简单的克隆int型的一维数组是正确的,如下所示: {,Q )D$i
P3&s<mh
ORs:S$Nt$
A_zCSRF,
public void store (int[] data) throws CloneNotSupportedException{ Ig`q[o
this.data = (int[])data.clone(); -[L\:'Gp5
// OK tF`L]1r>
} /'rj L<M
p2Ep(0w,R5
v'@gUgC
UhDQl%&He
拷贝int型的二维数组更复杂些。Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:它的类型为int[]。简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。下面的例子演示了在克隆int型二维数组时错误的和正确的做法: ]- 1(r,
Xb%q9Z
WMf /
S"=
#&}-
q
RA
public void wrongStore (int[][] data) throws CloneNotSupportedException{ CUI3^;&S
this.data = (int[][])data.clone(); // Not OK! m4hkV>$d
} @kFZN 6
public void rightStore (int[][] data){ SKL 4U5D{
// OK! @|anu&Hm
this.data = (int[][])data.clone(); xz8e1M
for (int i = 0; i < data.length; ++i){ ltNCti{Q
if (data != null) o+E~iCu5
this.data = (int[])data.clone(); G&g;ROgY
} 0+FPAqX
} E(r_mF7:
V#7,vas
,=u;1
XIl<rN@-
3U@jw,K!{A
六、常见错误6#:检查new 操作的结果是否为null ^Spu/55_
pux IJ
rFg$7
o72r `2
Java编程新手有时候会检查new操作的结果是否为null。可能的检查代码为: 'v6@5t19j
UA6id|G
o8g7wM]M
.dlsiBh
Integer i = new Integer (400); q`c!!Lg
if (i == null) Z6Fu~D2Uy
throw new NullPointerException(); OX7=g$S 1
hu}$ \
e"S?qpJK
P51M?3&=l
检查当然没什么错误,但却不必要,if和throw这两行代码完全是浪费,他们的唯一功用是让整个程序更臃肿,运行更慢。 R5uG.Oj-2
bw P=f.
,>a!CnK=
90Ki.K 0
C/C++程序员在开始写java程序的时候常常会这么做,这是由于检查C中malloc()的返回结果是必要的,不这样做就可能产生错误。检查C++中new操作的结果可能是一个好的编程行为,这依赖于异常是否被使能(许多编译器允许异常被禁止,在这种情况下new操作失败就会返回null)。在java 中,new 操作不允许返回null,如果真的返回null,很可能是虚拟机崩溃了,这时候即便检查返回结果也无济于事。 Fc5.?X-
X,k^p[Rcu
七、常见错误7#:用== 替代.equals $gUlM+sK
|H?t+Dyn)q
在Java中,有两种方式检查两个数据是否相等:通过使用==操作符,或者使用所有对象都实现的.equals方法。原子类型(int, flosat, char 等)不是对象,因此他们只能使用==操作符,如下所示: 8Sr'
s:3[#&PQpN
o9eOp3w30
)UKX\nD"0
int x = 4; y8k8Hd1<f
int y = 5; DhyR
if (x == y) Z3S+")^
System.out.println ("Hi"); 'C'mgEl%L
// This ’if’ test won’t compile. zXY8:+f
if (x.equals (y)) ZyGoOk
System.out.println ("Hi"); [:y:_ECs6
A &