代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 Kx]SiejJ
r%ES#\L6+|
@>(KEjQTz
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 K\F0nToJ.
L4g%o9G
] [MtG
L#UR>Z#9
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 JL= c IH8
chE!,gik
hb5K"9Y
;J 5z
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 x^f)I|t
#lP8/-s^
GYaP"3Lu
V;XKvH
一、常见错误1# :多次拷贝字符串 nG!<wlY14P
2Kz+COP+
xZ9:9/Vg
%7)=k}4
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 p?rlx#M
YNU}R/u6^
\% =\4%:
k k3^m1
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: <'I["Um
:;7I_tb
fo@^=-4A-
[s{!
String s = new String ("Text here"); St-uE|8
y!77gx?-
A]/o-S_
~hLan&T
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: @dDeOnF
pFd8p@m_2
lrT2*$ w3
tF0jH+7J-
String temp = "Text here"; _6ZjF>f
String s = new String (temp); LmF ,en5
F3qK6Ah.
/9w>:i81
!LI<%P)
但是这段代码包含额外的String,并非完全必要。更好的代码为: ~9dpB>+
L8QWEFB|
.gRj^pu
B )r-,M
String s = "Text here"; A IP~A]T
az(<<2=
PLyity-L[7
Nz,yd%ua
二、常见错误2#: 没有克隆(clone)返回的对象 5yy:JTAH5
[]>'Dw_r
DmiBM6t3N
Ma[EgG
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: %fqR
Z'JS@dV
hArY$T&MB
TC\+>LXiZ
import java.awt.Dimension; 9t"Rw ns
/***Example class.The x and y values should never*be negative.*/ |W">&Rb<t#
public class Example{ @c3xUK
private Dimension d = new Dimension (0, 0); SiratkP9n7
public Example (){ } SAx9cjj+
]k0
jmE
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ NK_|h%
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ {m.$EoS
if (height < 0 || width < 0) <>cS@V5j
throw new IllegalArgumentException(); }rTH<!j
d.height = height; du3f'=q6|
d.width = width; _IYaMo.n
} >Jz9wo`
y>^^.
public synchronized Dimension getValues(){ IHl q27O
// Ooops! Breaks encapsulation ^OR0Vp>L
return d; N@q}eGe
} }SN( ^3N
} sHP-@
J!6FlcsZm
RLB3 -=9t
*T|B'80
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: gE-y`2SU
l4Xz r:]
{meX2Z4
nM
)C^$3<t
Example ex = new Example(); O !L`0
=%c
Dimension d = ex.getValues(); VM"cpC_8
d.height = -5; *Z5^WHwg
d.width = -10; [VCC+_
tZrc4$D-
kNEEu!G
2ej7Ql_@c
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 t8Zo9q>
/HC:H,"i
L[` l80
yzA05 npTl
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 1^p/#jt
5\- uo
OW:*qY c;:
f&
4_:'-,
更好的方式是让getValues()返回拷贝: [M_{~1xX
FqKJids-
)
nfoDG#O
#x%'U}sF
public synchronized Dimension getValues(){ j=_rUc'Me
return new Dimension (d.x, d.y); 6K $mW
} )&DAbB!O
o_b[ *
i%glQT
s:`i~hjq
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 ?mQ^"9^XS
+>w]T\[1~
T X`X5j
~,'{\jDrS
三、常见错误3#:不必要的克隆 `sxfj)s
]-PzN'5\'
+Qs]8*^?;
q!K:N?
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: jXcJ/g(X3
ejRK-!
w-jElV
&[.5@sv
/*** Example class.The value should never * be negative.*/ z(PUoV:?
public class Example{ 3KLUH=)P
private Integer i = new Integer (0); kH!Z|Ps?R
public Example (){ } `h}eP[jA
@0`A!5h?u
/*** Set x. x must be nonnegative* or an exception will be thrown*/ >&L|oq7$
public synchronized void setValues (int x) throws IllegalArgumentException{ FR(W.5[
if (x < 0) B.<SC
throw new IllegalArgumentException();
fF:57*ys
i = new Integer (x); ~/:vr
} l=^A41L_
}ze+ tf
public synchronized Integer getValue(){ 4.6$m
// We can’t clone Integers so we makea copy this way. !Jg;%%E3:i
return new Integer (i.intValue()); ,RP-)j"Wff
} aCQtE,.
} \lL[08G
y48]|%73
fV:15!S[
e~h>b.~
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 [f6uwp
pMF
vL
}v1wpv/b(
*7Dba5B
方法getValue()应该被写为: r)(5,*v
k(Yz2
!U`&a=k
K2m>D=w
public synchronized Integer getValue(){ 570Xk\R@M
// ’i’ is immutable, so it is safe to return it instead of a copy. ~{x1/eH
return i; wcHk]mLM
} D?|D)"?qb
Z0|5VLk,<{
[X(m[u '%
5zuwqOD*
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: n}p G&&;q
MB}nn&u#
6(|mdk`i
j:9M${~
?Boolean mq:k|w^6
?Byte dQX-s=XJ
?Character $m`Dyu
?Class zcpL[@B
?Double HC0juT OiO
?Float Q+CJd>B
?Integer B5\l&4X
?Long 1=VyD<dNG6
?Short /%$Zm^8c
?String 9#E *o~1
?大部分的Exception的子类 ,%i
Scr,z
.[={Yx0!I
"tEp8m
YOxgpQ:i
四、常见错误4# :自编代码来拷贝数组 [o^$WL?c
ITPE2x
5!0iK9O
;_sJ>.=\
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: )1 <0c@g=
H`[FC|RYyE
5-dt0I@<
+h)"m/mE
public class Example{ X[z;P!U
private int[] copy; XY0kd&N8
/*** Save a copy of ’data’. ’data’ cannot be null.*/ N=mvr&arP
public void saveCopy (int[] data){ 0 '&C5v'
copy = new int[data.length]; &+9 ;
for (int i = 0; i < copy.length; ++i) 2BY|Cp4R
copy = data; z/Lb1ND8
} \Z*:l(
} _/[qBe
92-Xz6Bo9
mR}8} K]L
b:1B
>
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: I0-1Hr
H4Bt.5O*
NF$6yv9C
DpHubqWz
void saveCopy (int[] data){ OPvPP>0*8
try{ a-5UG#o
copy = (int[])data.clone(); DksYKv
}catch (CloneNotSupportedException e){ $.,PteYK
// Can’t get here. [gzaOP`f
} zU5@~J
} ft"-
W83d$4\d
y)r`<B
fb
f&bJT
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: GTs,?t16/
9FEhl~&
U<6)CW1;
2d[tcn$;h]
static int[] cloneArray (int[] data){ kn#?+Q
try{ `JIp$
return(int[])data.clone(); q\tr&@4iC
}catch(CloneNotSupportedException e){ P IG,a~
// Can’t get here. 6>?qBWW
} $GoS?\G
} hu-]SGb6
\t{iyUxY
1P]J3o
n3e,vP? R
这样的话,我们的saveCopy看起来就更简洁了: fMwF|;
_d!sSyk`
:7@[=n
[w](x
void saveCopy (int[] data){ *gmc6xY
copy = cloneArray ( data); l(Y32]Z
} u`EK^\R
.p{lzI9
TT/=0^"
[KUkv
五、常见错误5#:拷贝错误的数据 r6j[C"@
<\*)YKjn/@
D[W`
q#W
d{TcjZ
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: +sJ{9# 6
yXkQ
,y
}[%F
J^t0M\
import java.awt.Dimension; 0ytAn+/"x
/*** Example class. The height and width values should never * be ^uX"04>;
negative. */ 4][VK/v+
public class Example{ 8V(~u^!%_
static final public int TOTAL_VALUES = 10; Zn1((J7
private Dimension[] d = new Dimension[TOTAL_VALUES]; 0MT?}D&TL
public Example (){ } wz+mFf
TaF*ZT2
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ )fXxkOd
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ U>IsmF>m
if (height < 0 || width < 0) `B?+1Gv
throw new IllegalArgumentException(); C\rT'!Uk\Q
if (d[index] == null) EAY+#>L*
d[index] = new Dimension(); VK9E{~0=
d[index].height = height; !}A`6z
d[index].width = width; &=zJ MGa
} ]Y
&
2&
public synchronized Dimension[] getValues() x1
LI&
throws CloneNotSupportedException{ "=s dn
return (Dimension[])d.clone(); 4o''C |ND
} =5:vKL j
} ?@A@;`0Y
=PU@'OG
b5p;)#
qoan<z7
这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。方法getValues()的更好版本为: wQ-BY"cK\
r?`nc6$0|
7F~Jz*,B*W
bq7()ocA
public synchronized Dimension[] getValues() throws CloneNotSupportedException{ i(u zb<
Dimension[] copy = (Dimension[])d.clone(); >iJxq6!
for (int i = 0; i < copy.length; ++i){ yl<=_Q
// NOTE: Dimension isn’t cloneable. Ty 6 XU!
if (d != null) I%?M9y.u6
copy = new Dimension (d.height, d.width); ?`*`A9@
} J_
h\tM
return copy; &=8ZGjR< }
} J(~xU0gd'
;?o"{mbb
' ]Km%uwL
'u[cT$
在克隆原子类型数据的多维数组的时候,也会犯类似的错误。原子类型包括int,float等。简单的克隆int型的一维数组是正确的,如下所示: /Wjf"dG}
'?|.#D#-c
?$7$ # DX
@[(%b{TE;
public void store (int[] data) throws CloneNotSupportedException{ BD ,3JDqT
this.data = (int[])data.clone(); qyzeAK\Ia
// OK :)e/(I]
} $L"-JNS
-}JRsQ+rgM
3'Z+PPd!
^q~.5c|
拷贝int型的二维数组更复杂些。Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:它的类型为int[]。简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。下面的例子演示了在克隆int型二维数组时错误的和正确的做法: d#- <=6
7"_gX
:n?}G0y
0xutG/-&N
public void wrongStore (int[][] data) throws CloneNotSupportedException{ dZbG#4oO
this.data = (int[][])data.clone(); // Not OK! hWu#}iN
} wa9{Q}wSa
public void rightStore (int[][] data){ `=foB-(zt
// OK! pQxi0/d p
this.data = (int[][])data.clone(); M7lMOG(\
for (int i = 0; i < data.length; ++i){ [C~{g#
if (data != null) v3jx2Z
this.data = (int[])data.clone(); t#J
#DyY5
} Y) 4D$9:
} <Gu dx>I
Y6@A@VJ
8<ri"m,
DU4Prjb'
cXokq
六、常见错误6#:检查new 操作的结果是否为null 4~r=[|(aY
KK*"s^L
cE=v566
tU7eW#"w
Java编程新手有时候会检查new操作的结果是否为null。可能的检查代码为: h:+>=~\
{=d\t<p*n
xF{<-b
]HP
Integer i = new Integer (400); dkf?lmC+M
if (i == null) [! :.9
throw new NullPointerException(); f&>Q6 {*]
o' DXd[y
71w$i
4
hpym!G
检查当然没什么错误,但却不必要,if和throw这两行代码完全是浪费,他们的唯一功用是让整个程序更臃肿,运行更慢。 ]urcA,a
8YBsYKC
7QRtNYo#\
Hw/1~O$T
C/C++程序员在开始写java程序的时候常常会这么做,这是由于检查C中malloc()的返回结果是必要的,不这样做就可能产生错误。检查C++中new操作的结果可能是一个好的编程行为,这依赖于异常是否被使能(许多编译器允许异常被禁止,在这种情况下new操作失败就会返回null)。在java 中,new 操作不允许返回null,如果真的返回null,很可能是虚拟机崩溃了,这时候即便检查返回结果也无济于事。 *%cI,}%
r,b-c
七、常见错误7#:用== 替代.equals #PmF@
CHR
A!
1>
在Java中,有两种方式检查两个数据是否相等:通过使用==操作符,或者使用所有对象都实现的.equals方法。原子类型(int, flosat, char 等)不是对象,因此他们只能使用==操作符,如下所示: AuU:613]W8
T ~t%3G
VG\ER}s&P
U=%S6uL\bx
int x = 4; R16"lG
int y = 5; ?
B^*YCo7(
if (x == y) }qXi;u))
System.out.println ("Hi"); ?Zoq|Q+
// This ’if’ test won’t compile. 58MBG&a%
if (x.equals (y)) uBs[[9je(
System.out.println ("Hi"); :/Nz' n
{{=7 mbc
bd<zn*HZ*
J2H8r 'T
对象更复杂些,==操作符检查两个引用是否指向同一个对象,而equals方法则实现更专门的相等性检查。 z0Gh |N@)
Dx Vt
W?/7PVGv5h
c:~o e
更显得混乱的是由java.lang.Object 所提供的缺省的equals方法的实现使用==来简单的判断被比较的两个对象是否为同一个。 ipKkz
L1"X`Pz[}
D9c8#k9Y.
">voi$Kzey
许多类覆盖了缺省的equals方法以便更有用些,比如String类,它的equals方法检查两个String对象是否包含同样的字符串,而Integer的equals方法检查所包含的int值是否相等。 oc-7gz)
hgKs[ySo,3
"mT~_BsD
bU:"dqRm<
大部分时候,在检查两个对象是否相等的时候你应该使用equals方法,而对于原子类型的数据,你用该使用==操作符。 ^#%$?w>wI
})bTQj7
0 x"3
fwxyZBr
八、常见错误8#: 混淆原子操作和非原子操作 oChcEx%
G m<t2Csn
Ra_6}k
0/(YH
Java保证读和写32位数或者更小的值是原子操作,也就是说可以在一步完成,因而不可能被打断,因此这样的读和写不需要同步。以下的代码是线程安全(thread safe)的: o *I-~k
sOLo[5y'
F/RV{} 17E
}(TZ}* d
public class Example{ o&LNtl;
private int value; // More code here... -F|(Y1OE
public void set (int x){ lcIX
l&