代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 "@Ra>qb
.(VxeF(v_k
#E5Sc\,
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 aN).G1
D}HW7Hnu^
SY`NZJK
$7jJV (B
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 Mto3Ryic!
K*'(;1AiW
NAZxM9
_T6WA&;8
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 7Nh6 `
P}~6yX
G<4H~1?P
:)g=AhBF
一、常见错误1# :多次拷贝字符串 2!~j(_TA
IJD'0/R'c
NVS U)#
8 fVI33
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。
4sSQ
nK
}LM^>M%
1zGEf&rv:
kej@,8
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: 16ke CG\
-/~^S]
}z,4IHNn
+&O[}%W
String s = new String ("Text here"); O#H `/z
@_FL,AC&m
!
D'U:)
r1}OlVbK
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: x,2+9CCU
?fnJ`^|-r
H[*.Jd
)qn
=
String temp = "Text here"; hK@1
s
String s = new String (temp); *Mg=IEu-6[
s+yBxgQ/
>Hic
tH
:&2RV_$>=
但是这段代码包含额外的String,并非完全必要。更好的代码为: aPcO9
gpHI)1i'H
(vz)GrH>
+{]/
b%P
String s = "Text here"; }f^K}*sK$5
)!|K3%9
)}~k7bb}Y
T d4 /3k
二、常见错误2#: 没有克隆(clone)返回的对象 |; $fy-
6b-d#H/1Y
"0`r]5 5d
8$v17 3
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: UmiW_JB
m1]rLeeEt
7T_g?!sdMh
H^K(1
import java.awt.Dimension; BG-uKJ ^
/***Example class.The x and y values should never*be negative.*/ xPQO}wKa
public class Example{ <rRmbFH#
private Dimension d = new Dimension (0, 0); <C+:hsS=
public Example (){ } V/"0'H\"1
M[Y|$I}
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ +3si=x\=/
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ @r+ErFI
if (height < 0 || width < 0) 9s73mu`Twg
throw new IllegalArgumentException(); g}ciG!0
d.height = height; z|+L>O-8
d.width = width; q,aWF5m@
} wh|[
"U('
!ye%A&
public synchronized Dimension getValues(){ r$k
*:A$%
// Ooops! Breaks encapsulation P:(,l,}F8
return d; YwoytoXK
} r5lp<md
} Z>o;Yf[
0z#+^
#Sb1oLC
[%P_
Y/
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: 4mNL;O
%3fHitCikc
m`nv4 i#o
9S=9m[#y'
Example ex = new Example(); ou,W|<%
Dimension d = ex.getValues(); oUltr
d.height = -5; -7m;rD4J
d.width = -10; zrnc~I+
asPD>j c
,_\h)R_
1;.}u=8
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 uZ<Bfrc
^h^j:!76j
iLv"ZqGrw
YJrK oK}
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 OjrQ[`(E
,A[HYc|uy
#z~D1Zl
rrbCg(
更好的方式是让getValues()返回拷贝: Cv;z^8PZJz
Z U
f<s?
F^A1'J
b$rBxe\
public synchronized Dimension getValues(){ O}#*U+j
return new Dimension (d.x, d.y); ELY$ ]^T
} .!)7x3|$[
-bo0!@MK
-#rFCfPy^
nqiy)ZN#R
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 ;qG a|`#j
DU}q4u@)
Fo~C,@/Qt
Ij#%Qu
三、常见错误3#:不必要的克隆 e5veq!*C?
Ix1ec^?f
LNg[fF^:
2uiiTg>
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: #i)h0ML/e
v[F_r
4:6@9.VVT
8&`s wu&
/*** Example class.The value should never * be negative.*/ 8MW|CM4Q
public class Example{ 3@6f%Dyj
private Integer i = new Integer (0); K")-P9I6-f
public Example (){ } !H?#~{
W}
d*q_DV
/*** Set x. x must be nonnegative* or an exception will be thrown*/ 0{A VH/S
public synchronized void setValues (int x) throws IllegalArgumentException{ 7p u*/W~
if (x < 0) {wA@5+[
throw new IllegalArgumentException(); "8{u_+_B*
i = new Integer (x); 6pr}A
} o Q{gh$6*
b%|%Rek8
public synchronized Integer getValue(){ &Hh%pY"
// We can’t clone Integers so we makea copy this way. eDTEy;^o
return new Integer (i.intValue()); rl4daV&,U
} ?bN8h)>QQ8
} 8iX?4qj{P
$7|0{Dw
m0=CD
=>S5}6
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 O- r"G
)G*Hl^Z;4
if^\Gs$
B;7L:
方法getValue()应该被写为: {u9VHAXCf
_Vp9Y:mX2
B.&q]CAv-
W0gaOew(^
public synchronized Integer getValue(){ 3(FJ<,"D}
// ’i’ is immutable, so it is safe to return it instead of a copy. 7CwG(c/5
return i; M^g"U`
} ,gkxZ{Eh
"v^Q
!
Z;??j+`Eo
PlBT
H
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括: Z8nNZ<k
\[Rh\v&
u-j Gv| ,|
H;IG\k6C
?Boolean Ij{{Z;o3
?Byte h'kgL~+$
?Character J. {[>
?Class =b !f
?Double {!6!z,
?Float P9Rq'u
?Integer JH<q7Y6!y
?Long pBmacFP
?Short n%Nf\z
?String H={fY:%
?大部分的Exception的子类 yrkd#m
"C}nS=]8m
oOQnV(I
dsJ}C|N
四、常见错误4# :自编代码来拷贝数组 )t@OHSl
Y@#~8\_
,:;nq> ;
JLc\KVmF
Java允许你克隆数组,但是开发者通常会错误地编写如下的代码,问题在于如下的循环用三行做的事情,如果采用Object的clone方法用一行就可以完成: Ep?a1&b
:
<m0
GG
.;*0odxv
(Rs<'1+>
public class Example{ d![EnkyL;
private int[] copy; .hT^7|Jz[
/*** Save a copy of ’data’. ’data’ cannot be null.*/ hQHV]xW
public void saveCopy (int[] data){ Vs9fAAXS4
copy = new int[data.length]; nQ/(*d
for (int i = 0; i < copy.length; ++i) CEI#x~Oq
copy = data; rQ~%SUM7
} c5O1h8
} HM ^rk
EeL~`$f
c;wt9J.f
KOwEw~
这段代码是正确的,但却不必要地复杂。saveCopy()的一个更好的实现是: :vV?Yv%P)n
i,b>&V/Y$
%T1(3T{Li
^"*r'
void saveCopy (int[] data){ &