原文地址 http://www.open-open.com/lib/view/open1462177214142.html
我們寫單元測試,一般都會用到一個或多個單元測試框架,在這里,我們介紹一下JUnit4這個測試框架。這是Java界用的最廣泛,也是最基礎的一個框架,其他的很多框架,包括我們后面會看到的Robolectric,都是基於或兼容JUnit4的。然而首先要解決的問題是。。。
為什么要使用單元測試框架呢
或者換句話說,單元測試框架能夠為我們做什么呢?從最基本的開始說起,假如我們有這樣一個類:
public class Calculator { public int add(int one, int another) { // 為了簡單起見,暫不考慮溢出等情況。 return one + another; } public int multiply(int one, int another) { // 為了簡單起見,暫不考慮溢出等情況。 return one * another; } }
如果不用單元測試框架的話,我們要怎么寫測試代碼呢?我們恐怕得寫出下面這樣的代碼:
public class CalculatorTest { public static void main(String[] args) { Calculator calculator = new Calculator(); int sum = calculator.add(1, 2); if(sum == 3) { System.out.println("add() works!") } else { System.out.println("add() does not works!") } int product = calculator.multiply(2, 4); if (product == 8) { System.out.println("multiply() works!") } else { System.out.println("multiply() does not works!") } } }
然后我們再通過某種方式,比如命令行或IDE,運行這個 CalculatorTest 的 main 方法,在看着terminal的輸出,才知道測試是通過還是失敗。想想一下,如果我們有很多的類,每個類都有很多方法,那么就要寫一堆這樣的代碼,每個類對於一個含有 main 方法的test類,同時 main 方法里面會有一堆代碼。這樣既寫起來痛苦,跑起來更痛苦,比如說,你怎么樣一次性跑所有的測試類呢?所以,一個測試框架為我們做的最基本的事情,就是允許我們按照某種更簡單的方式寫測試代碼,把每一個測試單元寫在一個測試方法里面,然后它會自動找出所有的測試方法,並且根據你的需要,運行所有的測試方法,或者是運行單個測試方法,或者是運行部分測試方法等等。
對於上面的 Calculator 例子,如果使用Junit的話,我們可以按照如下的方式寫測試代碼:
public class CalculatorTest { @Test public void testAdd() throws Exception { Calculator calculator = new Calculator(); int sum = calculator.add(1, 2); Assert.assertEquals(3, sum); } @Test public void testMultiply() throws Exception { Calculator calculator = new Calculator(); int product = calculator.multiply(2, 4); Assert.assertEquals(8, product); } }
每一個被測試的方法( add(), multiply() ),寫一個對應的測試方法( testAdd(), testMultiply() )。那JUnit怎么知道那些是測試方法,哪些不是呢?這個是通過前面的 @Test 注解來標志的,只要有這個注解,JUnit4就會當做是一個測試方法,方法名其實是可以隨意起的。當然,名字還是應該起的更有可讀性一點,讓人一看就知道,這個測試方法是測試了被測的類的那個方法,或者是測試了那個功能點等等。
除了幫我們找出所有的測試方法,並且方便運行意外,單元測試框架還幫我們做了其他事情。在 這個系列的第一篇文章 中我們提到,一個測試方法主要包括三個部分:
- setup
- 執行操作
- 驗證結果
而一個單元測試框架,可以讓我們更方便的寫上面的每一步的代碼,尤其是第一步和第三部。比如說,在上面的 CalculatorTest 中, testAdd() 和 testMultiply() 都有相同的setup: Calculator calculator = new Calculator(); ,如果 Calculator 還有其他的方法的話,這行代碼就得重復更多次,這種duplication是沒必要的。絕大多數單元測試框架考慮到了這一點,它們知道一個測試類的很多測試方法可能需要相同的setup,所以為我們提供了便捷方法。對於JUnit4,是通過 @Before 來實現的:
public class CalculatorTest { Calculator mCalculator; @Before public void setup() { mCalculator = new Calculator(); } @Test public void testAdd() throws Exception { int sum = mCalculator.add(1, 2); assertEquals(3, sum); //為了簡潔,往往會static import Assert里面的所有方法。 } @Test public void testMultiply() throws Exception { int product = mCalculator.multiply(2, 4); assertEquals(8, product); } }
如果一個方法被 @Before 修飾過了,那么在每個測試方法調用之前,這個方法都會得到調用。所以上面的例子中, testAdd() 被運行之前, setup() 會被調用一次,把 mCalculator 實例化,接着運行 testAdd() ; testMultiply() 被運行之前, setup() 又會被調用一次,把 mCalculator 再次實例化,接着運行 testMultiply() 。如果還有其他的測試方法,則以此類推。
對應於 @Before 的,有一個 @After ,作用估計你也猜得到,那就是每個測試方法運行結束之后,會得到運行的方法。比如一個測試文件操作的類,那么在它的測試類中,可能 @Before 里面需要去打開一個文件,而每個測試方法運行結束之后,都需要去close這個文件。這個時候就可以把文件close的操作放在 @After 里面,讓它自動去執行。
類似的,還有 @BeforeClass 和 @AfterClass 。 @BeforeClass 的作用是,在跑一個測試類的所有測試方法之前,會執行一次被 @BeforeClass 修飾的方法,執行完所有測試方法之后,會執行一遍被 @AfterClass 修飾的方法。這兩個方法可以用來setup和release一些公共的資源,需要注意的是,被這兩個annotation修飾的方法必須是靜態的。
前面講的是單元測試框架對於一個測試方法的第一步“setup”,為我們做的事情。而對於第三部“驗證結果”,則一般是通過一些assert方法來完成的。JUnit為我們提供的assert方法,多數都在 Assert 這個類里面。最常用的那些如下:
assertEquals(expected, actual)
驗證expected的值跟actual是一樣的,如果是一樣的話,測試通過,不然的話,測試失敗。如果傳入的是object,那么這里的對比用的是equals()
assertEquals(expected, actual, tolerance)
這里傳入的expected和actual是float或double類型的,大家知道計算機表示浮點型數據都有一定的偏差,所以哪怕理論上他們是相等的,但是用計算機表示出來則可能不是,所以這里運行傳入一個偏差值。如果兩個數的差異在這個偏差值之內,則測試通過,否者測試失敗。
assertTrue(boolean condition)
驗證contidion的值是true
assertFalse(boolean condition)
驗證contidion的值是false
assertNull(Object obj)
驗證obj的值是null
assertNotNull(Object obj)
驗證obj的值不是null
assertSame(expected, actual)
驗證expected和actual是同一個對象,即指向同一個對象
assertNotSame(expected, actual)
驗證expected和actual不是同一個對象,即指向不同的對象
fail()
讓測試方法失敗
注意:上面的每一個方法,都有一個重載的方法,可以在前面加一個String類型的參數,表示如果驗證失敗的話,將用這個字符串作為失敗的結果報告。
比如:
assertEquals("Current user Id should be 1", 1, currentUser.id());
當 currentUser.id() 的值不是1的時候,在結果報道里面將顯示"Current user Id should be 1",這樣可以讓測試結果更具有可讀性,更清楚錯誤的原因是什么。
比較有意思的是最后一個方法, fail() ,你或許會好奇,這個有什么用呢?其實這個在很多情況下還是有用的,比如最明顯的一個作用就是,你可以驗證你的測試代碼真的是跑了的。
此外,它還有另外一個重要作用,那就是驗證某個被測試的方法會正確的拋出異常,不過這點可以通過下面講到的方法,更方便的做到,所以就不講了。
這部分相對來說還是很好理解的,不做過多解釋。
JUnit的其他功能
Ignore一些測試方法
很多時候,因為某些原因(比如正式代碼還沒有實現等),我們可能想讓JUnit忽略某些方法,讓它在跑所有測試方法的時候不要跑這個測試方法。要達到這個目的也很簡單,只需要在要被忽略的測試方法前面加上 @Ignore 就可以了,如下:
public class CalculatorTest { Calculator mCalculator; @Before public void setup() { mCalculator = new Calculator(); } // Omit testAdd() and testMultiply() for brevity @Test @Ignore("not implemented yet") public void testFactorial() { } }
驗證方法會拋出某些異常
有的時候,拋出異常是一個方法正確工作的一部分。比如一個除法函數,當除數是0的時候,它應該拋出異常,告訴外界,傳入的被除數是0,示例代碼如下:
public class Calculator { // Omit testAdd() and testMultiply() for brevity public double divide(double divident, double dividor) { if (dividor == 0) throw new IllegalArgumentException("Dividor cannot be 0"); return divident / dividor; }}
那么如何測試當傳入的除數是0的時候,這個方法應該拋出 IllegalArgumentException 異常呢?
在Junit中,可以通過給 @Test annotation傳入一個expected參數來達到這個目的,如下:
public class CalculatorTest { Calculator mCalculator; @Before public void setup() { mCalculator = new Calculator(); } // Omit testAdd() and testMultiply() for brevity @Test(expected = IllegalArgumentException.class) public void test() { mCalculator.divide(4, 0); } }
@Test(expected = IllegalArgumentException.class) 表示驗證這個測試方法將拋出 IllegalArgumentException 異常,如果沒有拋出的話,則測試失敗。
小結
這篇文字大概簡單介紹了JUnit的使用,相對來說是比較簡單,也是比較容易理解的,希望能幫助到大家。其中Assert部分,可以幫我們驗證一個方法的返回結果。然而,這些只能幫我們測試有返回值的那些方法。在第一篇文章里面我們講了,一個類的方法分兩種,一是有返回值的方法,這些可以通過我們今天講的JUnit來做測試。而另外一種沒有返回值的方法,即void方法,則要通過另外一個框架,Mockito,來驗證它的正確性。至於怎么樣驗證void方法的正確性,以及Mockito的使用,請關注下一篇文章。