JUnit4单元测试入门详解

JUnit4单元测试入门详解

1.JUnit4概述：

JUnit4主要目标便是利用Java5的Annotation特性简化测试用例的编写。
先看一下在JUnit 3中我们是怎样写一个单元测试的。比如下面一个类：

public class AddOperation {      public int add(int x, int y){          return x + y;      }}

我们要测试add这个方法，单元测试得这么写：

import junit.framework.TestCase;import static org.junit.Assert.*;public class AddOperationTest extends TestCase{      public void setUp() throws Exception {      }      public void tearDown() throws Exception {      }      public void testAdd() {          AddOperation instance = new AddOperation();          assertEquals(5, instance.add(2,3));      }}

可以看到上面的类使用了JDK5中的静态导入，只要在import关键字后面加上static关键字，就可以把后面的类的static的变量和方法导入到这个类中，调用的时候和调用自己的方法没有什么区别。

上面那个单元测试有一些约束，主要表现在：

1.单元测试类必须继承自TestCase；
2.要测试的方法必须以test开头。

如果是在JUnit 4中写就比较简单。代码如下：

import org.junit.After;import org.junit.Before;import org.junit.Test;import static org.junit.Assert.*;public class AddOperationTest{      public AddOperationTest() {      }      @Before      public void setUp() throws Exception {      }      @After      public void tearDown() throws Exception {      }      @Test      public void add() {          AddOperation instance = new AddOperation();          assertEquals(5, instance.add(2, 3));      }}

我们可以看到，采用Annotation的JUnit4不会要求你必须继承自TestCase，而且测试方法也不必以test开头了，只要以@Test元数据来描述即可。
从上面的例子可以看到在JUnit 4中还引入了一些其他的注解，下面一一介绍：
@Before：使用了该注解的方法在每个测试方法执行之前都要执行一次。
@After：使用了该注解的方法在每个测试方法执行之后要执行一次。
注意：@Before和@After标示的方法可以有多个。这个相当于取代了JUnit以前版本中的setUp和tearDown方法。
@Test(expected=*.class)：在JUnit4.0之前，对异常的测试，我们只能通过fail来产生一个错误，并在try块里面assertTrue（true）来测试。现在通过@Test注解中的expected属性来指定异常类型。
@Test(timeout=xxx)：该注解传入了一个时间（毫秒）给测试方法，如果测试方法在制定的时间之内没有运行完，则测试也失败。
@ignore：该注解标记的测试方法在测试中会被忽略。当测试的方法还没有实现，或者测试的方法已经过时，或者在某种条件下才能测试该方法（比如需要一个数据库联接，而在本地测试的时候，数据库并没有连接），那么使用该标签来标示这个方法。同时，你可以为该标签传递一个String的参数，来表明为什么会忽略这个测试方法。比如：@lgnore(“该方法还没有实现”)，在执行的时候，仅会报告该方法没有实现，而不会运行测试方法。

2.在Eclipse中使用JUnit4进行单元测试：

我们编写程序的时候，每编写完一个函数之后，都应该对这个函数的方方面面进行测试，这样的测试我们称之为单元测试。

传统的编程方式，进行单元测试是一件很麻烦的事情，JUnit4大大简化了进行单元测试所要做的工作。下面我们介绍在Eclipse6.6中使用JUnit4的方法：

首先新建一个项目叫JUnit_Test，我们编写一个Calculator类，这是一个能够简单实现加减乘除、平方、开方的计算器类，然后对这些功能进行单元测试。这个类并不是很完美，我们故意保留了一些Bug用于演示，这些Bug在注释中都有说明。该类代码如下：

