代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 =[)N6XV 3
@aV~.!!
<%3SI.
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 I\uB"Z{9
?"8A^
^
WO(&<(?
g=YiR/O1QN
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 zyp"*0zUr
W6xjqNU
#L IsL
k'I_,Z<,
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 gy,TT<1)
ME10dr
yDkDtO`K
61rh\<bn
一、常见错误1# :多次拷贝字符串 *"QE1Fum'
>5@vY?QXO
})0 7u
PSQ:'
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 `)C`_g3Ew
CpqSn/
$-9@ /%Y
S.F=$z.%
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: (jE:Q2"
wh m tEY
-^jLU
FC
1DlcO>#@
String s = new String ("Text here"); V-ouIqnI
'iISbOM
6j"I5,-~!
hC,-9c
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: nk3<]u
aCi^^}!
pn%|;
TX
[%s@C
String temp = "Text here"; ^YJ^+:D(
String s = new String (temp); ^RyTK|SQ
o`8+#+@f7
/e?ux ~f|
HJ1\FO9\
但是这段代码包含额外的String,并非完全必要。更好的代码为: +$QL0|RL
aLk2#1$g
m3xj5]#^$
j% USu+&
String s = "Text here"; &|\}\+0Z
IZv, Wo
S1= JdN
9PGR#!!F$
二、常见错误2#: 没有克隆(clone)返回的对象 - QI`npsnV
lvJ{=~u
g#%FY1xp
@gjdyz
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: f uNXY-;
DD$Pr&~=
1LIV/l^}f
Cl.T'A$
import java.awt.Dimension; =egi?Ne
/***Example class.The x and y values should never*be negative.*/ N_k6UA9
public class Example{ })SdaZ
private Dimension d = new Dimension (0, 0); qq_,"~
public Example (){ } $(L7/M
"3 oU
(RA
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ UYrzsUjg&
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ ^QQNJ
if (height < 0 || width < 0) w]-iM
throw new IllegalArgumentException(); Z:$b)+2:\
d.height = height; vl~
d.width = width; ~%:p_td
} A y[L{!)2{
G5f57F
public synchronized Dimension getValues(){ sLqvDH?V
// Ooops! Breaks encapsulation B]F7t4Y!
return d; z ;Nk& <?
} Vot+gCZ
} $[CA#AXE
&E`Z_}~
32P ]0&_O
1+}Ud.v3VW
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: Bic {
H
swL|Ff`$
X2?_lZ[\
n1(X%%2
Example ex = new Example(); ymX,k|lh
Dimension d = ex.getValues(); :Ia&,;Gc
d.height = -5; 6|cl`}g_j
d.width = -10; S5a<L_
NP*0WT_gB
M?zAkHNS$
-JK4-Hg
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 ta.,4R&K
1tz .e\
R_n-&d'PP
2<@!m@
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 Qo *]l_UO;
pPpnO
ITlkw~'G
toJ&$HrE
更好的方式是让getValues()返回拷贝: {U-EBXV
}h6z&:qA[?
AI; =k
F
&}V65
public synchronized Dimension getValues(){ ~U+'3.Wo
return new Dimension (d.x, d.y); 0|;=mYa4M
} 8:fiO|~%
K.m[S[cy
U~t(YT
cpnwx1q@
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 ,m]q+7E
6|}mTG^
b.;}Hq>
]!:Y]VYN)\
三、常见错误3#:不必要的克隆 rtE,SN
h
cXqg
B{ "<\g
.p>8oOp
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: nTKfwIeg5
=>*N W9c
rSn7(3e4^
q8>Q,F`BA
/*** Example class.The value should never * be negative.*/ |Wk
G='02
public class Example{ <-}\V!@E!
private Integer i = new Integer (0); C ,hsr
public Example (){ } vrbh+
e*H$c?7NL
/*** Set x. x must be nonnegative* or an exception will be thrown*/ Din)5CxFX
public synchronized void setValues (int x) throws IllegalArgumentException{ K^\9R
if (x < 0) 'DQyB`V2y
throw new IllegalArgumentException(); pASVnXJZ
i = new Integer (x); n\Ixv
} S
&u94hlC
m.1BLN[9
public synchronized Integer getValue(){ i>2_hn_UR
// We can’t clone Integers so we makea copy this way. g"Bv!9*H
return new Integer (i.intValue()); !d(V7`8
} eVXbYv=gJ@
} idy:Jei}
y9)",G!
^ BKr0~4A
sN2l[Ous
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 *cI Xae^Y7
+)SX
z, [+
{AUEVt
方法getValue()应该被写为: )K~nZLULY
]mA?TwD
U w"
A4' aB0^
public synchronized Integer getValue(){ @jKB!z9{
// ’i’ is immutable, so it is safe to return it instead of a copy. (.o'1'
return i; Kq$1lPI
}
N=9lA0y+
Cq~Ir*"
6bba}P
LKcrr;
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: UhK,H
:xCobMs_/
ny=iAZM>q
F1>,^qyG6
?Boolean ^ a:F*<D
?Byte kx[8#+P
?Character E<dN=#f6
?Class &&O=v]6,V
?Double *Y Ox`z!R
?Float \`C3;}o:"P
?Integer Ek3O{<
?Long x5ia<V>=d
?Short 2+PIZ6=hN
?String 0P(}e[~Z
?大部分的Exception的子类 M_K&x-H0
1o%Hn"uG
. {I7sUQ
nj
mE>2
四、常见错误4# :自编代码来拷贝数组 7Y/_/t~Y
qM+T Wp
8@-US ,|
A7H=#L+C
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: R9(^CWs
-|mABHjx*
*?{)i~
$`%.Y&A
public class Example{ /l
L*U
private int[] copy; |UG)*t/
/*** Save a copy of ’data’. ’data’ cannot be null.*/ Cb.Aw!
public void saveCopy (int[] data){ fJuJ#MX{:
copy = new int[data.length]; JFfx9%Fq
for (int i = 0; i < copy.length; ++i) lxZXz JkqZ
copy = data; dIm m},
} #7{a~-S
} b11C3TyQT
*RPI$0
zw?6E8$h
M4| L
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: Sc&_6}K
S:gP\Atf>
# V+e
!SnpesTn
void saveCopy (int[] data){ 8Ex0[e
try{ bTj,5,8i
copy = (int[])data.clone(); eIJQ|p<v
}catch (CloneNotSupportedException e){ vJ!t.Vou
// Can’t get here. R-ci?7d t3
} C}CX n X
} R##O9BSI8Z
y03l_E,
HM/ qB^
;\h'A(
如果你经常克隆数组,编写如下的一个工具方法会是个好主意: 8g\.1<~
_>s.V`N'
Ab`G b
#ed]zI9O
static int[] cloneArray (int[] data){ 6*$N@>8&
try{ _wIAr
return(int[])data.clone(); AWw'pgTQX
}catch(CloneNotSupportedException e){ Lxl?6wZ
// Can’t get here. (U)=t$=o
} XIU2l}g
} lG2){){j
&A~ 1Q#4
n}2}4^
Rzp-Q5@MY
这样的话,我们的saveCopy看起来就更简洁了: p~t$ll0s
rie1F,
\C#Vh7z"2&
]BA8[2=m
void saveCopy (int[] data){ '2NeuK -KD
copy = cloneArray ( data); --FvE|I
} yDPek*#^"q
'?\Hm'8
xed$z
@_;6L
五、常见错误5#:拷贝错误的数据 uaiG(O
PqfH}d0l
pcE.
gbvBgOp
有时候程序员知道必须返回一个拷贝,但是却不小心拷贝了错误的数据。由于仅仅做了部分的数据拷贝工作,下面的代码与程序员的意图有偏差: t^q/'9Ai&J
`| fF)kI
FkH4|}1
l!
GPOmf9`
import java.awt.Dimension; aD.A +e s
/*** Example class. The height and width values should never * be kY|<1Ht
negative. */ bp }~{]:b
public class Example{ 17-K~ybc
static final public int TOTAL_VALUES = 10; mV-MJ$3r
private Dimension[] d = new Dimension[TOTAL_VALUES]; Ba"Z^(:
public Example (){ } t ,0~5>5
g%K3ah
v
/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */ JWLQ9UX
public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{ ;lGjj9we>
if (height < 0 || width < 0) c Mq|`CM
throw new IllegalArgumentException(); iKu5K0x{>I
if (d[index] == null) {L#Pdj{
d[index] = new Dimension(); h>4\I;Ij
d[index].height = height; XWkYhTaY
d[index].width = width; HR4^+x
} Ax&+UxQ0|
public synchronized Dimension[] getValues() 4]Krx
m`8
throws CloneNotSupportedException{ C@xh$(y
return (Dimension[])d.clone(); 86[TBX5'
} TtHqdKL
} o_?YYw-:
-q[?,h
7uYJ_R
3iDRt&y=.
这儿的问题在于getValues()方法仅仅克隆了数组,而没有克隆数组中包含的Dimension对象,因此,虽然调用者无法改变内部的数组使其元素指向不同的Dimension对象,但是调用者却可以改变内部的数组元素(也就是Dimension对象)的内容。方法getValues()的更好版本为: WO|#`HM2
a4c~ThbI
*edB3!!
ondF
public synchronized Dimension[] getValues() throws CloneNotSupportedException{ nP] ~8ViS
Dimension[] copy = (Dimension[])d.clone(); 'En 6h" {
for (int i = 0; i < copy.length; ++i){ t'^/}=c-
// NOTE: Dimension isn’t cloneable. ]2?t$"G8
if (d != null) hS<+=3
<M
copy = new Dimension (d.height, d.width); %|UCs8EFm
} (R{WJjj
return copy; )nQ.6
} `w2hJP
90;[5c
}.x?$C+\"
a(F%M
在克隆原子类型数据的多维数组的时候,也会犯类似的错误。原子类型包括int,float等。简单的克隆int型的一维数组是正确的,如下所示: A%pcPzG;
{@k5e)
Q
K"eW.$
QD<f)JZK
public void store (int[] data) throws CloneNotSupportedException{ /mmCqP
this.data = (int[])data.clone(); |[8&5[);
// OK "Q^Ck7
} '(;`t1V8k
rlgp1>89
LEG
y1L
p"w"/[8
拷贝int型的二维数组更复杂些。Java没有int型的二维数组,因此一个int型的二维数组实际上是一个这样的一维数组:它的类型为int[]。简单的克隆int[][]型的数组会犯与上面例子中getValues()方法第一版本同样的错误,因此应该避免这么做。下面的例子演示了在克隆int型二维数组时错误的和正确的做法: Ye T[KjX
phd,Jg[
5EM(3eY ^q
s~,Y po?
public void wrongStore (int[][] data) throws CloneNotSupportedException{ K%.\@l2Cp
this.data = (int[][])data.clone(); // Not OK! ]JbGP{UiN
} 9%pq+?u9
public void rightStore (int[][] data){ c5pF?kFaD
// OK! &0~E+
9b
this.data = (int[][])data.clone(); 8e x{N3
for (int i = 0; i < data.length; ++i){ Hr:WE+'
if (data != null) LNtBYdB`pK
this.data = (int[])data.clone(); iCnKQG
}
LGV"WE
} VD,g
n)gzHch
) m[0,
$)mK]57
ckS.j)@.c
六、常见错误6#:检查new 操作的结果是否为null -m3O\X
V0XQG}
ng"R[/)In
Jc95Ki1X
Java编程新手有时候会检查new操作的结果是否为null。可能的检查代码为: ;kDz9Va
8A#qbBD
|#>\GU=!
u?i_N0H
Integer i = new Integer (400); IOtSAf
if (i == null) '(r/@%=U
throw new NullPointerException(); !K'j[cA^
P;C3{>G9
h,"K+$
LY(YgqL
检查当然没什么错误,但却不必要,if和throw这两行代码完全是浪费,他们的唯一功用是让整个程序更臃肿,运行更慢。 W{<_gD9
(
$A0b
mr&nB
gs7h`5[es
C/C++程序员在开始写java程序的时候常常会这么做,这是由于检查C中malloc()的返回结果是必要的,不这样做就可能产生错误。检查C++中new操作的结果可能是一个好的编程行为,这依赖于异常是否被使能(许多编译器允许异常被禁止,在这种情况下new操作失败就会返回null)。在java 中,new 操作不允许返回null,如果真的返回null,很可能是虚拟机崩溃了,这时候即便检查返回结果也无济于事。 9Ra*bP ]1
>{C=\F#*L
七、常见错误7#:用== 替代.equals E<y0;l?H<
c 2t<WRG
在Java中,有两种方式检查两个数据是否相等:通过使用==操作符,或者使用所有对象都实现的.equals方法。原子类型(int, flosat, char 等)不是对象,因此他们只能使用==操作符,如下所示: `7[z%cuK
@i U@JE`C
fMgB!y"Em
2dg+R)%
int x = 4; yhxen
int y = 5; FxeDjAP
if (x == y) ;6P#V`u
System.out.println ("Hi"); q$x$ 4
// This ’if’ test won’t compile. X: PB
}
if (x.equals (y)) LX;w~fRr.
System.out.println ("Hi"); 7L)edR[
Xfo3fW)s
RvrZtg5
'Km
~3t
对象更复杂些,==操作符检查两个引用是否指向同一个对象,而equals方法则实现更专门的相等性检查。 rKxIOJ ,T
~QzUQYG*
A@M%}h
trlZ ^K
更显得混乱的是由java.lang.Object 所提供的缺省的equals方法的实现使用==来简单的判断被比较的两个对象是否为同一个。 @/jLN
~xfoZiIA}
Zcst$Aro
uzG{jc^
许多类覆盖了缺省的equals方法以便更有用些,比如String类,它的equals方法检查两个String对象是否包含同样的字符串,而Integer的equals方法检查所包含的int值是否相等。 z 3((L
{P/ sxh:e
RgTm^?Ex
2yB)2n#ut
大部分时候,在检查两个对象是否相等的时候你应该使用equals方法,而对于原子类型的数据,你用该使用==操作符。 [=/Yo1:v
^hL?.xj
$FR1^|P/G
3%HF" $Gg
八、常见错误8#: 混淆原子操作和非原子操作 EY+/
foP
j:k}6]p}
kD"BsL*6!
fyHFfPEE
Java保证读和写32位数或者更小的值是原子操作,也就是说可以在一步完成,因而不可能被打断,因此这样的读和写不需要同步。以下的代码是线程安全(thread safe)的: NWL\"xp
`t
m 0jm$>:Z
Q#gzk%jL@
<d*;d3gm
public class Example{ WxE^S ??|
private int value; // More code here... 3jeB\
public void set (int x){ s}1S6*Cr
// NOTE: No synchronized keyword [l`_2{:
this.value = x; ^jph"a C
} g#W/WKvM
} S{uKm1a
[nYm-\M
uDe%M
T{A5,85
不过,这个保证仅限于读和写,下面的代码不是线程安全的: Ire+r
"am
A,H|c="
9sQ#v-+Yx
J`I^F:y*
public void increment (){ <]w(1{q(
// This is effectively two or three instructions: }Cs.Hm0P
// 1) Read current setting of ’value’. = n>aJ(=Pd
// 2) Increment that setting. ( M$2CL
// 3) Write the new setting back. 6Wn"h|S
++this.value; I38j[Xk
} $T#yxx
@3aI7U/I
<i1.W!%
<