代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 rB5+~
K@
N" oJ3-~
;4]l P
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 (%;D&
~%o
HC ?XNR&
V{kgDpB
i{ /nHrN
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 woK?td|/
7PI|~Ifi
= G3A}
y|Zj
M
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 2c<phmiK
<i1P ~
q0
8
$d7{ q3K&1
一、常见错误1# :多次拷贝字符串 S8Yh>j8-
HnfTj 5J@
+UP?M4g
n
6|\
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 R2[!h1nZ
zX/9^+p:
3836Di:{
bjq2XP?LL
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: Mxe
t \C[mw
YY<e]CriU
]qc2jut"
String s = new String ("Text here"); b; 4;WtBO
@;z}Hk0A
'GcZxF0
\>-%OcYlM
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: jDc5p3D&[]
wD&b[i
J&6]3x
;q$O^r~
String temp = "Text here"; 1e^-_Bo6'o
String s = new String (temp); 'H,l\i@"
KcjP39@I
I*K~GXWs#
yS-owtVCGF
但是这段代码包含额外的String,并非完全必要。更好的代码为: `_v|O{DC{
1%6}m`3
VN8ao0^d;d
mWM!6"
String s = "Text here"; ZK]C!8\2|
Y,@{1X`0@3
+P <Lo I
_sCpyu
二、常见错误2#: 没有克隆(clone)返回的对象 2xd G&}$fa
SSF4P&
Oj0/[(D-
`W8dayZt
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: ABp/uJI)
_#+~#U%5n
Kq';[ Yc
L1k_AC1.M
import java.awt.Dimension; <&rvv4*H
/***Example class.The x and y values should never*be negative.*/ YvK8;<k@-?
public class Example{ ?79ABm
a
private Dimension d = new Dimension (0, 0); )y:~T\g
public Example (){ } K(HP PM\
[?hc.COE
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ /^\6q"'
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ MLcc
if (height < 0 || width < 0) (v8jVbg
throw new IllegalArgumentException(); m>6,{g)
d.height = height; j{9sn,<:
d.width = width; xAD: Z"
} nV%1/e"5
v7/qJ9l
public synchronized Dimension getValues(){ e? fFh,a
// Ooops! Breaks encapsulation
}ya9 +?I
return d; pRj1b^F5y
} yggQ4y6
} #^v|u3^DD
eVDI7W:(Sn
*eytr#0B-
iVt6rX
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: x,z +l-y
T)]5k3{
Pz1pEyuL
2, ` =i
Example ex = new Example(); 0>m-J
Dimension d = ex.getValues(); aQaO.K2
d.height = -5; .4~n|d>z
d.width = -10; \0m[Ch}~ey
_}7N,Cx
RI"A'/56
-lm\~VZT3
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 0p_/eWww-
g~Zel}h#
,\f!e#d
Qe=!'u.nL
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 `|;R}"R;
[=-?n6
~fE@]~f>
_d&FB~=
更好的方式是让getValues()返回拷贝: wg*2mo
},'2j
: \w\K:
Qd 1Q~PBla
public synchronized Dimension getValues(){ ]dc^@}1bN
return new Dimension (d.x, d.y); &V[m{.
} q7C>A`w
~w'M8(
t+5JIQY>
`Xnu("w)
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。
e@6<mir[4
Qj?FUxw
d:6?miMH]t
g#;w)- Zj
三、常见错误3#:不必要的克隆 o64&BpCK
mV}
peb
&CFHH"OsT
/v
E >*x
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: B]q
&?~
~&=-*
}N1Z7G
T2
0dZ8{y
/*** Example class.The value should never * be negative.*/ ]C-hl}iq
public class Example{ ]%3o"|
private Integer i = new Integer (0); hp!UW
public Example (){ } ` ej
2;NIUMAMM
/*** Set x. x must be nonnegative* or an exception will be thrown*/
Q uy5H
public synchronized void setValues (int x) throws IllegalArgumentException{ Kgi%Nd
if (x < 0) RiF~-;v&
throw new IllegalArgumentException(); qIa|sV\w0
i = new Integer (x); AxUj CerNf
} -#H>kbs
^S'}RZ*>
public synchronized Integer getValue(){ Ft>Abj,6
// We can’t clone Integers so we makea copy this way. $6T*\(;T@A
return new Integer (i.intValue()); ,YJ\
$?
} Q_xE:#!;
} yw2^kk93|
C+$dm)M/q
iK1<4)
>n)N=Zyu
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 V4}9f5FR
RX%*:lXi_
-4o6 OkK<
.OVIQxf
方法getValue()应该被写为: nM1U=Du
I3D8xl>P\
q4PRc<\^
l)fF)\ |;=
public synchronized Integer getValue(){ a%7ju4CVj
// ’i’ is immutable, so it is safe to return it instead of a copy. 2:Q9gru
return i; WaQCq0Enj
} /NaIMo5
b&B<'Wb
SY_T\
}
,2/qQD n/
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: CE:TQzg
!-%i" a
ZkkXITQkPM
wX" 6 S:
?Boolean 5zX;/n~
?Byte UHF.R>Ry
?Character &aldnJ
?Class /pZLt)=P
?Double Xz&Hfs"/J
?Float kehv85
?Integer kN>%y&cK
?Long c%r?tKG6
?Short }kdYR#{s
?String (Sr&Y1D
?大部分的Exception的子类 +.whEw(i
8E"Ik~
&i4*tE3],
Gvw4ot/
四、常见错误4# :自编代码来拷贝数组 u[dR*o0'
Ey=(B'A~
M2_sxibI
.a1WwI
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: ]d}Z2I'
[
/w{,+U
cHs@1R/-s
hS}?"ST|
public class Example{ G2U=*|
private int[] copy; A!No:?S
/*** Save a copy of ’data’. ’data’ cannot be null.*/ }:7'C. ."
public void saveCopy (int[] data){ RxY
;'NY
copy = new int[data.length]; -mOSB(#bo
for (int i = 0; i < copy.length; ++i) "]Wrir?l
copy = data; +^YXqOXU
} E!&A[TlX\
} T>e!DOW;
=0TnH<`
N%%2!Z#
oE[wOq+
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: j<>E
Fd
#ok1qT9_
A&rk5y;
jt?4raNW
void saveCopy (int[] data){ Z;=G5O
uvQ
try{ Lz's!b
copy = (int[])data.clone(); )4>M<BO
}catch (CloneNotSupportedException e){ W'u6F-$2
// Can’t get here. P%
_cIR
} I?LJXo \O
} sx IvL7jl
P?VGY
B*p`e1
\:9dt8(-U
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: 0m7ANqE[Z
9{@[l!]W
m.e+S,i
Q;W[$yvW
static int[] cloneArray (int[] data){ 5drc8_fZ
try{ Ppi/`X
return(int[])data.clone(); QE*O~Yj
}catch(CloneNotSupportedException e){ W~(@*H
// Can’t get here. @^]wT_r
} iz!E1(z(
} NFw7g&1;Kp
v7&oHOk!
4$.$j=Ct."
(? j $n?p
这样的话,我们的saveCopy看起来就更简洁了: k=1([x
f#mBMdj
P1KXvc}JGe
@zo}#.g
void saveCopy (int[] data){ t&}Z~Zp
copy = cloneArray ( data); n " ?It
}
uyBmGS2
[mwJ* GJ-
%;ZWYj`]n
"zFv?ay
五、常见错误5#:拷贝错误的数据 @a-u_|3q
&N4Jpa}w/%
W[Kv
Qt3%
aK>5r^7S
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: ${I$@qq83
Tk~RT<\Ab+
Z3jh-{ 0
'](4g/%
import java.awt.Dimension; EC9D.afy&
/*** Example class. The height and width values should never * be PL vz1}ts
negative. */ $7M/rF;N5X
public class Example{
qkQ_#
static final public int TOTAL_VALUES = 10; i
T* !3
private Dimension[] d = new Dimension[TOTAL_VALUES]; '2)c;/-E
public Example (){ } 1K(a=o[Ce
kg@D?VqJP
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ "p]F q,
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ 2K >tI9);
if (height < 0 || width < 0) zx)^!dEMM
throw new IllegalArgumentException(); ?naPti1GX
if (d[index] == null) 85;hs
d[index] = new Dimension(); Q2^~^'Yk
d[index].height = height; ?t;>]Wo;
d[index].width = width; /rMxl(wD'
} DGfhS` X
public synchronized Dimension[] getValues() x0t&hY