审查Java 代码的十一种常见错误
来源:网络 更新时间:2014-12-3
代码审查是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。本文就常见的Java代码中容易出现的问题提出一些建设性建议,以便您在审查代码的过程中注意到这些常见的细节性错误。
通常给别人的工作挑错要比找自己的错容易些。别样视角的存在也解释了为什么作者需要编辑,而运动员需要教练的原因。不仅不应当拒绝别人的批评,我们应该欢迎别人来发现并指出我们的编程工作中的不足之处,我们会受益匪浅的。
正规的代码审查(codeinspection)是提高代码质量的最强大的技术之一,代码审查—由同事们寻找代码中的错误—所发现的错误与在测试中所发现的错误不同,因此两者的关系是互补的,而非竞争的。
如果审查者能够有意识地寻找特定的错误,而不是靠漫无目的的浏览代码来发现错误,那么代码审查的效果会事半功倍。在这篇文章中,我列出了11个Java编程中常见的错误。你可以把这些错误添加到你的代码审查的检查列表(checklist)中,这样在经过代码审查后,你可
以确信你的代码中不再存在这类错误了。
常见错误1#:多次拷贝字符串
测试所不能发现的一个错误是生成不可变(immutable)对象的多份拷贝。不可变对象是不可改变的,因此不需要拷贝它。最常用的不可变对象是String。
如果你必须改变一个String对象的内容,你应该使用StringBuffer。下面的代码会正常工作:
Strings=newString("Texthere");
但是,这段代码性能差,而且没有必要这么复杂。你还可以用以下的方式来重写上面的代码:
Stringtemp="Texthere";
Strings=newString(temp);
但是这段代码包含额外的String,并非完全必要。更好的代码为:
Strings="Texthere";
常见错误2#:没有克隆(clone)返回的对象
封装(encapsulation)是面向对象编程的重要概念。不幸的是,Java为不小心打破封装提供了方便——Java允许返回私有数据的引用(reference)。下面的代码揭示了这一点:
importjava.awt.Dimension;
/***Exampleclass.Thexandyvaluesshouldnever*benegative.*/
publicclassExample{
privateDimensiond=newDimension(0,0);
publicExample(){}
/***Setheightandwidth.Bothheightandwidthmustbe
nonnegative*oranexceptionisthrown.*/
publicsynchronizedvoidsetValues(intheight,intwidth)
throwsIllegalArgumentException{
if(height<0||width<0)
thrownewIllegalArgumentException();
d.height=height;
d.width=width;
}
publicsynchronizedDimensiongetValues(){
//Ooops!Breaksencapsulation
returnd;
}
}
Example类保证了它所存储的height和width值永远非负数,试图使用setValues()方法来设置负值会触发异常。不幸的是,由于getValues()返回d的引用,而不是d的拷贝,你可以编写如下的破坏性代码:
Exampleex=newExample();
Dimensiond=ex.getValues();
d.height=-5;
d.width=-10;
现在,Example对象拥有负值了!如果getValues()的调用者永远也不设置返回的Dimension对象的width和height值,那么仅凭测试是不可能检测到这类的错误。
不幸的是,随着时间的推移,客户代码可能会改变返回的Dimension对象的值,这个时候,追寻错误的根源是件枯燥且费时的事情,尤其是在多线程环境中。
更好的方式是让getValues()返回拷贝: