代碼審查是消滅Bug最重要的方法之一,這些審查在大多數時候都非凡奏效。由于代碼審查本身所針對的對象,就是俯瞰整個代碼在測試過程中的問題和Bug。并且,代碼審查對消除一些非凡細節的錯誤大有裨益,尤其是那些能夠輕易在閱讀代碼的時候發現的錯誤,這些錯誤往往不輕易通過機器上的測試識別出來。本文就常見的java代碼中輕易出現的問題提出一些建設性建議,以便您在審查代碼的過程中注重到這些常見的細節性錯誤。
通常給別人的工作挑錯要比找自己的錯輕易些。別樣視角的存在也解釋了為什么作者需要編輯,而運動員需要教練的原因。不僅不應當拒絕別人的批評,我們應該歡迎別人來發現并指出我們的編程工作中的不足之處,我們會受益匪淺的。
正規的代碼審查(code inspection)是提高代碼質量的最強大的技術之一,代碼審查—由同事們尋找代碼中的錯誤—所發現的錯誤與在測試中所發現的錯誤不同,因此兩者的關系是互補的,而非競爭的。
假如審查者能夠有意識地尋找特定的錯誤,而不是靠漫無目的的瀏覽代碼來發現錯誤,那么代碼審查的效果會事半功倍。在這篇文章中,我列出了11個Java編程中常見的錯誤。你可以把這些錯誤添加到你的代碼審查的檢查列表(checklist)中,這樣在經過代碼審查后,你可以確信你的代碼中不再存在這類錯誤了。
一、常見錯誤1# :多次拷貝字符串
測試所不能發現的一個錯誤是生成不可變(immutable)對象的多份拷貝。不可變對象是不可改變的,因此不需要拷貝它。最常用的不可變對象是String。
假如你必須改變一個String對象的內容,你應該使用StringBuffer。下面的代碼會正常工作:
String s = new String ("Text here");
但是,這段代碼性能差,而且沒有必要這么復雜。你還可以用以下的方式來重寫上面的代碼:
String temp = "Text here";
String s = new String (temp);
但是這段代碼包含額外的String,并非完全必要。更好的代碼為:
String s = "Text here";
二、常見錯誤2#: 沒有克隆(clone)返回的對象
封裝(encapsulation)是面向對象編程的重要概念。不幸的是,Java為不小心打破封裝提供了方便——Java答應返回私有數據的引用(reference)。下面的代碼揭示了這一點:
import java.awt.Dimension;
/***Example class.The x and y values should never*be negative.*/
public class Example{
PRivate Dimension d = new Dimension (0, 0);
public Example (){ }
/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/
public synchronized void setValues (int height,int width) throws IllegalArgumentException{
if (height < 0 width < 0)
throw new IllegalArgumentException();
d.height = height;
d.width = width;
}
public synchronized Dimension getValues(){
// Ooops! Breaks encapsulation
return d;
}
}
Example類保證了它所存儲的height和width值永遠非負數,試圖使用setValues()方法來設置負值會觸發異常。不幸的是,由于getValues()返回d的引用,而不是d的拷貝,你可以編寫如下的破壞性代碼:
Example ex = new Example();
Dimension d = ex.getValues();
d.height = -5;
d.width = -10;
現在,Example對象擁有負值了!假如getValues() 的調用者永遠也不設置返回的Dimension對象的width 和height值,那么僅憑測試是不可能檢測到這類的錯誤。
不幸的是,隨著時間的推移,客戶代碼可能會改變返回的Dimension對象的值,這個時候,追尋錯誤的根源是件枯燥且費時的事情,尤其是在多線程環境中。
更好的方式是讓getValues()返回拷貝:
public synchronized Dimension getValues(){
return new Dimension (d.x, d.y);
}
現在,Example對象的內部狀態就安全了。調用者可以根據需要改變它所得到的拷貝的狀態,但是要修改Example對象的內部狀態,必須通過setValues()才可以。
新聞熱點
疑難解答