異常行為
前面給出的行為規範要求調用peek() 和 pop()方法時隊列不可為空,但其實當隊列空時是有可能會調用這兩個方法的。如果發生這種情況,這兩個方法就會拋出一個NoSuchElementException.異常。我們必須修正我們前面制定的行為規範,允許這種可能的發生。在這種情況下,我們要使用JML的exceptional_behavior語句。
到目前,我們的行為規範還是以public normal_behavior打頭的。這裡normal_behavior關鍵字表示這是一個正常行為,方法不會拋出任何異常。使用public exceptional_behavior標記可以用來描述拋出異常的行為。下面的程式碼片段顯示了類PriorityQueue中peek()方法的行為規範中的異常部分:
程式碼片段9 exceptional_behavior標記
/*@
@ public normal_behavior
@ requires ! isEmpty();
@ ensures elementsInQueue.has(esult);
@ also
@ public exceptional_behavior
@ requires isEmpty();
@ signals (Exception e) e instanceof NoSuchElementException;
@*/
/*@ pure @*/ Object peek() throws NoSuchElementException;
像我們前面看到的所有例子一樣,這個規範的第一部分也是以public normal_behavior開頭,表示正常行為;不同的是,這個規範還有第二部分,以public exceptional_behavior開頭,描述了異常行為。與normal_behavior 語句一樣, exceptional_behavior 語句也有一個 requires 語句。這個requires 語句表示當拋出signals 語句中所列的異常時必須滿足的條件。在上面的例子中,如果isEmpty()方法返回真的話,peek()就會拋出一個NoSuchElementException異常。
signals 語句
signals 語句是形如signals(E e) R的語句,其中E是Exception類本身或其一個子類,R是一個運算式。JML 用如下方式解釋一個signal 語句:如果有一個類型為E的異常拋出的話,就檢查是否為R真。如果是,就執行既定規範;否則,拋出一個unchecked exception(譯者註:unchecked exception又叫做RuntimeException,關於這兩個概念,請參考Java語言中關於異常的描述),用以表示我們的程式碼違背了exceptional_behavior規範的要求。
上面peek()方法中的signals語句的意思是如果隊列為空白,就拋出一個NoSuchElementException異常。如果peek()方法在運行中拋出不是NoSuchElementException的其它異常的話,那麼JML就會把這當成一個錯誤,因為e instanceof NoSuchElementException不是true。如果你既想處理NoSuchElementException異常又想處理其它運行期異常,我們可以修改上面的signals語句,改為signals (NoSuchElementException e) true; 。這個意思是說,如果peek()方法拋出一個NoSuchElementException異常的話,那條件true必須為真,而true是一個常量,總是可以滿足條件,所以對於NoSuchElementException異常的處理可以正常進行。不過我們這裡並沒有提及關於其它異常的資訊,而peek()方法可以拋出它的簽名(譯者註:方法的簽名是指,方法聲明的各個部分,具體來說,是方法名稱、參數類型、傳回型別和拋出異常的總稱)允許的任何異常。它的簽名說它可以拋出NoSuchElementException異常,這就意味著它既可以拋出NoSuchElementException異常,又可以拋出RuntimeException。
如果隊列中存在一些元素而且當我們調用peek()方法時還是拋出一個NoSuchElementException異常(或者其他異常),JML運行期斷言檢查就會拋出一個unchecked exception,這表示正常的後置條件失敗。
結論
本文簡單介紹了JML的概念,說明了它對物件導向系統的分析和設計的貢獻,通過執行個體示範了如何在Java程式中使用JML標記。你可以從下面所列的資源中下載本文中所使用的完整的代碼,還可以從中找到更多的關於JML的資訊。
你可以使用開源的JML編譯器來編譯你含有JML標記的代碼,所產生的類檔案會在運行時自動檢查JML規範。如果你的程式沒有實現規範中規定的事情,JML就會拋出一個unchecked exception 來說明你的程式違背了哪一條規範。這可以協助我們捕獲程式中的bug,而且能保證我們的代碼與文檔(JML格式的文檔)高度一致。
JML運行期斷言檢查編譯器是第一個JML工具,其他相關工具還有JMLdoc和JMLunit等等。JMLdoc與Javadoc工具相似,不同的是它在產生的HTML格式文檔中包含JML規範;JMLunit可以成生一個Java類檔案測試的架構,它可以讓你很方便地使用JUnit工具測試含有JML標記的Java代碼。你還可以從下面所列的資源中找到其他關於JML各個方面的相關內容。
在此請允許我向 Gary Leavens 和 Yoonsik Cheon表示深深的謝意,是他們幫我解決了一部分關於JML的疑問並且審閱了你所看到的這篇文章。
資源
- 下載本文中所用的JML.zip">原始碼 。
- Sourceforge是JMLspecs/">JML規範、開源JML工具如JML編譯器、JMLdoc、JMLunit以及相關資訊的首頁。
- PriorityQueue 介面和 BinaryHeap 類是開源項目 雅加達通用集合組件(JCCC)的一部分。
- Gary T. Leavens、Albert L. Baker和Clyde Ruby的 "JML/prelimdesign/prelimdesign_toc.html">JML設計起步" (愛荷華州立大學電腦科學系,2003年1月) 是對JML的更為詳細地介紹。
- Bertrand Meyer在物件導向軟體構造,第二版一書中關於通過契約(JML最基本的概念)進行設計的討論(Prentice Hall, 1997)。
- Granville Miller在介紹物件導向系統建模中關於 Java/library/j-jmodcol.html">Java建模 部分(developerWorks, 2002)。
- Eric Allen在"Java/library/j-diag0723.html">Diagnosing Java code: Assertions and temporal logic in Java programming" (developerWorks, July 2002)一書中討論了一些斷言檢查限制的問題。
- Kyle Brown在"Java/library/j-sdao/">A stepped approach to J2EE testing with SDAO" (developerWorks, March 2003)一文中討論了如何把類比資料對象與分層測試聯合起來。
- Java程式設計的各個方面的資訊請參考Java/">IBM developerWorks Java專區。
<完>
其它部分請參考:
http://www.111cn.net/develop/read_article.asp?id=19198 JML起步---使用JML 改進你的Java程式(1)
http://www.111cn.net/develop/read_article.asp?id=19199 JML起步---使用JML 改進你的Java程式(2)
http://www.111cn.net/develop/read_article.asp?id=19200 JML起步---使用JML 改進你的Java程式(3)
<