代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。 ]REF1<)4z
: 9>U+)%
W$D:mw7
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。 qssK0!-
uXGAcUx(
2R3)/bz-SV
_>t6]?*
正规的代码审查(code inspection)是提高代码质量的最强大的技术之一,代码审查?由同事们寻找代码中的错误?所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。 EUPc+D3
1NN#-U
+I.{y
p{0rHu[
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可以确信你的代码中不再存在这类错误了。 tg2+Z\0)4g
`Z@qWB<
)\izL]=!t
0e'@Xo2e
一、常见错误1# :多次拷贝字符串 P>]*pD
M"OCwBTU
0n?^I>j
I^``x+a
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。 qHYoQ.ke
jpiBHi]5+
SUoUXh^!w
Ez^wK~
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作: 40;4=
w[;5]z
>\1j`/ :ZI
5q}7#{A
String s = new String ("Text here"); `jGG^w3
bqZ5GKUo
_/}/1/y$Y
_$gP-J
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码: _GL:4
Gl>*e|}
F*,RDM'M
@_"Z]Y ,D0
String temp = "Text here"; " ,45p@
String s = new String (temp); ]6?6 k4@
= iWn
T
gp]T.ol
U!524"@%U`
但是这段代码包含额外的String,并非完全必要。更好的代码为: lMb&F[KJ7
Wtj*Z.=:
J+Zp<Wu-
^" UZ.@sq'
String s = "Text here"; 1>_2 =^[
p y%RR*4#
;v%f +
.arWbTR)~U
二、常见错误2#: 没有克隆(clone)返回的对象 >B+!fi'SS>
t`"pn<
*skmTioj&
QWAtF@qTV
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便??Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点: )SWLX\b
,uCgC4EP
j4]y(AA
v4X)R
"jJ
import java.awt.Dimension; !,cfA';S
/***Example class.The x and y values should never*be negative.*/ a/lTQj]A
public class Example{ )s>R~7
private Dimension d = new Dimension (0, 0); Pbl#ieZM
public Example (){ } yey]#M[y
")eY{C
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/ {1J4Q[N9m
public synchronized void setValues (int height,int width) throws IllegalArgumentException{ %"BJW
if (height < 0 || width < 0) ?4YLt|sn
throw new IllegalArgumentException(); klx28/]
d.height = height; o6)U\z
d.width = width; Apc!!*7
} &[y+WrGG
`-w;/A"MJ
public synchronized Dimension getValues(){ F0/!+ho
// Ooops! Breaks encapsulation ~r?VXO p"
return d; JO&L1<B{v
} ]q 3.^F
} :r}C&3
&/-}`hIAT
;><m[ l6
sff4N>XAl<
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码: L4or*C^3
cSYMnB
J1@skj4#\~
`{9bf)vP6
Example ex = new Example(); [Lq9lw&
Dimension d = ex.getValues(); kt7x}F(?<
d.height = -5; )w,<XJhg`
d.width = -10; #N;McF;W
Ar'k6NX
'C)
v?!19
qpV"ii
现在,Example对象拥有负值了!如果getValues() 的调用者永远也不设置返回的Dimension对象的width 和height值,那么仅凭测试是不可能检测到这类的错误。 [Z;ei1l
e@7UL|12
eD!mR3Ai@D
f-Zi!AGh>
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。 ~{-9qOGw;
%{ory5
z['2
4|;Ys-Q
更好的方式是让getValues()返回拷贝: 1H \
5:(/k\9+yv
>35W{d
<."KejXg-
public synchronized Dimension getValues(){ U<<XeSp
return new Dimension (d.x, d.y); ZP'0=
} ]Hg6Mz>Mj
U'@ ![Fp
(#8B
&cwN&XBY
现在,Example对象的内部状态就安全了。调用者可以根据需要改变它所得到的拷贝的状态,但是要修改Example对象的内部状态,必须通过setValues()才可以。 n0g8B
izs=5
RoNE7|gF:
_{$<s[S
三、常见错误3#:不必要的克隆 [,(+r7aB
AkCy
C1
AG><5 }
3n~O&{
我们现在知道了get方法应该返回内部数据对象的拷贝,而不是引用。但是,事情没有绝对: 5+yy:#J]
Z<,Hz+
=\G`g#
#x`K4f)
/*** Example class.The value should never * be negative.*/ H!'4A&
public class Example{ 29cx(
private Integer i = new Integer (0); %+/Dv
public Example (){ } >Y(JC#M;
o`G6!
/*** Set x. x must be nonnegative* or an exception will be thrown*/ E\TWPV'/
public synchronized void setValues (int x) throws IllegalArgumentException{ r6GXmr
if (x < 0) =cO5Nt
throw new IllegalArgumentException();
En)Ptz#0
i = new Integer (x); c\/-*OYr<
} K+"3He
X}Om)WCr
public synchronized Integer getValue(){ 4ETHaIiWp
// We can’t clone Integers so we makea copy this way. Y`d@4*FN$
return new Integer (i.intValue()); 6lT< l zT
} \iaZV.#f
} 3iUJ!gK
g/}d> 6
MV2$0
9yaTDxB>
这段代码是安全的,但是就象在错误1#那样,又作了多余的工作。Integer对象,就象String对象那样,一旦被创建就是不可变的。因此,返回内部Integer对象,而不是它的拷贝,也是安全的。 ?8/r=
Nu3gkIz5z-
-v-kFzu
#!E`%'
s]
方法getValue()应该被写为: 8:)[.
ycSGv4
)
TspX7<6r
E)`0(Z:E
public synchronized Integer getValue(){ Vr Lp5?Bh
// ’i’ is immutable, so it is safe to return it instead of a copy. LT>_Y`5>
return i; :y`LF<
} s.rQiD
:Zkjtr.\
[tSv{
D4(73
Java程序比C++程序包含更多的不可变对象。JDK 所提供的若干不可变类包括:
^_3$f
%%n&z6w