代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 }hv>LL
]z;%%'gW6
cK"b0K/M?B
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 ;J Fy
8Rj
_0<qS{RW
{=VauF
Tj$D:xKf)
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 a39Kl_\
.n'z\]-/Q
k.NgE/;3
FhVi|Va
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 % V/J6
Y1vl,Yi
eYLeytF]Uy
m_wBRan
一、常见错误1# :多次拷贝字符串 F
0q#.
iqW
T<WY
epqX2`!V
ov.7FZ+
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 x >hnH{~w
X`YA JG
<05\
WLqwntzk
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: ),1MR=
C(qqGK{
SRuNt3wW6
!)FM/Xj,o
String s = new String ("Text here"); Nz %{T
/"Ws3.p
G'T/I\tB
q|xJ)[AO
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: N,6(|,m
LT']3w
[R:\
8(J&_7u
String temp = "Text here"; q'{LTg0kk
String s = new String (temp); p}_n
:a
\WKly
('BFy>@
B/u0^!
但是这段代码包含额外的String,并非完全必要。更好的代码为: /ZlPEs)
.cJWYMC
7) aitDD
QhUv(]0
String s = "Text here";
'_!j9A]g
Gu?OyL
}#va#Nb(,
X+2 aP'D
二、常见错误2#: 没有克隆(clone)返回的对象 -?{bCq
=g|e-XC
s}yJkQb
)* 5R/oy,
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: 8G@I e
=8FV&|fP
m:U.ao6
5=]q+&y\H
import java.awt.Dimension; -ZwQL="t
/***Example class.The x and y values should never*be negative.*/ CZaUrr
public class Example{ ".aypD)W
private Dimension d = new Dimension (0, 0); I!'PvIyO
public Example (){ } G=?2{c}U
n-iy;L^b
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ }@Rq'VPZd
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ hwgLJY?
if (height < 0 || width < 0) "A\.`*6
throw new IllegalArgumentException(); '@OqWdaR
d.height = height; 7u8HcHl
d.width = width; wV\;,(<x=%
} `
O;+N"v
1NJ,If]
public synchronized Dimension getValues(){ &%3$zgvR
// Ooops! Breaks encapsulation hF`e>?bN
return d; Bc1[^{`bq^
} ,=o)R,[
} Mle@.IIT
qbu>YTj
=fA*b
$r0~&$T&
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: v,6
O7r<6(q(
S<),
,(
cspO5S>#
Example ex = new Example(); Om
#m":
Dimension d = ex.getValues(); Cm)_xnv
d.height = -5; ] Tc!=SV
d.width = -10; YbS$D
2de[ yz
)
xRm
:5kgJu
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 )Rhy^<xH
~~J xw ]
QiDf,$t|,
Twscc"mK
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 G)qNu }
@
s
c;\}R#
j9)WInYc:
更好的方式是让getValues()返回拷贝: #is1y3yh
$@
/K/"
n<Vq@=9AE
^A9D;e6!-
public synchronized Dimension getValues(){ ?~G D^F
return new Dimension (d.x, d.y); >:5^4/fo*
} I'"b3]DXG
+(>!nsf
^Y mq<*X
fBgW0o.Bu
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 V*an0@
(e>.hfrs
wSrq?U5q
S<RJ46
三、常见错误3#:不必要的克隆 X^L)5n+$X
YS$?Wz
1$cX`D`
}%j@%Ep[
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: lWYZAF>?Ym
gQpF(P
7"L`|O?8)
x --buO
/*** Example class.The value should never * be negative.*/ [/.5{|&GSt
public class Example{ )ESF)aKMiz
private Integer i = new Integer (0); oBVYgv)
public Example (){ } g[P.lpi{U
tx-HY<
/*** Set x. x must be nonnegative* or an exception will be thrown*/ l.tNq$3pS
public synchronized void setValues (int x) throws IllegalArgumentException{ JXR_klx
if (x < 0) 99T_y`df
throw new IllegalArgumentException(); 2LpJ xV
i = new Integer (x); ]?<j]u0J
} /mELnJ^
idL6 *%M
public synchronized Integer getValue(){ \/8 I6a=
// We can’t clone Integers so we makea copy this way. M[wd.\
%
return new Integer (i.intValue());
T~I5W=y
} b_Us%{
} 2{t i])
igNZe."V
8=
jl]q$<
n-q
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 d
]LF5*i
zh2gU@"
x Bn+-V
'n>,+,&
方法getValue()应该被写为: k(Z+(Y'{q~
-eKi}e
p1B~:9y9X
E|u#W3-:
public synchronized Integer getValue(){ i#I+
// ’i’ is immutable, so it is safe to return it instead of a copy. OoKzPePWji
return i; ,Y~{RgG
} ["|' f
imcq
H
q$vATT
\RcB,?OK
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: LM:|Kydp3
2mVcT3
G([8Q8B4+
M{Ss?G4H
?Boolean W@NM~+)e
?Byte w,L P M+
?Character 5m,{?M`
?Class ?haN ;n6'
?Double .k5
TQt
?Float [jl'5l d
?Integer ` aTkIo:ms
?Long ZM oV!lu
?Short H\ A!oB,sw
?String a\an
?大部分的Exception的子类 0RY{y n3
uPk`9c52%
5Z{h!}Y
YDBQ6X
四、常见错误4# :自编代码来拷贝数组 ]PVPt,c
ra\Moy
y=y=W5#;77
~@ZdO+n?
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: M/GQQG;
Sfc0 ~1
S -j<O&h~C
'| Enc"U
public class Example{ ND[u$N+5x"
private int[] copy; '0g1v7Gx
/*** Save a copy of ’data’. ’data’ cannot be null.*/ loVUB'OSv
public void saveCopy (int[] data){ "@!z+x[8
copy = new int[data.length]; Y%9S4be
for (int i = 0; i < copy.length; ++i) -|^}~yOx0=
copy = data; ;+]9KIa_Pq
} ,)mqd2)+"
} y3T-^
;=X6pK
m7X&"0X
frS1<+
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: ~S}>|q$
,]@ K6
$,ev <4I&
lyiBRMiP|
void saveCopy (int[] data){ :+ksmyW
try{ [\CQ_qs|
copy = (int[])data.clone(); Z qX U
}catch (CloneNotSupportedException e){ 7|3Qcn7P)@
// Can’t get here. ^_b+o
} BQWEC,*N
} lTe}[@(
n k]tq3.[
$2E n^
A0.)=q
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: V%k[S|f3
?&Si P-G
2<}^m/}
T[M?:~
static int[] cloneArray (int[] data){ X}'3N'cbkU
try{ #.p^S0\pw
return(int[])data.clone(); $Tu%dE(OF
}catch(CloneNotSupportedException e){ :)}iWKAse
// Can’t get here. u2K{3+r`'
} Db\.D/76
} v :]y#y
`we2zT
jEfrxlj
2|F.J G^
这样的话,我们的saveCopy看起来就更简洁了: E :*!an
{:40Jf
}Q_IqI[7
/b,M492
void saveCopy (int[] data){ i_ws*7B<
copy = cloneArray ( data); <lZyUd
} x<60=f[O2R
(V@g?|LZ
M$#zvcp
# 'G/&&<
五、常见错误5#:拷贝错误的数据 !%J;dOcU
%@q52ZQ
gT-'#K2qT
L~A"%T,/h
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: "L.)ML
`g6XVa*%#
<.(IJ
L?&+*|VxI
import java.awt.Dimension; <&TAN L
/*** Example class. The height and width values should never * be #T
Cz$_=t
negative. */ ~R-S$qizAC
public class Example{ (:2:_FL
static final public int TOTAL_VALUES = 10; uSbOGhP
private Dimension[] d = new Dimension[TOTAL_VALUES]; Rct|"k_"Ys
public Example (){ } `48jL3|
1"A1bK
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ qc~6F'?R
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ :s+AIo6
if (height < 0 || width < 0) 2NAGXWE
throw new IllegalArgumentException(); G/_#zIN`8M
if (d[index] == null) l_iucN
d[index] = new Dimension(); MBs]<(RJZ
d[index].height = height; *c7kB}/
d[index].width = width; VJBVk8P
} CCfuz &
public synchronized Dimension[] getValues() ?XL [[vyr
throws CloneNotSupportedException{ Z"'rc.>a
return (Dimension[])d.clone(); nH}api^0A
} 5tHv'@
} pSkP8'
?
"5%G[MB
LP_d}ve
6@g2v^ %
这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。方法getValues()的更好版本为: !1+L0,I6
o,9E~Q '`{
" jn@S-
vmJ1-<G4*
public synchronized Dimension[] getValues() throws CloneNotSupportedException{ y/mxdPw
Dimension[] copy = (Dimension[])d.clone(); ^tsIgK^9H
for (int i = 0; i < copy.length; ++i){ y;Q_8|,F
// NOTE: Dimension isn’t cloneable. N~l(ng9'U
if (d != null) P~redX=t@
copy = new Dimension (d.height, d.width); ?VEJk,/k
} _o~<f)E[9
return copy; irqlU
} g2;JJ}
bBAZr`<&U
Y oNg3
:-.R*W
在克隆原子类型数据的多维数组的时候,也会犯类似的错误。原子类型包括int,float等。简单的克隆int型的一维数组是正确的,如下所示: 'Fo*h6=
gSEj/?
Hq$AF
1""9+4
public void store (int[] data) throws CloneNotSupportedException{ 8wwqV{O7
this.data = (int[])data.clone(); bM_Y(TgJ
// OK vrm[sP
} .a:"B\B`
wblEx/FqE^
{,*G}/9<
epCU(d*b
拷贝int型的二维数组更复杂些。Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:它的类型为int[]。简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。下面的例子演示了在克隆int型二维数组时错误的和正确的做法: PP/M-Jql)
Mr<2I
Wd~aSz9
F)j-D(c4
public void wrongStore (int[][] data) throws CloneNotSupportedException{ *rSMD_>
this.data = (int[][])data.clone(); // Not OK! Kpz>si?CL
} !Y!Cv %
public void rightStore (int[][] data){ &BqRyUM$F
// OK! upQ:C>S
this.data = (int[][])data.clone(); Ah='E$t
for (int i = 0; i < data.length; ++i){ A`Z!=og=
if (data != null) ]G1{@r)
this.data = (int[])data.clone(); ,G
e7
9(
} l?NRQTG
} v#a`*^ ^
y1,L0v$=}
bRJYw6oA<
= PcmJG]
<_uLf9ja
六、常见错误6#:检查new 操作的结果是否为null IQMk :
6b9D db*
@j`_)Y\
m/|>4~
Java编程新手有时候会检查new操作的结果是否为null。可能的检查代码为: %Xh/16X${
XPd>DH(Yc
^ox^gw)
R5ZnkPEA
Integer i = new Integer (400); Rs_@L}U..
if (i == null) Pg-~^"?y
throw new NullPointerException(); &}nU#)IX
/4YXx|V
_J }ce
AT<gV/1l
检查当然没什么错误,但却不必要,if和throw这两行代码完全是浪费,他们的唯一功用是让整个程序更臃肿,运行更慢。 n }7DL8
@4B+<,i
Z=sy~6m+v
pL]C]HGv
C/C++程序员在开始写java程序的时候常常会这么做,这是由于检查C中malloc()的返回结果是必要的,不这样做就可能产生错误。检查C++中new操作的结果可能是一个好的编程行为,这依赖于异常是否被使能(许多编译器允许异常被禁止,在这种情况下new操作失败就会返回null)。在java 中,new 操作不允许返回null,如果真的返回null,很可能是虚拟机崩溃了,这时候即便检查返回结果也无济于事。 ?t'ZX~k
FviLlly6
七、常见错误7#:用== 替代.equals ({yuwH?tH
R@5jEf
在Java中,有两种方式检查两个数据是否相等:通过使用==操作符,或者使用所有对象都实现的.equals方法。原子类型(int, flosat, char 等)不是对象,因此他们只能使用==操作符,如下所示: W=j/2c/
&9$0v" `H
d;|e7$F'
(?J6vK}S
int x = 4; y<m{eDV7
int y = 5; v'a]SpE5
if (x == y) LG [2u
System.out.println ("Hi"); ;DL|%-%;$r
// This ’if’ test won’t compile. f_Y[I:
if (x.equals (y)) F@kOj*5,[
System.out.println ("Hi"); xrA(#\}f$
l,1 }1{k&
COOazXtW
>Gk<[0U
对象更复杂些,==操作符检查两个引用是否指向同一个对象,而equals方法则实现更专门的相等性检查。 *#+d j"
z_*]joL
];R5[%:5
5{zXh
更显得混乱的是由java.lang.Object 所提供的缺省的equals方法的实现使用==来简单的判断被比较的两个对象是否为同一个。 2xZg, \
Y:^~KS=Uz
d0>V^cB '?
:bE ^b
许多类覆盖了缺省的equals方法以便更有用些,比如String类,它的equals方法检查两个String对象是否包含同样的字符串,而Integer的equals方法检查所包含的int值是否相等。 ^LfCLI9Z
_c['_HC
V-}d-Y
$G"PZ7
大部分时候,在检查两个对象是否相等的时候你应该使用equals方法,而对于原子类型的数据,你用该使用==操作符。 1(gb-u0
y+(<Is0w
'AF2:T\
>f^&^28
八、常见错误8#: 混淆原子操作和非原子操作 +>.plvZhu
Gs7mO
ZF51|b
ldM [8
Java保证读和写32位数或者更小的值是原子操作,也就是说可以在一步完成,因而不可能被打断,因此这样的读和写不需要同步。以下的代码是线程安全(thread safe)的: =9\=5_V
W:3u$LTf*f
M`FsKK`
@I]uK[qd
public class Example{ (i|`PA
private int value; // More code here... gu/eC
public void set (int x){ J@"Pv~R
// NOTE: No synchronized keyword DHbLS3-
this.value = x; @?aNvWeavH
} NSOWn]E
} BgA\l+
90k|W>
6[69|&
)"&-vg<
不过,这个保证仅限于读和写,下面的代码不是线程安全的: 1UJ(._0hR
ynw^nmM
Jb6rEV>
x-nwo:OA
public void increment (){ iEr|?,
// This is effectively two or three instructions: %pc0a^iB
// 1) Read current setting of ’value’. )FMpfC>An
// 2) Increment that setting. t}cj8DC!
// 3) Write the new setting back. R=i$*6}a
++this.value; <s9Sx>Zb
} U@|{RP
z Rz#0
5WO!u:!'
w6Dysg:
在测试的时候,你可能不会捕获到这个错误。首先,测试与线程有关的错误是很难的,而且很耗时间。其次,在有些机器上,这些代码可能会被翻译成一条指令,因此工作正常,只有当在其它的虚拟机上测试的时候这个错误才可能显现。因此最好在开始的时候就正确地同步代码: {AO3o<-h
'&?47+W
Yl&eeM
F`
J(+
public synchronized void increment (){ Xvi{A]V
++this.value; ?b#/*T}ac
} D@[$?^H
>7vSN<w~m
9`{Mq9J
y3 LWh}~E
九、常见错误9#:在catch 块中作清除工作 ) OZDq]mV
5iG|C ~
&4O"Xs`ka
BR*""/3`
一段在catch块中作清除工作的代码如下所示: 6du"^g
$ n n4
5c{=/}Y
twf;{lZ(
OutputStream os = null; &|9mM=^
try{ aFyNm@a
os = new OutputStream (); S]<G|mn,
// Do something with os here. zLOmtZ(['
os.close(); %04>R'mN
}catch (Exception e){ -
CM;sXq
if (os != null) wLkHU"'
os.close(); w V;y]'
} ?B@hCd)
CrS[FM= +W
YlPZa3\
~+l%}4RZ
尽管这段代码在几个方面都是有问题的,但是在测试中很容易漏掉这个错误。下面列出了这段代码所存在的三个问题: <u4GIi
<sm
ZJy
D/9y
A.35WGu&:
eC[g"Ef
1.语句os.close()在两处出现,多此一举,而且会带来维护方面的麻烦。 ot_jG)
-6+HA9zz@C
_'2r=a#`
rQKBT]?y
2.上面的代码仅仅处理了Exception,而没有涉及到Error。但是当try块运行出现了Error,流也应该被关闭。 i;/qJKr
KC }B\~ +
r)+dK}xl
EnwiE
3.close()可能会抛出异常。 w\$b(HC
cv#H
;pAkdX&b