代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 #tHYCSr]
.wq
j
'@+q_v@Jl
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 CQ. C{
VT4>6u}
YHom9&A
OqMdm~4B!j
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 -f ~1Id
eDP&W$s#
G)[gLD{g?
\F`>zY2$%
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 cSB_b.@"1
R'tvF$3=i
zj2y=A|Y
oXht$Q
一、常见错误1# :多次拷贝字符串 Ig?9"{9p
=s*c(>
-a>CF^tH
X6Z/xb@
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 `a[fC9
#W/Ch"Kv
{`*Fu/Upb
$v2t6wS,"
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: LqI&1$#
XY6Sm{
1>\V>g9
Q.jThP`p
String s = new String ("Text here"); E>-I
|X"L1
A7#nBHwxZ
NpM;vO
j~.tyxOq#
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: }BT0dKx
r7V !M1
6A=k;do
o[eZ"}~
String temp = "Text here"; [OOQ0c~
String s = new String (temp); m*B4a9f
z#`Qfvu6Hi
guf&V}&
`S4*~Xx
但是这段代码包含额外的String,并非完全必要。更好的代码为: ~;]zEq-hG
f>Ua 7!b
YZ:C9:S6X
pQc-}o"
String s = "Text here"; pZ*%zt]-a
Ylu\]pr9|C
C,mfA%63
KlS#f
二、常见错误2#: 没有克隆(clone)返回的对象 a
@3s71
f<rn't{
/+`%u&<
mqsAYzG
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: g2==`f!i
E8nj_^Z
OXKV6r6f
+G"YQq'b
import java.awt.Dimension; kMLJa=]$
/***Example class.The x and y values should never*be negative.*/ )/Eu=+d
public class Example{ n q>F_h
private Dimension d = new Dimension (0, 0); A*/8j\{n
public Example (){ } bd%<
Jg+
+kE~OdZG
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ b]xoXC6@ t
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ H =~7g3
if (height < 0 || width < 0) 1/;E8{
throw new IllegalArgumentException(); 1$C?+H
d.height = height; 3 4%B0
d.width = width; Z.Dg=>G]
} 0m> 8
:Ru8Nm
public synchronized Dimension getValues(){ s>\^dtG7
// Ooops! Breaks encapsulation 3< 6h~ek)
return d; (jyufHm
} (=c,b9cb
} /hVwrt(
o^"OKHU,S0
|nLq4.
)Qe]!$tqfD
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码:
qbS6#7D
j[w=pF,o
< Mu`,Kv*
:X-S&SX0
Example ex = new Example(); EH M 59s|B
Dimension d = ex.getValues(); QZ;DZMP
d.height = -5; _Ds,91<muQ
d.width = -10; &)||~
R'>@ja*
VMJaL}J]
'yA/sZ
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 ?)k]Vg.
8c9<kGm$E
@^-Y&N!b=
aTeW#:m
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 $Q'z9ghEg
RU6c 8>"
vbtZ5Gm
L1(-xNUo_i
更好的方式是让getValues()返回拷贝: X;)/<:mX
39P55B/o%
h qjjd-S0
?(K=du
public synchronized Dimension getValues(){ \>lA2^Ef
return new Dimension (d.x, d.y); }Kp<w,
} C3f\E: D)
"gm5DE
\**j\m
iZeq
l1O
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 Zxqlhq/)
,i<cst)$u
J!5b~8`v
c6c@XdV
三、常见错误3#:不必要的克隆 R0tT4V+
.f-=gZ* *
.RFH@''
Q25VG5G
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: 6<fG;:
ivq(eKy
WR"1d\m:
ug ;Xoh5w
/*** Example class.The value should never * be negative.*/ C:5d/9k
public class Example{ G&1bhi52
private Integer i = new Integer (0); nC%qdzT
public Example (){ } },JJ!3
'xkl|P>=],
/*** Set x. x must be nonnegative* or an exception will be thrown*/ 5BXku=M
public synchronized void setValues (int x) throws IllegalArgumentException{ sHk>ek]2I
if (x < 0) a4 N f\7
throw new IllegalArgumentException(); ! {G0'
i = new Integer (x); >|kD(}Axf
} YkB@fTTS
E/%"%&`8j
public synchronized Integer getValue(){ LFHJj-nk
// We can’t clone Integers so we makea copy this way. Q#SQ@oUzD
return new Integer (i.intValue()); H~Vf;k>
} e]88 4FP
} .|R4E
jLVD37 P^
=%IyR
6Nn+7z<*&z
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 8t*sp-cy|
At=d//5FFP
H#;*kc
a4
GK'p$`oJm
方法getValue()应该被写为: LPJ7V`!k
b=:u d[h
FV
"pJ
4FRi=d;mP
public synchronized Integer getValue(){ ~,1Sw7rE
// ’i’ is immutable, so it is safe to return it instead of a copy. R`a~8QVh&5
return i; ([<HFc`
} $B%KkD
Ta?}n^V?;
N2A6C$s
'0q$qN
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: *qO)MpG{
0,ryy,2
iD_y@+iz
TQ4L~8
?Boolean Ri" hU/H{
?Byte lNg){3
?Character 6 V0Ayxg7
?Class JJ?rVq1g
?Double j;coP ehB
?Float ..u{v}4&
?Integer 9_:"`)]3B
?Long r@zT!.sc!
?Short MukJ^h*V
?String _(h=@cv
?大部分的Exception的子类 A[;deHg=
MYy58N
4mo/MK&M:
0 N>K4ho6{
四、常见错误4# :自编代码来拷贝数组 LPt9+sauf1
Y#68_%[
; o_0~l=-/
Hm'"I!jyO
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: ~ `qWEu
L@(. i
nI6ompTX
!mUJ["#
public class Example{ ^)>( <6
private int[] copy; PtW2S 1?j
/*** Save a copy of ’data’. ’data’ cannot be null.*/ m#RJRuZ|2V
public void saveCopy (int[] data){ gUx}vE-
copy = new int[data.length]; g-d{"ZXd J
for (int i = 0; i < copy.length; ++i) 63u%=-T%a
copy = data; VmPh''Z%-
} #4$YQ
} uM[|>t
tpcB}HUv
J Ah!#S(
diJpbR^JP
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: iXnXZ|M
ftPps-
I&La0g