代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 +z0s)HU>j
|Qb@.
u{w,y.l1h
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 [:}"MdU'
UkXa mGoy3
u/NcX
p>f?Rw_
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 z_=V6MDM
ef!f4u\
tv Zq):c
lon9oraF'
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 -r]L MQ
|lk:(~DM
x<OVtAUB
^w&!}f+
一、常见错误1# :多次拷贝字符串 X 4!Jj*
`
@lNt}
:6Tv4ZUvcG
&;`E3$>
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 u.*}'C>^^v
ZD7qw*3+
~3&hvm[IQ
dPxJ`8
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: xZM4CR9]*C
#_|O93HN'
g_!xD;0
)]LP8
J&
String s = new String ("Text here"); /{P-WRz>
ep0dT3&
Dd,i^,4Gj
-1~o~yGE
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: AX'-}5T=
/1D.Ud^
X<pNc6
G'';VoW=
String temp = "Text here"; 0P{8s
String s = new String (temp); "!fwIEG
Ed{sC[j=
Crl:v8
"zz b`T[8
但是这段代码包含额外的String,并非完全必要。更好的代码为: cct/mX2&~
.6I'V3:Kg
]=]MJ3_7
ykH@kv Qt
String s = "Text here"; 9'e<{mlM
=zDvZ(5
):nC%0V
(_+ux1h6^
二、常见错误2#: 没有克隆(clone)返回的对象 [d-Y1
R=$}uDFmW
$9xp@8b\_
e.#,9
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: (d*||"
QC&,C}t,
!4<A|$mQ
k*C[-5&#
import java.awt.Dimension; *UXa.kT@
/***Example class.The x and y values should never*be negative.*/ `s3:Vsv4
public class Example{ =Zsxl]h
private Dimension d = new Dimension (0, 0); e**'[3Y
public Example (){ } *65~qAd
z]LVq k
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ 0I do_V
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ `2^(Ss#)
if (height < 0 || width < 0) 83p8:C.Ze
throw new IllegalArgumentException(); F1L[C4'
d.height = height; &&m1_K
d.width = width; )K`tnb.Pf
} Pj_DI)^
f^F"e'1
public synchronized Dimension getValues(){ \:'6_K
// Ooops! Breaks encapsulation I)0_0JXs
return d; L/%{,7l<^?
} -^;,m=4{3
}
U z[#ye
NR-<2
e3
B[
D
s?:
Bn=YGEvz
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: ?'"BX
.3@Pz]\M#>
4d}n0b\d
'<*%<J{(
Example ex = new Example(); :_nGh]%
Dimension d = ex.getValues(); +_gA"I
d.height = -5; gS`Z>+V5!c
d.width = -10; G `B=:s]
cWo__EE
tL1\q Qg
[Ls%nz|
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 /TIt-c
t("koA=.
'?fGI3b~/
(v:8p!QN
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 C7}iwklcsa
klY, @
twK 3
z(2G"}
更好的方式是让getValues()返回拷贝: ~Ga{=OM??
A`>^A]%
5~(nHCf>
lH@goh
public synchronized Dimension getValues(){ `krVfE;_O
return new Dimension (d.x, d.y); 8YgRJQZ!
} 78<fbN5}r
+&J1D8
;TwqZw[.
m5HMtoU
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 kGakdLl
-Ekf T_
*"6A>:rQs
=4&"fZ"v
三、常见错误3#:不必要的克隆 ]@}hyM[D;
TC@F*B;
sEZ2DnDI
|?MD>Pez
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: A@4{-e\
JRE\R&>g
nr(C*E
-~H
"zu`
/*** Example class.The value should never * be negative.*/ ymnK `/J!Q
public class Example{ FP0GE
private Integer i = new Integer (0); ycvgF6Me<
public Example (){ } +JXn
A_2lG!!
6
/*** Set x. x must be nonnegative* or an exception will be thrown*/ v;}MHl
public synchronized void setValues (int x) throws IllegalArgumentException{ CP$,fj
if (x < 0) HW'I $ .
throw new IllegalArgumentException(); jMX|1b
i = new Integer (x); P=y1qqC
} hAP2DeT$
\8vZZ t
public synchronized Integer getValue(){ D4$"02"
// We can’t clone Integers so we makea copy this way. WU.eeiX
return new Integer (i.intValue()); l <Z7bo
} r&:yZN
} :6m"}8*q8
AI,E9
300[2}Y]
9+.3GRt7
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 /c4$m3?]
p!<PRms@
)oM%
N
(l(d0g&p>
方法getValue()应该被写为: |Vu`-L'Jz
ORXH<;^0y
]XL=S|tIq
C{G%"q
public synchronized Integer getValue(){ yLl:G;
// ’i’ is immutable, so it is safe to return it instead of a copy. [[ Nn~7
return i; tn(6T^u
} lYr4gFOs
e"p){)*$
ec*Ni|`Z'
t~qAA\p}o
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: IEI&PRD
C*t0`3g
d
~4] J'E >
<Skf
n`).
?Boolean xf|C{XV@H
?Byte -KG1"g,2
?Character gh `_{l
?Class ofgNL .u
?Double Y
7?q`
?Float o0dD
?Integer (&_^1
?Long 0fV}n:4Pq
?Short `dl^)4J
?String SK*<H~2
?大部分的Exception的子类 P$@:T[}v
3q6FV7Fv&b
>rYMOC~
f Avh!g
四、常见错误4# :自编代码来拷贝数组 _BCq9/
y"K[#&,0
yD0DPtti
'c
>^Aai
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: zqRps8=
^
7)H;$
Z]Cd> u
IL?"g{w
public class Example{ *fLVzYpo
private int[] copy; azRp4~2?
/*** Save a copy of ’data’. ’data’ cannot be null.*/ S]4!uv^y
public void saveCopy (int[] data){ ;D%H}+Z
copy = new int[data.length]; a,n#E!zT?w
for (int i = 0; i < copy.length; ++i) (ti E%nF+
copy = data; 6.|[;>Km
} .5A .[ZY)
} C0ORBp
20:![/7:!
<" 0b8 Z
P#rS.CIh
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: X'xnJtk
Q Vl"l'e8
_! ?a9
iWkC:fQz
void saveCopy (int[] data){ N7)K\)DS!z
try{ 1DH P5q
copy = (int[])data.clone(); o}52Qio
}catch (CloneNotSupportedException e){ c68,,rJO]i
// Can’t get here. i\#?M "
} X3~@U7DU
} Oz<#s{Z
"DX2Mu=
/38XaKc{6
:*t5?
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: mKUm*m#<