Contracts是什麼? 在Java中, interface是最常用的設計, 問題是, 給了interface卻無法確定使用interface的程式設計師的設計品質, 這是因為interface只是定義功能與其輸入與輸出, 因此, 不佳的程式設計可能會被暫時隱藏, 卻像個不定時炸彈, 不知在那一隻不斷引用的程式中出問題, 為了能夠確保關鍵的商業邏輯不至處在此種風險之下, 就使用了abstract class來檢查輸入與輸出, 也就犧牲了低耦合的能力了. 這個問題困擾了我很久, 以為沒有特別的方法, 昨日看到了contracts的觀念, 今天又看到了google釋出contracts元件http://code.google.com/p/cofoja/, 發現竟然可以在interface來註記(annotation), 這是java從http://www.eiffel.com/學來的強大功能, 這個功能看起來好像很高深, 在這裡分享的目的是希望初學Java的邦友可以在一開始的階段就使用contracts, 因為這是優質程式設計的習慣.
就拿google上的範例來說明:
interface Time {
...

@Ensures({
"result >= 0",
"result <= 23"
})
int getHour();

@Requires({
"h >= 0",
"h <= 23"
})
@Ensures("getHour() == h")
void setHour(int h);

...
}

未使用contracts的可能長這樣
interface Time {
...

/** 取得時間的小時
* @return 小時, 請確認取得的值是0到23的整數.
*/
int getHour();

/** 設定時間的小時
* @param h 一個0到23的正整數. 和getHour()取得的值一樣.
*/
void setHour(int h);

...
}

差別在哪? 我可以用contracts透過annotation將商業邏輯加在interface中, 如果程式設計師犯了錯, 就可以很精確的揪出錯誤在哪了. 請注意, 雖然這程式碼看起來可以檢查輸入輸出是否正確, 但是contracts不是用來檢查輸入輸出是否正確, 而是用來檢驗程式設計的錯誤, 這是很重要的觀念.

20110211T1340:
再用另一個例子:
/**
* @param left a sorted list of elements
* @param right a sorted list of elements
* @return the contents of the two lists, merged, sorted
*/
List merge(List left, List right);

以往, 在comment的地方"寫得"很清楚, 但是呢, 人有惰性, 每個人的實力都不同, 傳進來的和回傳的都可能疏忽. 用了contracts, 改成這樣:

@Requires({
"Collections.isSorted(left)",
"Collections.isSorted(right)"
})
@Ensures({
"Collections.containsSame(result, Lists.concatenate(left, right))",
"Collections.isSorted(result)"
})
List merge(List left, List right);

不僅清楚的說明了left, right和回傳值的條件, 也實際以程式控制了這些條件, 看起來像是unit testing的一種功能, 但是unit testing是在測methods, 而contracts是在interface的, unit testing要對所有的implementations去測, contracts則在interface就管控了品質, 再者, contracts是透過javaagent參數調用的, 關掉javaagent就不會有任何影響.