代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 #aqnj+
eu(Fhs
!&U75FpN}:
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 <$nPGz)}
2f(`HSC'
f}c;s
`q}D#0
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 LW=qX%o{
=9&2udV1
JQ+Mg&&Q
48p3m)5
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 KDN#CU
L4iWR/&
whI4@#
HVM%B{(
一、常见错误1# :多次拷贝字符串 I(6%'s2
cC8$ oCR?
ihkZs3}
*RY}e
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 g!0
j1
h),;j`PrC
IsE&k2 SD
{tVA(&\<
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: jnV#Q
;
H;=yR]E
Yyk~!G/@
sD3Ts;k
String s = new String ("Text here"); }%KQrlbHJl
"|6(.S+o
>D=X
Tgqqq
T#&1q]P1F
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: frbd{o
S(=@2A+;
P.(UbF d'
n l5+#e*\
String temp = "Text here"; %\it4 r3
String s = new String (temp); u&y> '
-IIrrY
O
^aaj=p:cV
4H;g"nWqO
但是这段代码包含额外的String,并非完全必要。更好的代码为: -t_&H\_T
yc0
1\o
^(Gl$GC$Mu
-Ua5anzB
String s = "Text here"; WDNj7
fTmJDUv+
r%: :q^b3
Xp;'Wa"@
二、常见错误2#: 没有克隆(clone)返回的对象 6~ET@"0uK
i(A`'V8GY
<,Gjo]z
%YxKWZ/?
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: u9_?c
G-
E.#JCO|(1
1mV
'
~W
X'd\b}Bm
import java.awt.Dimension; NiG&Lw*8
/***Example class.The x and y values should never*be negative.*/ nR%w5oe
public class Example{ ?r;F'%N=
private Dimension d = new Dimension (0, 0); K*~xy bA
public Example (){ } 8\il~IFyi
8?~>FLWTXZ
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ SP0ueAa}
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ ^C,rN;mX'
if (height < 0 || width < 0) FUI/ A>
throw new IllegalArgumentException(); Q8TR@0d
d.height = height; ruhC:rg:/
d.width = width; Fkv284,LM
} W&A^.% 2l
+fvVora
public synchronized Dimension getValues(){ HmXxM:[4;
// Ooops! Breaks encapsulation pDC`Fi
return d; i{g~u<DH)Q
} oKRI2ni$j9
} F, =WfM\
xqT} 9,
b#709VHm
w_@6!zm
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: :4:U\k;QwA
M!G/5:VZ
*"|f!t
Z'AjeZyyE
Example ex = new Example(); ~Q- /O~
Dimension d = ex.getValues(); i&HU7mP/
d.height = -5; W__$
i<1
d.width = -10; UXa%$gwFw
a# 0*#&?7@
&w_8E+YZ
y=GDuU%
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 BAqwYWdS
D$hK
be6`Sv"H
~HctXe' x
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 8pmWw?
7x*L 1>[`'
98}l`J=i
K/&
更好的方式是让getValues()返回拷贝: Y(JZP\Tf_N
L#V e[
G$`hPNSh
$9@Z\0
public synchronized Dimension getValues(){ ?:PF;\U
return new Dimension (d.x, d.y); _=w=!U&W
} CS^|="Zs
787i4h:71
nQw, /Lk
ylmVmHmc
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 &WbHM)_n
UuJ gB)
q!d7Ms{q
]VVx2ERs
三、常见错误3#:不必要的克隆 Lz-(1~o
17rg!'+
5Shc$Awc!
yWYsN
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: 5N>L|J2
xG%O^
c*8k _o,
e~G IUwJ
/*** Example class.The value should never * be negative.*/ _T^@,!&
public class Example{ En+`ZcA\z
private Integer i = new Integer (0); }g.)%Bw!
public Example (){ } m]++
!
M4XU*piz
/*** Set x. x must be nonnegative* or an exception will be thrown*/ btf]~YN
public synchronized void setValues (int x) throws IllegalArgumentException{ 9@(V!G
if (x < 0) l%cE o`U
throw new IllegalArgumentException(); yV@~B;eW0
i = new Integer (x); xqVIw!J?/}
} ;>p{|^X0D
uoY]@.
public synchronized Integer getValue(){ U_0"1+jbq
// We can’t clone Integers so we makea copy this way. Yv;iduc('
return new Integer (i.intValue()); k1^&;}/f:
} F-?s8RD
} ][Cg8
cj3P]2B#
p-8x>dmP(
O~bzTn
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 v3/G.B@=
x8rp Z
}!vJ+
mVyF M -`
方法getValue()应该被写为: 5,V3_p:)VI
^^*dHWHn<
&C E){jC
1`&"U[{
public synchronized Integer getValue(){ E7Pz~6
// ’i’ is immutable, so it is safe to return it instead of a copy. ]\%u9,b%!
return i; fH
5/
} s4\_%je<v
"Kn%|\YL@4
rcMSso2
f,Dj@?3+
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: z!\)sL/"
&q[`lIV, L
)mXu{uowr
l:VcV
?Boolean g"v-hTx
?Byte 3hzKd_
?Character =qTmFszT
?Class dxeLu
?Double Oc?]L&a