public class Calculator {private static double result;//用于存放正确结果public void add(int num){result += num;}public void substract(int num){result -= 1;// bug：正解是 result -= result;}public void multiply(int num){// 此方法尚未写好}public void divide(int num) throws ArithmeticException{// 用于后面异常测试if(num == 0){throw new ArithmeticException();}result /= num;}public void square(int num){result = num * num;}public void squareRoot(int num){for(;;);// bug：死循环}public void clear(){result = 0; }public double getResult(){return result;}}

第二步，将JUnit4单元测试包引入这个项目；

第三步，生成JUnit测试框架：在Eclipse的Package Explorer中用右键点击该类弹出菜单，选择“New -> JUnit Test Case”；

之后系统会自动生成一个新类CalculatorTest，里面包含一些空的测试用例。你只需要将这些测试用例稍作修改即可使用。完整的CalculatorTest代码如下：

import static org.junit.Assert.assertEquals;import org.junit.After;import org.junit.Before;import org.junit.Ignore;import org.junit.Test;import org.junit.internal.runners.TestClassRunner;import org.junit.runner.RunWith;@RunWith(TestClassRunner.class)public class CalculatorTest {private static Calculator calculator = new Calculator();@Beforepublic void setUp() throws Exception {System.out.println("Before1");calculator.clear();}@Beforepublic void setUp2(){System.out.println("Before2");calculator.clear();}@Afterpublic void setUp3(){System.out.println("After");calculator.clear();}@Testpublic void testAdd() {calculator.add(2);calculator.add(3);assertEquals(5, calculator.getResult());}@Testpublic void testSubstract() {calculator.add(10);calculator.substract(2);assertEquals(8, calculator.getResult());}@Test@Ignore("乘法尚未实现")public void testMultiply() {}@Test(expected=ArithmeticException.class)public void testDivide() {//calculator.add(8);calculator.divide(0);//assertEquals(4, calculator.getResult());}@Test(timeout=1000)public void testSquareRoot() {calculator.square(4);assertEquals(2, calculator.getResult());}}

第四步，运行测试代码，运行结果如下：

进度条是红颜色表示发现错误，共进行了5个测试，其中1个测试被忽略，两个测试失败。

3.接着对上面的例子进行分析：

一、包含必要地Package

在测试类中用到了JUnit4框架，自然要把相应地Package包含进来。最主要地一个Package就是org.junit.*。把它包含进来之后，绝大部分功能就有了。还有一句话也非常地重要“import static org.junit.Assert.*;”，我们在测试的时候使用的一系列assertEquals方法就来自这个包。大家注意一下，这是一个静态包含（static），是JDK5中新增添的一个功能。也就是说，assertEquals是Assert类中的一系列的静态方法，一般的使用方式是Assert. assertEquals()，但是使用了静态包含后，前面的类名就可以省略了，使用起来更加的方便。

二、测试类的声明

测试类是一个独立的类，没有任何父类。测试类的名字也可以任意命名，没有任何局限性。所以我们不能通过类的声明来判断它是不是一个测试类，它与普通类的区别在于它内部的方法的声明。

三、创建一个待测试的对象。

你要测试哪个类，那么你首先就要创建一个该类的对象。正如上面的代码：

private static Calculator calculator = new Calculator();

四、测试方法的声明

在测试类中，并不是每一个方法都是用于测试的，你必须使用“注解”来明确表明哪些是测试方法。

五、编写一个简单的测试方法

首先，你要在方法的前面使用@Test标注，以表明这是一个测试方法。对于方法的声明也有如下要求：名字可以随便取，没有任何限制，但是返回值必须为void，而且不能有任何参数。如果违反这些规定，会在运行时抛出一个异常。至于方法内该写些什么，那就要看你需要测试些什么了。

六、忽略测试某些尚未完成的方法。

如果你已经把该方法的测试用例写完，但该方法尚未完成，那么测试的时候一定是“失败”。JUnit通过在测试函数的前面加上@Ignore标注，标注该方法尚未完成，暂不参与此次测试。这样的话测试结果就会提示你有几个测试被忽略，而不是失败。一旦你完成了相应函数，只需要把@Ignore标注删去，就可以进行正常的测试。

七、Fixture

Fixture的含义就是“在某些阶段必然被调用的代码”。比如我们上面的测试，由于只声明了一个Calculator对象，他的初始值是0，但是测试完加法操作后，他的值就不是0了；接下来测试减法操作，就必然要考虑上次加法操作的结果。这绝对是一个很糟糕的设计！我们非常希望每一个测试都是独立的，相互之间没有任何耦合度。因此，我们就很有必要在执行每一个测试之前，对Calculator对象进行一个“复原”操作，以消除其他测试造成的影响。因此，“在任何一个测试执行之前必须执行的代码”就是一个Fixture，我们用@Before来标注它。

八、限时测试

还记上面给出的例子吗，那个求平方根的函数有Bug，是个死循环。对于逻辑很复杂，循环嵌套比较深的程序，很有可能出现死循环，因此一定要采取一些预防措施。限时测试是一个很好的解决方案。我们给这些测试函数设定一个执行时间，超过了这个时间，他们就会被系统强行终止，并且系统还会向你汇报该函数结束的原因是因为超时，这样你就可以发现这些Bug了。要实现这一功能，只需要给@Test标注加一个参数即可，如上面例子中：@Test(timeout=1000)，timeout参数表明了你要设定的时间，单位为毫秒。

九、测试异常

你经常会编写一些需要抛出异常的方法。那么，如果你觉得一个方法应该抛出异常，但是它没抛出，这算不算Bug呢？这当然是Bug，并JUnit也考虑到了这一点，来帮助我们找到这种Bug。例如，我们写的计算器类有除法功能，如果除数是一个0，那么必然要抛出“除0异常”。因此，我们很有必要对这些进行测试，只需要给@Test标注加一个参数即可，如上面例子中：@Test(expected = ArithmeticException.class)，我们需要使用@Test标注的expected属性，将我们要检验的异常传递给他，这样JUnit框架就能自动帮我们检测是否抛出了我们指定的异常。

十、参数化测试

你可能遇到过这样的函数，它的参数有许多特殊值，或者说他的参数分为很多个区域。比如我们先前的例子，测试一下“计算一个数的平方”这个函数，暂且分三类：正数、0、负数。测试代码如下：

import static org.junit.Assert.assertEquals;import org.junit.Before;import org.junit.Test;public class CalculatorTest {private static Calculator calculator = new Calculator();@Beforepublic void clearCalculator() {calculator.clear();}@Testpublic void square1() {calculator.square(2);assertEquals(4, calculator.getResult());}@Testpublic void square2() {calculator.square(0);assertEquals(0, calculator.getResult());}@Testpublic void square3() {calculator.square(-3);assertEquals(9, calculator.getResult());}}

为了简化类似的测试，JUnit4提出了“参数化测试”的概念，只写一个测试函数，把这若干种情况作为参数传递进去，一次性的完成测试。代码如下：

import static org.junit.Assert.assertEquals;import org.junit.Test;import org.junit.runner.RunWith;import org.junit.runners.Parameterized;import org.junit.runners.Parameterized.Parameters;import java.util.Arrays;import java.util.Collection;@RunWith(Parameterized.class)public class SquareTest {private static Calculator calculator = new Calculator();private int param;private int result;@Parameterspublic static Collection data() {return Arrays.asList(new Object[][] { { 2, 4 }, { 0, 0 }, { -3, 9 }, });}// 构造函数，对变量进行初始化public SquareTest(int param, int result) {this.param = param;this.result = result;}@Testpublic void square() {calculator.square(param);assertEquals(result, calculator.getResult());}}

下面我们对上述代码进行分析：

首先，你要为这种测试专门生成一个新的类，而不能与其他测试共用同一个类，此例中我们定义了一个SquareTest类。然后，你要为这个类指定一个Runner，而不能使用默认的Runner了。@RunWith(Parameterized.class)这条语句就是为这个类指定了一个ParameterizedRunner。

第二步，定义一个待测试的类，并且定义两个变量，一个用于存放参数，一个用于存放期待的结果。接下来，定义测试数据的集合，也就是上述的data()方法，该方法可以任意命名，但是必须使用@Parameters标注进行修饰。需要注意其中的数据，是一个二维数组，数据两两一组，每组中的这两个数据，一个是参数，一个是你预期的结果。比如我们的第一组{2, 4}，2就是参数，4就是预期的结果。这两个数据的顺序无所谓，谁前谁后都可以。

第三步，定义一个构造函数，其功能就是对先前定义的两个参数进行初始化。在这里你可要注意一下参数的顺序了，要和上面的数据集合的顺序保持一致。如果前面的顺序是{参数，期待的结果}，那么你构造函数的顺序也要是“构造函数(参数， 期待的结果)”，反之亦然。

最后就是写一个简单的测试例了，和前面介绍过的写法完全一样。

十一、打包测试

在一个项目中，只写一个测试类是不可能的，我们会写出很多很多个测试类。可是这些测试类必须一个一个的执行，也是比较麻烦的事情。鉴于此，JUnit为我们提供了打包测试的功能，将所有需要运行的测试类集中起来，一次性的运行完毕，大大的方便了我们的测试工作。具体代码如下：

import org.junit.runner.RunWith;import org.junit.runners.Suite;@RunWith(Suite.class)@Suite.SuiteClasses({CalculatorTest.class, SquareTest.class})public class AllCalculatorTests{}

从上面可以看到，这个功能也需要使用一个特殊的Runner，因此我们需要向@RunWith标注传递一个参数Suite.class。同时，我们还需要另外一个标注@Suite.SuiteClasses，来表明这个类是一个打包测试类。我们把需要打包的类作为参数传递给该标注就可以了。有了这两个标注之后，就已经完整的表达了所有的含义，因此下面的类已经无关紧要，随便起一个类名，内容全部为空既可。