顧問
2000 年 11 月
軟件開發(fā)習(xí)慣中一個(gè)細(xì)微更改都可能會(huì)對(duì)軟件質(zhì)量產(chǎn)生巨大改進(jìn)。將單元測試合并到開發(fā)過程中,然后從長遠(yuǎn)角度來看它可以節(jié)省多少時(shí)間和精力。本文通過使用代碼樣本說明了單元測試的種種好處,特別是使用 Ant 和 JUnit 帶來的各種方便。
測試是大型開發(fā)過程中的基本原則之一。在任何職業(yè)中,驗(yàn)證都是一個(gè)重要部分。醫(yī)生要通過驗(yàn)血來確診。波音公司在研制 777 的過程中對(duì)飛機(jī)的每個(gè)組件都進(jìn)行了精心測試。為什么軟件開發(fā)就應(yīng)該例外呢?
以前,由于在應(yīng)用程序中將 GUI 和商業(yè)邏輯緊密聯(lián)系在一起,這就限制了創(chuàng)建自動(dòng)測試的能力。當(dāng)我們學(xué)會(huì)通過抽象層將商業(yè)邏輯從界面中分離出來時(shí),各個(gè)單獨(dú)代碼模塊的自動(dòng)測試就替代了通過 GUI 進(jìn)行的手工測試。
現(xiàn)在,集成開發(fā)環(huán)境 (IDE) 能在您輸入代碼的同時(shí)顯示錯(cuò)誤,對(duì)于在類中快速查找方法具有智能探測功能,可以利用語法結(jié)構(gòu)生成彩色代碼,而且具有許多其它功能。因此,在編譯更改過的代碼之前,您已經(jīng)全盤考慮了將構(gòu)建的類,但您是否考慮過這樣的修改會(huì)破壞某些功能呢?
每個(gè)開發(fā)者都碰到過更改“臭蟲”。代碼修改過程可能會(huì)引入“臭蟲”,而如果通過用戶界面手工測試代碼的話,在編譯完成之前是不會(huì)發(fā)現(xiàn)它的。然后,您就要花費(fèi)幾天的時(shí)間追蹤由更改所引起的錯(cuò)誤。最近在我做的一個(gè)項(xiàng)目中,當(dāng)我把后端數(shù)據(jù)庫由 Informix 更改到 Oracle 時(shí)就遇到了這種情況。大部分更改都十分順利,但由于數(shù)據(jù)庫層或使用數(shù)據(jù)庫層的系統(tǒng)缺少單元測試,從而導(dǎo)致將大量時(shí)間花費(fèi)在嘗試解決更改“臭蟲”上。我花了兩天的時(shí)間查到別人代碼中的一個(gè)數(shù)據(jù)庫語法更改。(當(dāng)然,那個(gè)人仍是我的朋友。)
盡管測試有許多好處,但一般的程序員對(duì)測試都不太感興趣,開始時(shí)我也沒有。您聽到過多少次“它編譯了,所以它一定能用”這種言論?但“我思,故我在”這種原則并 不適用于高質(zhì)量軟件。要鼓勵(lì)程序員測試他們的代碼,過程必須簡單無痛。
本文從某人學(xué)習(xí)用 Java 語言編程時(shí)所寫的一個(gè)簡單的類開始。然后,我會(huì)告訴您我是如何為這個(gè)類編寫單元測試,以及在編寫完它以后又是如何將單元測試添加到構(gòu)建過程中的。最后,我們將看到將“臭蟲”引入代碼時(shí)發(fā)生的情況。
從一個(gè)典型類開始
第一個(gè)典型的 Java 程序一般都包含一個(gè)打印 "Hello World" 的 main()
。在清單 1 中,我創(chuàng)建了一個(gè) HelloWorld 對(duì)象的實(shí)例并調(diào)用 sayHello()
方法,該方法會(huì)打印這句習(xí)慣說法。
|
main()
方法是我的測試。哦噢!我將代碼、文檔、測試和樣本代碼包含在了一個(gè)模塊中。保佑 Java!但隨著程序越變?cè)酱?,這種開發(fā)方法很快就開始顯現(xiàn)出了缺陷:
main()
就越大。類可能僅僅因?yàn)檎5臏y試而變得非常龐大。 main()
是代碼的一部分, main()
就對(duì)其他開發(fā)者通過類接口無法訪問的私有成員和方法享有訪問權(quán)。出于這個(gè)原因,這種測試方法很容易出錯(cuò)。 main()
。 類開發(fā)
對(duì)我來說,類開發(fā)是從編寫 main()
方法開始的。我在編寫 main()
的時(shí)候就定義類和類的用法,然后實(shí)現(xiàn)接口。它的一些明顯的缺陷也開始顯現(xiàn)出來。一個(gè)缺陷是我傳遞給 main()
來執(zhí)行測試的參數(shù)個(gè)數(shù)。其次, main()
本身在進(jìn)行調(diào)用子方法、設(shè)置代碼等操作時(shí)變得很混亂。有時(shí) main()
會(huì)比類實(shí)現(xiàn)的其余部分還要大。
更簡單的過程
我原來的做法有一些很明顯的缺陷。因此,讓我們看看有什么別的方法可以使問題簡化。我仍然通過接口設(shè)計(jì)代碼并給出應(yīng)用示例,正如原來的 main()
一樣。不同的是我將代碼放到了另一個(gè)單獨(dú)的類中,而這個(gè)類恰好是我的“單元測試”。這種技術(shù)有以下幾點(diǎn)好處:
main()
main()
的限制了。以前我得將多個(gè)參數(shù)傳遞給 main()
來測試不同的配置。現(xiàn)在我可以創(chuàng)建許多單獨(dú)的測試類,每一個(gè)都維護(hù)各自的設(shè)置代碼。 接下來我們將這個(gè)單獨(dú)的單元測試對(duì)象放入構(gòu)建過程中。這樣,我們就可以提供自動(dòng)確認(rèn)過程的方法。
使用 JUnit 自動(dòng)化單元測試
要使測試自動(dòng)化,您需要一個(gè)測試框架。您可以自己開發(fā)或購買,也可以使用某些開放源代碼工具,例如 JUnit。我選擇 JUnit 出于以下幾個(gè)原因:
測試布局
圖 1 顯示了使用樣本 TestSuite 的 JUnit TestSuite 布局。每個(gè)測試都由若干單獨(dú)的測試案例構(gòu)成。每個(gè)測試案例都是一個(gè)單獨(dú)的類,它擴(kuò)展了 TestClass 類并包含了我的測試代碼,即那些曾在 main()
中出現(xiàn)的代碼。在該例中,我向 TestSuite 添加了兩個(gè)測試:一個(gè)是 SkeletonTest,我將它用作所有新類和 HelloWorld 類的起點(diǎn)。
測試類 HelloWorldTest.java
按照約定,測試類的名稱中包含我所測試的類的名稱,但將 Test 附加到結(jié)尾。在本例中,我們的測試類是 HelloWorldTest.java
。我復(fù)制了 SkeletonTest 中的代碼,并添加了 testSayHello()
來測試 sayHello()
。請(qǐng)注意 HelloWorldTest 擴(kuò)展了 TestCase。JUnit 框架提供了 assert
和 assertEquals
方法,我們可以使用這些方法來進(jìn)行驗(yàn)證。 HelloWorldTest.java
顯示在清單 2 中。
|
testSayHello()
看上去和 HelloWorld.java
中原來的 main 方法類似,但有一個(gè)主要的不同之處。它不是執(zhí)行 System.out.println
并顯示結(jié)果,而是添加了一個(gè) assertEquals()
方法。如果兩個(gè)值不同, assertEquals
將打印出兩個(gè)輸入的值。您可能已經(jīng)注意到這個(gè)方法不起作用!HelloWorld 中的 sayHello()
方法不返回字符串。如果我先寫過測試,就會(huì)捕捉到這一點(diǎn)。我將 "Hello World" 字符串與輸出流聯(lián)結(jié)起來。這樣,按照清單 3 中顯示的那樣重寫了 HelloWorld,去掉 main()
,并更改了 sayHello()
的返回類型。
|
如果我保留了 main()
并修改了聯(lián)系,代碼看上去如下:
|
新的 main()
與我測試程序中的 testSayHello()
非常相似。是的,它看上去不象是一個(gè)現(xiàn)實(shí)世界中的問題(這是人為示例的問題),但它說明了問題。在單獨(dú)的應(yīng)用程序中編寫 main()
可以改進(jìn)您的設(shè)計(jì),同時(shí)幫助您設(shè)計(jì)測試?,F(xiàn)在我們已經(jīng)創(chuàng)建了一個(gè)測試類,讓我們使用 Ant 來將它集成到構(gòu)建中。
使用 Ant 將測試集成到構(gòu)建中
Jakarta Project 將 Ant 工具說成“不帶 make 缺點(diǎn)的 make”。Ant 正在成為開放源代碼世界中實(shí)際上的標(biāo)準(zhǔn)。原因很簡單:Ant 是使用 Java 語言編寫的,這種語言可以讓構(gòu)建過程在多種平臺(tái)上使用。這種特性簡化了在不同 OS 平臺(tái)之間的程序員的合作,而合作是開放源代碼社區(qū)的一種需要。您可以在自己選擇的平臺(tái)上進(jìn)行開發(fā) 和構(gòu)建。Ant 的特性包括:
圖 2 簡要介紹了一個(gè)配置文件。配置文件由目標(biāo)樹構(gòu)成。每個(gè)目標(biāo)都包含了要執(zhí)行的任務(wù),其中任務(wù)就是可以執(zhí)行的代碼。在本例中, mkdir是目標(biāo) compile的任務(wù)。 mkdir是建立在 Ant 中的一個(gè)任務(wù),用于創(chuàng)建目錄。 Ant 帶有一套健全的內(nèi)置任務(wù)。您也可以通過擴(kuò)展 Ant 任務(wù)類來添加自己的功能。
每個(gè)目標(biāo)都有唯一的名稱和可選的相關(guān)性。目標(biāo)相關(guān)性需要在執(zhí)行目標(biāo)任務(wù)列表之前執(zhí)行。例如圖 2 所示,在執(zhí)行 compile 目標(biāo)中的任務(wù)之前需要先運(yùn)行 JUNIT 目標(biāo)。這種類型的配置可以讓您在一個(gè)配置中有多個(gè)樹。
與經(jīng)典 make 實(shí)用程序的相似性是非常顯著的。這是理所當(dāng)然的,因?yàn)?make 就是 make。但也要記住有一些差異:通過 Java 實(shí)現(xiàn)的跨平臺(tái)和可擴(kuò)展性,通過 XML 實(shí)現(xiàn)的可配置,還有開放源代碼。
下載和安裝 Ant
首先下載 Ant(請(qǐng)參閱 參考資料 )。將 Ant 解壓縮到 tools 目錄,再將 Ant bin
目錄添加到路徑中。(在我的機(jī)器上是 e:\tools\ant\bin
。)設(shè)置 ANT_HOME 環(huán)境變量。在 NT 中,這意味著進(jìn)入系統(tǒng)屬性,然后以帶有值的變量形式添加 ANT_HOME。ANT_HOME 應(yīng)該設(shè)置為 Ant 根目錄,即包含 bin
和 lib
目錄的目錄。(對(duì)我來說,是 e:\tools\ant
。)確保 JAVA_HOME 環(huán)境變量設(shè)置為安裝了 JDK 的目錄。Ant 文檔有關(guān)于安裝的詳細(xì)信息。
下載和安裝 JUnit
下載 JUnit 3.2(請(qǐng)參閱 參考資料 )。解開 junit.zip
,并將 junit.jar
添加到 CLASSPATH。如果將 junit.zip
解包到類路徑中,可以通過運(yùn)行以下命令來測試安裝: java junit.textui.TestRunner junit.samples.AllTests
定義目錄結(jié)構(gòu)
在開始我們的構(gòu)建和測試過程之前,需要一個(gè)項(xiàng)目布局。圖 3 顯示了我的樣本項(xiàng)目的布局。下面描述了布局的目錄結(jié)構(gòu):
build
-- 類文件的臨時(shí)構(gòu)建位置。構(gòu)建過程將創(chuàng)建這個(gè)目錄。 src
-- 源代碼的位置。 Src
被分為 test
文件夾和 main
文件夾,前者用于所有的測試代碼,而后者包含可交付的代碼。將測試代碼與主要代碼分離提供了幾點(diǎn)特性。首先,使主要代碼中的混亂減少。其次,它允許包對(duì)齊。我就熱衷與將類和與其相關(guān)的包放置在一起。測試就應(yīng)該和測試在一起。它還有助于分發(fā)過程,因?yàn)槟悴豢赡艽蛩銓卧獪y試分發(fā)給客戶。 在實(shí)際中,我們有多個(gè)目錄,例如 distribution
和 documentation
。我們還會(huì)在 main
下有多個(gè)用于包的目錄,例如 com.company.util
。
因?yàn)槟夸浗Y(jié)構(gòu)經(jīng)常變動(dòng),所以在 build.xml
中有這些變動(dòng)的全局字符串常數(shù)是很重要的。
Ant 構(gòu)建配置文件示例
下一步,我們要?jiǎng)?chuàng)建配置文件。清單 4 顯示了一個(gè) Ant 構(gòu)建文件示例。構(gòu)建文件中的關(guān)鍵就是名為 runtests 的目標(biāo)。這個(gè)目標(biāo)進(jìn)行分支判斷并運(yùn)行外部程序,其中外部程序是前面已安裝的 junit.textui.TestRunner
。我們指定要使用語句 test.com.company.AllJUnitTests
來運(yùn)行哪個(gè)測試套件。
|
運(yùn)行 Ant 構(gòu)建示例
開發(fā)過程中的下一步是運(yùn)行將創(chuàng)建和測試 HelloWorld 類的構(gòu)建。清單 5 顯示了構(gòu)建的結(jié)果,其中包括了各個(gè)目標(biāo)部分。最酷的那部分是 runtests 輸出語句:它告訴我們整個(gè)測試套件都正確運(yùn)行了。
我在圖 4 和圖 5 中顯示了 JUnit GUI,其中所要做的就是將 runtest 目標(biāo)從 junit.textui.TestRunner
改為 junit.ui.TestRunner
。當(dāng)您使用 JUnit 的 GUI 部分時(shí),您必須選擇退出按鈕來繼續(xù)構(gòu)建過程。如果使用 Junit GUI 構(gòu)建包,那么它將更難與大型的構(gòu)建過程相集成。另外,文本輸出也與構(gòu)建過程更一致,并可以定向輸出到一個(gè)用于主構(gòu)建記錄的文本文件。這對(duì)于每天晚上都要進(jìn)行的構(gòu)建非常合適。
|
了解測試的工作原理
讓我們搞點(diǎn)破壞,然后看看會(huì)發(fā)生什么事。夜深了,我們決定把 "Hello World" 變成一個(gè)靜態(tài)字符串。在更改期間,我們 不小心打錯(cuò)了字母,將 "o" 變成了 "0",如清單 6 所示。
|
在構(gòu)建包時(shí),我們看到了錯(cuò)誤。清單 7 顯示了 runtest 中的錯(cuò)誤。它顯示了失敗的測試類和測試方法,并說明了為什么會(huì)失敗。我們返回到代碼中,改正錯(cuò)誤后離開。
清單 7. 構(gòu)建錯(cuò)誤示例
|
并非完全無痛
新的過程并不是完全無痛的。為使單元測試成為開發(fā)的一部分,您必須采取以下幾個(gè)步驟:
但好處遠(yuǎn)遠(yuǎn)超過了痛苦。通過使單元測試成為開發(fā)過程的一部分,您可以:
實(shí)現(xiàn) 24x7
保證產(chǎn)品的質(zhì)量要花費(fèi)很多錢,但如果質(zhì)量有缺陷,花費(fèi)的錢就更多。如何才能使所花的錢獲得最大價(jià)值,來保證產(chǎn)品質(zhì)量呢?
在我 10 年的開發(fā)生涯里,為 emageon.com 工作是最重要的部分之一。在 emageon.com 時(shí),設(shè)計(jì)評(píng)審、代碼評(píng)審和單元測試是每天都要做的事。這種日常開發(fā)習(xí)慣造就了最高質(zhì)量的產(chǎn)品。軟件在客戶地點(diǎn)第一年的當(dāng)機(jī)次數(shù)為零,是一個(gè)真正的 24x7 產(chǎn)品。單元測試就象刷牙:您不一定要做,但如果做了,生活質(zhì)量就更好。
關(guān)于作者 Malcolm G. Davis 擁有自己的咨詢公司,并任公司的總裁,該公司位于美國阿拉巴馬州的伯明翰 (Birmingham)。他把自己看做是個(gè) Java 傳道者。在工作之余,他喜歡跑步,以及和他的孩子們一起玩耍。您可以通過 malcolm@nuearth.com 與 Malcolm 聯(lián)系。 |
聯(lián)系客服