代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 Y'R/|:YL@
!!Yf>0u#
ww'B!Ml>F
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 A$;*O)
Uf?+oc'{
Z hCjY
`;m0GU68
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 Kf$6D 79#
(@O,U
p-7?S^!l
+|4olK$[
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 H3Zt3l1u+
(;HO3Z".q$
]a:T]x6'
l[nf"'
一、常见错误1# :多次拷贝字符串 .l,NmF9
-}8r1jQH;
7a.iT-*
1d&Q
E\2}
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 R F;u1vEQ8
E6- ~
i2LN`5k
fRzJiM{
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: z34+1d
4!?4Tc!X
e.!~7c_z?
clIn}wQ
String s = new String ("Text here"); JNu+e#.Y
c&`]O\D-c
M IU B]
gM6o~ E
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: mt-t8~A
SNH AL F
) LBbA
f>? b2a2HX
String temp = "Text here"; ^4{{ +G)j
String s = new String (temp); OoZv\"}!_
Q:Y`^jP
\@6V{y'Zo
YsRq.9Mr
但是这段代码包含额外的String,并非完全必要。更好的代码为: }7qboUG e
rFto1m
4HGR-S/
:,'.b|Tl.b
String s = "Text here"; t0T#Xb
9}d^ll&
SFqq(K2u
z_Pq5
二、常见错误2#: 没有克隆(clone)返回的对象 : p7PiqQ
{ka={7
m khp@^5
Q+E)_5_sA
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: P0-K/_g
>i2WYT
Z%VgAV>>
z+Ej`$E{lD
import java.awt.Dimension; }wGy#!CSza
/***Example class.The x and y values should never*be negative.*/ l_T5KV
public class Example{ |eej}G(,m}
private Dimension d = new Dimension (0, 0); 9]a!1
public Example (){ } m$$sNPnT
-L2%,.E>4
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ -qB{TA-.\
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ 5^36nEoA(
if (height < 0 || width < 0) ov'C0e+o
throw new IllegalArgumentException(); [}"m4+
d.height = height; R^6^{q
d.width = width; HgOrrewj
} ezr'"1Ba}
6
$+b2&V
public synchronized Dimension getValues(){ D (">bR)1
// Ooops! Breaks encapsulation C33=<r[;N<
return d; Yg]!`(db
} ZJ|&t
} J-~:W~Qx4N
dijHi
IjRUL/\=
r} a,
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: jp#/]>(9Z
NMhI0Ix$w
++d[YhO
Opf^#6'mq
Example ex = new Example(); ~G8haN4
Dimension d = ex.getValues(); :n$?wp
d.height = -5; !]!J"!xg*
d.width = -10; 7^Y`'~Y^
ZG_iF#
nb U?:=P
EZ)GW%Bm2
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 nbSu|sX~r5
6G?7>M
a O(&<
b@)nB
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 -!:h]
Hc-Ke1+
@s~*>k#"#
Ve\P ,.
更好的方式是让getValues()返回拷贝: `:EU~4s\
KvuM{UI5
Ip;;@o&D
^1z)\p1
public synchronized Dimension getValues(){ t3;QF
return new Dimension (d.x, d.y); '8UhYwyr
} }1Km h]
420yaw/":
+cx(Q(HD\
-n`2>L1
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 {#}?-X
cW\Y1=Gv|
]j^rJ|WTH
Xm[Cgt_?
三、常见错误3#:不必要的克隆 aUEnQ%YU"
rZG6}<Hx
zZ{(7Kfz
Mg=R**s1x%
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: _}:#T8h
bn0Rv
t-$Hti7Lk
TvwkeOS#}7
/*** Example class.The value should never * be negative.*/ !jyy`q=
public class Example{ 6eAJ>9@x
private Integer i = new Integer (0); WEk3
4crk
public Example (){ } td\'BV
55vI^SSA
/*** Set x. x must be nonnegative* or an exception will be thrown*/ (j884bu
public synchronized void setValues (int x) throws IllegalArgumentException{ PW GNUNc
if (x < 0) WO"<s{v
throw new IllegalArgumentException(); K.: :P84m;
i = new Integer (x); #]FJx
} _XUDPC(*qz
3C(V<R?
public synchronized Integer getValue(){ bKP@-<:]
// We can’t clone Integers so we makea copy this way. 2N}h<Yd9
return new Integer (i.intValue()); #tlhH\Pr[
} }X^CH2,R
} @1iH4RE*
Cw]bhaG
g
5{O9<~,
geEETb}+y
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 uE:`Fo=y
x$/:%"E
({kOgOeC
6eHw\$/
方法getValue()应该被写为: ,ku3;58O<
`Fs- z
&U0Y#11Cx
Cy'! >
public synchronized Integer getValue(){ SbN.z
// ’i’ is immutable, so it is safe to return it instead of a copy. iE=:}"pI"
return i; YTYCv7
} } {<L<
b<"LUM*;
Q!v]njCIB7
|t&gyj
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: 37nGFH`K2m
Jw)-6WJ!uO
g"Gj8QLDz
n`2LGc[rP
?Boolean %8~g#Z
?Byte P_Ni
5s)
?Character &(YNz9L
?Class A_JNj8<6r
?Double E.+BqWZ!
?Float O t1:z:Pl
?Integer AG(Gtvw
?Long ~k780
?Short {'1e?
?String G>w+J'7
?大部分的Exception的子类 nZ8f}R!f:
_"c:Z !L
LP:F'Q:<
'NDDj0Y
四、常见错误4# :自编代码来拷贝数组 BhC>G2 ^7
N(=\S:
N4[^!}4
"=vH,_"Ql
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: ^muPjM+D
<n{-&;>
$|pD}
jRYW3a_7
public class Example{ |]'0z0>
private int[] copy; zaMKwv}BR
/*** Save a copy of ’data’. ’data’ cannot be null.*/ QTT2P(Pz
public void saveCopy (int[] data){ ]q CCCI`
copy = new int[data.length]; '5
kSr(
for (int i = 0; i < copy.length; ++i) ]iE)8X
copy = data; ~5sH`w~vQ
} 3KN>t)A#
} DZ5QC aA
Z2^B.r#
*nc9u"
/XZ\Yy=
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: DfV'1s4y
ePxwN?
X;%*+xQ^
.:V4>
void saveCopy (int[] data){ n+%tu"e
try{ yi@mf$A|
copy = (int[])data.clone(); S1G3xY$0
}catch (CloneNotSupportedException e){ I4%25=0?
// Can’t get here. lJ/{.uK
} Z|IFT1K
} "?SR+;Y:q
0|D
l/1
\\i$zRi
->Bx>Y
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: JDj^7\`
;/|3U7{c
5B,HJax
V^ 5Z9!
static int[] cloneArray (int[] data){ 1H]E:Bq
try{ Dh~Z8!*
return(int[])data.clone(); #uillSV
}catch(CloneNotSupportedException e){ to"[r
// Can’t get here. bdz&"\$X
} Y:'#jY*V
} Cv;\cI"&
|{JJ2c\W
Qb~&a1&s#
? =a,
这样的话,我们的saveCopy看起来就更简洁了: CKgbb4;<m[
Sw^-@w=!U5
KuohUH+
)o>1=Y`[z
void saveCopy (int[] data){ }$T!qMst{
copy = cloneArray ( data); 'p:L"L}Q?
} 5'hQ6i8
jFThW N
[5O`
5*31nMP\
五、常见错误5#:拷贝错误的数据 6K
6uB
~
At=l>
.7Lv
%*`yd.L0W
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: 'YUx&FcM
P 2^((c
XOi[[G}
"=r"c$xou
import java.awt.Dimension; O)i]K`jk
/*** Example class. The height and width values should never * be
T24?1
negative. */ ?=X_a{}/
public class Example{ oy!Dm4F
static final public int TOTAL_VALUES = 10; `GD>3-
private Dimension[] d = new Dimension[TOTAL_VALUES]; EFKOElG(k
public Example (){ } |L"!^Y#=D
,BCo/j
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ 3x{2Dh i
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ ZD'fEqM
if (height < 0 || width < 0) r=3knCEWK
throw new IllegalArgumentException(); .0zNt
if (d[index] == null) :x<'>)6
d[index] = new Dimension(); \dIQhF%%2
d[index].height = height; %95'oW)lo
d[index].width = width; 8x J]K
} T)NnWEB
public synchronized Dimension[] getValues() "x)xjL
throws CloneNotSupportedException{
G$"$k=[
return (Dimension[])d.clone(); C'c9AoE5>
} eHjn<@
} pwvcH3l/r
_@47h86Q
&
M wvj
-OS&(7
这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。方法getValues()的更好版本为: r6Hdp
#*<*|AwoW|
?5<