編寫好的面向對象代碼
本文是java.net上的一篇博客,作者Curtis Cooley對編寫好的面向對象代碼有些建議,希望對大家都有所幫助。(2008.10.08最后更新)
獲取經驗沒有捷徑。編寫好的面向對象代碼需要經驗,但這兒有三種做法能幫你在一開始就很順利,即便你是老頑固:
1. 使用測試驅動開發(TDD)編寫你所有的代碼
2. 遵循簡單法則
3. 告之而非問之
使用TDD編寫所有代碼
按測試先行編寫的代碼與按測試后行編寫的代碼是極為不同的代碼。按測試先行編寫的代碼是松耦合與高聚合的。當某個屬性或私有方法需要暴露給測試程序時,按測試后行編寫的代碼常會打破封裝,因為該類并不是為了測試而設計的。如果你首先編寫測試代碼,你的依賴將會更好,你的代碼將是松耦合與高聚合的。后面會有更多關于測試能幫助你設計更佳代碼的內容。
遵循簡單法則
代碼是簡單的,只要當它:
1. 執行了所有的測試
2. 不包含重復
3. 表達了所有的意圖
4. 使用最少的類和方法
注意到我用的是個被排序了的列表是很重要的。順序是重要的。只有一個main()方法的的GodClass[1]不會是簡單的。這個類可能執行了所有的測試,但在任何比"Hello, world!"更復雜的程序中,它肯定包含了重復,并且也沒有表達出全部的意圖。
我努力使用簡單法則去關注If問題。我不知道如何使用簡單法則去阻止某人編寫重量級的If代碼。有人可能會提出不同意見,我也嘗試過,但這樣的重量級If代碼確實無法表達意圖。但當你閱讀如下代碼時
if (mobile.getType() == MobileTypes.STANDARD) {
alert();
}
確實難以看出其中的意圖。這些代碼無論處于哪個方法的上下文環境中,我們都能知道,如果mobile是STANDARD類型的話,那么就報警。而你所需要的更多意圖呢?
我還有一點兒靈感顯現。如果有那樣的代碼,那么在其它地方肯定還會有更多那樣的代碼。這些代碼可能就像:
if (mobile.getType() == MobileTypes.GAS) {
registerGasReading();
}
和
if (mobile.getType() == MobileTypes.TEXT) {
sendTextMessage();
}
和
if (mobile.getType() == MobileTypes.LOCATION) {
notifyLocation();
}
你看出來了嗎?我是看出來了。它違反了規則2,有很多地方都違反了規則2,并且是一種最壞的情形。這段代碼有多處重復。重復將極難發現。所以,請幫助防止這種情形的發生,我已包含其中了。
告之而非問之
簡言之,告之而非問之意指不要先問一個對象的狀態,然后才讓它去工作。而應該告之對象如何去工作。這就意味著之前所有的那些If例子應該變為:
mobile.alert();
和
mobile.registerGasReading();
和
mobile.sendTextMessage();
和
mobile.notifyLocation();
現假設遍布該程序中的一些If語句塊有重復的實現。在"重量級If"版本的程序中,可能很難發現它們;但在"告之而非問之"版本的程序中,所有的實現都在Mobile中。所有的實現都在一處,這就便于察覺并根除問題。
傾聽你的測試程序也能幫助你保持代碼的簡潔。
public interface Alarm {
void alert(Mobile mobile);
}
public class Siren implements Alarm {
public void alert(Mobile mobile) {
if (mobile.getType == MobileTypes.STANDARD) {
soundSiren();
}
}
}
public class TestSiren extends TestCase {
public void test_alert() {
LocationMobile mobile = new LocationMobile();
Siren siren = new Siren();
siren.alert(mobile);
assert(sirenSounded());
}
}
如果你密切地傾聽測試程序,它可能會問你,"為什么你需要一個LocationMobile去測試Siren呢?"的確,為什么呢?看起來,Siren應該還不知道LocationMobile吧。
public class LocationMobile {
private Alarm alarm;
public LocationMobile(Alarm alarm) {
this.alarm = alarm;
}
public void alert() {
alarm.alert(); // alert on Alarm no longer needs a mobile
}
}
public class TestLocationMobile() extends TestCase {
public void test_alert() {
Alarm alarm = EasyMock.createMock(Alarm.class);
alarm.alert();
EasyMock.replay(alarm);
Mobile mobile = new LocationMobile(alarm);
mobile.alert();
EasyMock.verify(alarm);
}
好像我只是交換了依賴關系。Alarm不再依賴Mobile,現在是Mobile依賴Alarm。但如果你仔細地觀察這個測試程序,你會發現真正的依賴關系是,Siren知曉了LocationMobile。一個具體類依賴另一個具體類,這違反了依賴反轉原則(DIP)。第二個例子就讓LocationMobile依賴Alarm接口。具體類依賴抽象,這就滿足DIP了。
如果你使用TDD,并遵循簡單法則和告之而非問之原則去編寫所有的代碼,你就處于成為一個更好的面向對象程序員的道路上了。好的面向對象代碼易于閱讀和維護,但難以編寫,至少,在開始時是這樣的。你寫的越多,你就會變得越好,也會獲得更多的經驗。同時,這些實踐經驗也會使你在自己的道路上受益匪淺。
譯注
[1]GodClass(上帝類)指包含了太多內容的類。